com.google.doclava
Class FederationTagger

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

public final class FederationTagger
extends Object

Cross-references documentation among different libraries. A FederationTagger is populated with a list of FederatedSite objects which are linked against when overlapping content is discovered.


Constructor Summary
FederationTagger()
           
 
Method Summary
 void addSiteUrl(String name, URL site)
          Adds a Doclava documentation site for federation.
 void addSiteXml(String name, String file)
           
 void tagAll(ClassInfo[] classDocs)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FederationTagger

public FederationTagger()
Method Detail

addSiteUrl

public void addSiteUrl(String name,
                       URL site)
Adds a Doclava documentation site for federation. Accepts the base URL of the remote API.


addSiteXml

public void addSiteXml(String name,
                       String file)

tagAll

public void tagAll(ClassInfo[] classDocs)


Copyright © 2010-2013 Google. All Rights Reserved.