com.google.doclava
Class DocInfo

java.lang.Object
  extended by com.google.doclava.DocInfo
Direct Known Subclasses:
ClassInfo, MemberInfo, PackageInfo

public abstract class DocInfo
extends Object


Constructor Summary
DocInfo(String rawCommentText, SourcePositionInfo sp)
           
 
Method Summary
 void addFederatedReference(FederatedSite source)
           
 Comment comment()
           
 Set<FederatedSite> getFederatedReferences()
           
 String getRawCommentText()
           
 String getSince()
           
 String htmlPage()
          The path to a web page representing this item.
abstract  boolean isDefinedLocally()
          Returns true if the class represented by this object is defined locally, and thus will be included in local documentation.
 boolean isDocOnly()
           
 boolean isHidden()
           
abstract  ContainerInfo parent()
           
 SourcePositionInfo position()
           
abstract  String relativePath()
          Returns the relative path that represents this item on a documentation source.
 void setFederatedReferences(com.google.clearsilver.jsilver.data.Data data, String base)
           
 void setSince(String since)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocInfo

public DocInfo(String rawCommentText,
               SourcePositionInfo sp)
Method Detail

isDefinedLocally

public abstract boolean isDefinedLocally()
Returns true if the class represented by this object is defined locally, and thus will be included in local documentation.


relativePath

public abstract String relativePath()
Returns the relative path that represents this item on a documentation source.


htmlPage

public final String htmlPage()
The path to a web page representing this item. The reference is a relative path if isDefinedLocally() returns true. Otherwise, it is a fully qualified link.


isHidden

public boolean isHidden()

isDocOnly

public boolean isDocOnly()

getRawCommentText

public String getRawCommentText()

comment

public Comment comment()

position

public SourcePositionInfo position()

parent

public abstract ContainerInfo parent()

setSince

public void setSince(String since)

getSince

public String getSince()

addFederatedReference

public final void addFederatedReference(FederatedSite source)

getFederatedReferences

public final Set<FederatedSite> getFederatedReferences()

setFederatedReferences

public final void setFederatedReferences(com.google.clearsilver.jsilver.data.Data data,
                                         String base)


Copyright © 2010-2013 Google. All Rights Reserved.