com.google.doclava
Class SinceTagger

java.lang.Object
  extended by com.google.doclava.SinceTagger

public class SinceTagger
extends Object

Applies version information to the DroidDoc class model from apicheck XML files. Sample usage:

   ClassInfo[] classInfos = ...

   SinceTagger sinceTagger = new SinceTagger()
   sinceTagger.addVersion("frameworks/base/api/1.xml", "product 1.0")
   sinceTagger.addVersion("frameworks/base/api/2.xml", "product 1.5")
   sinceTagger.tagAll(...);
 


Constructor Summary
SinceTagger()
           
 
Method Summary
 void addVersion(String file, String name)
          Specifies the apicheck XML file and the API version it holds.
 boolean hasVersions()
           
static String keyForName(String name)
           
 void tagAll(ClassInfo[] classDocs)
           
 void writeVersionNames(com.google.clearsilver.jsilver.data.Data data)
          Writes an index of the version names to data.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SinceTagger

public SinceTagger()
Method Detail

addVersion

public void addVersion(String file,
                       String name)
Specifies the apicheck XML file and the API version it holds. Calls to this method should be called in order from oldest version to newest.


tagAll

public void tagAll(ClassInfo[] classDocs)

hasVersions

public boolean hasVersions()

keyForName

public static String keyForName(String name)

writeVersionNames

public void writeVersionNames(com.google.clearsilver.jsilver.data.Data data)
Writes an index of the version names to data.



Copyright © 2010-2013 Google. All Rights Reserved.