com.google.doclava
Class PackageInfo
java.lang.Object
com.google.doclava.DocInfo
com.google.doclava.PackageInfo
- All Implemented Interfaces:
- ContainerInfo
public class PackageInfo
- extends DocInfo
- implements ContainerInfo
DEFAULT_PACKAGE
public static final String DEFAULT_PACKAGE
- See Also:
- Constant Field Values
comparator
public static final Comparator<PackageInfo> comparator
PackageInfo
public PackageInfo(com.sun.javadoc.PackageDoc pkg,
String name,
SourcePositionInfo position)
PackageInfo
public PackageInfo(String name)
PackageInfo
public PackageInfo(String name,
SourcePositionInfo position)
isDefinedLocally
public boolean isDefinedLocally()
- Description copied from class:
DocInfo
- Returns true if the class represented by this object is defined
locally, and thus will be included in local documentation.
- Specified by:
isDefinedLocally
in class DocInfo
relativePath
public String relativePath()
- Description copied from class:
DocInfo
- Returns the relative path that represents this item on a
documentation source.
- Specified by:
relativePath
in class DocInfo
fullDescriptionFile
public String fullDescriptionFile()
fullDescriptionHtmlPage
public String fullDescriptionHtmlPage()
parent
public ContainerInfo parent()
- Specified by:
parent
in class DocInfo
isHidden
public boolean isHidden()
- Overrides:
isHidden
in class DocInfo
checkLevel
public boolean checkLevel()
- Specified by:
checkLevel
in interface ContainerInfo
name
public String name()
qualifiedName
public String qualifiedName()
- Specified by:
qualifiedName
in interface ContainerInfo
inlineTags
public TagInfo[] inlineTags()
firstSentenceTags
public TagInfo[] firstSentenceTags()
filterHidden
public static ClassInfo[] filterHidden(ClassInfo[] classes)
makeLink
public void makeLink(com.google.clearsilver.jsilver.data.Data data,
String base)
makeClassLinkListHDF
public void makeClassLinkListHDF(com.google.clearsilver.jsilver.data.Data data,
String base)
getAnnotations
public ClassInfo[] getAnnotations()
- Returns the list of annotations defined in this package.
- Returns:
getInterfaces
public ClassInfo[] getInterfaces()
ordinaryClasses
public ClassInfo[] ordinaryClasses()
enums
public ClassInfo[] enums()
exceptions
public ClassInfo[] exceptions()
errors
public ClassInfo[] errors()
hashCode
public int hashCode()
- Overrides:
hashCode
in class Object
addClass
public void addClass(ClassInfo cl)
allClasses
public HashMap<String,ClassInfo> allClasses()
isConsistent
public boolean isConsistent(PackageInfo pInfo)
Copyright © 2010-2013 Google. All Rights Reserved.