org.dbdoclet.doclet.docbook 18. Juni 2011 Paket org.­dbdoclet.­doclet The package doclet contains the following classes: DocFileManager DocManager DocletContext DocletException DocletOptions ExecutableMemberInfo LinkManager ReferenceManager StatisticData TagManager The package doclet contains the following subpackages: docbook Klasse AbstractDoclet AbstractDoclet ClassesAbstractDoclet public class AbstractDoclet // Public Constructors public AbstractDoclet // Public Static Methods public static LanguageVersion languageVersion public static int optionLength Stringoption // Public Methods public DbdOptions getOptions public void println Stringstr public void println Stringstr Stringparam1 Direkt abgeleitete Klassen: org.­dbdoclet.­doclet.­dita.­DitaDocletorg.­dbdoclet.­doclet.­docbook.­DocBookDoclet Klasse ClassDiagramManager ClassDiagramManager ClassesClassDiagramManager public class ClassDiagramManager // Public Constructors public ClassDiagramManager DbdOptionsoptions // Public Static Methods public static ArrayList<Type> getInheritancePath ClassDocdoc // Public Methods public String createClassDiagram ClassDoccdoc Stringoutdir DocletException public String getImageFormat public int getImageHeight public int getImageWidth getImageFormat()<indexterm><primary>getImageFormat</primary></indexterm><indexterm><primary>Methods</primary><secondary>getImageFormat</secondary></indexterm> public String getImageFormat Liefert das Format des zuletzt erzeugten Klassendiagramms. Parameter return String getImageHeight()<indexterm><primary>getImageHeight</primary></indexterm><indexterm><primary>Methods</primary><secondary>getImageHeight</secondary></indexterm> public int getImageHeight Liefert die Höhe des zuletzt erzeugten Klassendiagramms. Parameter return int getImageWidth()<indexterm><primary>getImageWidth</primary></indexterm><indexterm><primary>Methods</primary><secondary>getImageWidth</secondary></indexterm> public int getImageWidth Liefert die Breite des zuletzt erzeugten Klassendiagramms. Parameter return int Klasse DbdOptions DbdOptions ClassesDbdOptions public class DbdOptions DocletOptions // Public Constructors public DbdOptions OptionListoptList ResourceBundleres public DbdOptions ResourceBundleres // Public Methods public boolean createPdf public boolean decomposeTables public boolean doCreateXrefLabel public String getAbstract public String getAuthorEmail public String getAuthorFirstname public String getAuthorSurname public String getBookType public int getClassDiagramFontSize public int getClassDiagramMaxWidth public int getCodeWidth public String getCopyrightHolder public String getCopyrightYear public String getCorporation public DocBookVersion getDocBookVersion public String getEmphasisBoldRole public HyphenationChar getHyphenationChar public XmlIdType getIdStyle public boolean getImageDataAddSize public String getImageDataFormat public boolean getImageDataUseAbsoluteFileref public String[] getIntroductionChapters public String getLogoPath public String getReleaseInfo public String getRootElement public String getStyleClass public String getTableFrame public boolean hasProlog public boolean ignoreAnnotationDocumented public void init public void setImageDataFormats Stringformats public boolean showDeprecatedList public boolean showException public boolean showInheritedFrom public boolean showMetaInfo public boolean showParameter public boolean showSeeAlso public boolean showSerialField public boolean showStatistics public boolean showSynopsis public boolean splitOutput public boolean useAppendix Klasse DeprecatedManager DeprecatedManager ClassesDeprecatedManager public class DeprecatedManager // Public Constructors public DeprecatedManager // Public Methods public void addDoc Docdoc public TreeMap<String, ArrayList<Doc>> getDeprecatedMap Klasse DocCreator DocCreator ClassesDocCreator public class DocCreator // Public Constructors public DocCreator // Public Static Methods public static RootDoc javadoc String[]sources Stringclasspath Klasse DocFileManager DocFileManager ClassesDocFileManager public class DocFileManager // Public Constructors public DocFileManager // Public Static Methods public static void copyDocFiles RootDocroot Stringdocfilespath Stringoutdir DocletOptionsoptions IOException public static TreeMap<String, TreeMap<String, ClassDoc>> createClassMap PackageDoc[]pkgDocs ClassDoc[]classDocs public static TreeMap<String, TreeMap<String, TreeMap<String, FieldDoc>>> createConstantFieldMap TreeMap<String, TreeMap<String, ClassDoc>>pkgMap Klasse DocletContext DocletContext ClassesDocletContext public class DocletContext // Public Constructors public DocletContext public DocletContext Stringcomment // Public Methods public ClassDoc getClassDoc public String getClassName public String getContextName public PackageDoc getPackageDoc public String getPackagePath public boolean isOverview public void isOverview booleanisOverview public void setClassDoc ClassDocclassDoc public void setComment Stringcomment public void setContextName Stringname public void setFieldDoc ClassDocclassDoc FieldDocfieldDoc public void setMethodDoc ClassDocclassDoc ExecutableMemberDocmethodDoc public void setPackageDoc PackageDocpackageDoc public String toString Direkt abgeleitete Klassen: org.­dbdoclet.­doclet.­docbook.­DbdContext Ausnahme DocletException DocletException ExceptionsDocletException public class DocletException Exception // Public Constructors public DocletException Exceptionoops public DocletException Stringmsg public DocletException Stringmsg Throwableoops // Public Methods public void printDetails Klasse DocletOptions DocletOptions ClassesDocletOptions The class Options provides access methods for the properties defined in the properties file. Properties: destination.file The destination file, *e.g. Reference.sgml. Any images are copied into the subdirectory figures of the same directory. Syntax public class DocletOptions // Public Constructors public DocletOptions OptionListoptList ResourceBundleres public DocletOptions ResourceBundleres // Public Methods public String getBookTitle public String getClasspath public String getDestinationDirectory public String getDestinationEncoding public String getDestinationFile public String getDocfilespath public String getDocumentationId public String getImagePath public String getInstallationPath IOException public Locale getLocale public String getLocaleLanguage public Option getOption Stringname public OptionList getOptionList public String getOverviewFile public String getOverviewTitle public String getSourceEncoding public String getSourcepath public boolean isDebug public boolean isLinkSourceEnabled public boolean isQuiet public boolean isVerbose public String list public void setOption Stringname Stringvalue public boolean showAuthor public boolean showConstants public boolean showDeprecated public boolean showFields public boolean showFullQualifiedNames public boolean showIndex public boolean showMethods public boolean showSince public boolean showTree public boolean showVersion public void write PrintWriterwriter Direkt abgeleitete Klassen: org.­dbdoclet.­doclet.­DbdOptions Autor Michael Fuchs DocletOptions(OptionList, ResourceBundle)<indexterm><primary>DocletOptions</primary></indexterm><indexterm><primary>Methods</primary><secondary>DocletOptions</secondary></indexterm> public DocletOptions OptionListoptList ResourceBundleres Creates a new DocletOptions instance. Parameter optList an OptionList value res a ResourceBundle value DocletOptions(ResourceBundle)<indexterm><primary>DocletOptions</primary></indexterm><indexterm><primary>Methods</primary><secondary>DocletOptions</secondary></indexterm> public DocletOptions ResourceBundleres Creates a new DocletOptions instance. Parameter res a ResourceBundle value Klasse DocletServices DocletServices ClassesDocletServices public class DocletServices // Public Constructors public DocletServices // Public Static Methods public static String getTypeNameWithDimension Typetype booleanshowFullQualifiedName public static void printType Typetype public static void processBounds StringBuilderbuffer Type[]bounds Stringkind booleanshowFullQualifiedName intlevel public static String typeToString Typetype booleanshowFullQualifiedName public static String typeToString Typetype booleanshowFullQualifiedName intlevel Klasse ExecutableMemberInfo ExecutableMemberInfo ClassesExecutableMemberInfo public class ExecutableMemberInfo // Public Constructors public ExecutableMemberInfo ExecutableMemberDocmethod // Public Methods public ExecutableMemberDoc getCommentDoc public ExecutableMemberDoc getExecutableMember public MethodDoc getImplemented public MethodDoc getOverridden public void setExecutableMember ExecutableMemberDocmethod public void setImplemented MethodDocimplemented public void setOverridden MethodDocoverridden Klasse ReferenceManager ReferenceManager ClassesReferenceManager public class ReferenceManager // Public Constructors public ReferenceManager // Public Methods public String createFieldKey FieldDocdoc public String createJavaId Stringid public String createMethodKey ExecutableMemberDocdoc public String createNumberedId Stringid public String createReferenceLabel SeeTagtag DocletException public String findReference ExecutableMemberDocmethodDoc public String findReference FieldDocfieldDoc public String findReference ProgramElementDocelemDoc public String findReference SeeTagtag public String getId Stringkey public void init StringdocumentationId TreeMap<String, TreeMap<String, ClassDoc>>pkgMap XmlIdTypetype Klasse StatisticData StatisticData ClassesStatisticData public class StatisticData // Public Static Methods public static void createInstance TreeMap<String, TreeMap<String, ClassDoc>>pkgMap DbdOptionsoptions ResourceBundleres IOException public static StatisticData getInstance // Public Methods public ClassesPerPackage getClassesPerPackageDiagram IOException public DirectKnownSubclasses getDirectKnownSubclassesDiagram IOException public ArrayList<Type> getSubclasses StringqualifiedName public TotalsDiagram getTotalsDiagram IOException Klasse TagManager TagManager ClassesTagManager The class TagManager is reponsible for handling the javadoc tags. It also handles tags, which are defined on the command line with the -tag option. Syntax public class TagManager // Public Constructors public TagManager DbdContextcontext // Public Methods public void createTagMap TreeMap<String, TreeMap<String, ClassDoc>>pkgMap DocletOptionsoptions public String getSeeNameClass ProgramElementDocdoc Stringname public String getSeeNameMember Stringname public String getSeeNamePackage ProgramElementDocdoc Stringname public String getTagLabel Stringkind ResourceBundleres public String handleInlineTag Tagtag DocletException public boolean isMetaTag Stringkind public boolean showTag DbdOptionsoptions Stringkind Autor Michael Fuchs createTagMap(TreeMap<String, TreeMap<String, ClassDoc>>, DocletOptions)<indexterm><primary>createTagMap</primary></indexterm><indexterm><primary>Methods</primary><secondary>createTagMap</secondary></indexterm> public void createTagMap TreeMap<String, TreeMap<String, ClassDoc>>pkgMap DocletOptionsoptions The method createTagMap creates a tag map for tags, which are defined on the command line via the -tag option. Parameter options a DocletOptions value handleInlineTag(Tag)<indexterm><primary>handleInlineTag</primary></indexterm><indexterm><primary>Methods</primary><secondary>handleInlineTag</secondary></indexterm> public String handleInlineTag Tagtag DocletException The method handleTag handles a single tag. Parameter tag a Tag value return a String value Klasse XmlIdType XmlIdType ClassesXmlIdType public final class XmlIdType Enum<XmlIdType> // Public Static Fields public static final XmlIdType JAVA public static final XmlIdType NUMBERED // Public Static Methods public static XmlIdType valueOf Stringname public static XmlIdType[] values Paket org.­dbdoclet.­doclet.­dita Klasse DitaDoclet DitaDoclet ClassesDitaDoclet The class DocBookDoclet implements a doclet, which creates a 1 * DocBook XML file from the javadoc information. It also creates an XML document with the information about the classes, fields and methods found. This document is used to create an XMI file for use with an UML modelling tool. Syntax public final class DitaDoclet AbstractDoclet // Public Constructors public DitaDoclet // Public Static Methods public static boolean start RootDocrootDoc Autor Michael Fuchs start(RootDoc)<indexterm><primary>start</primary></indexterm><indexterm><primary>Methods</primary><secondary>start</secondary></indexterm> public static boolean start RootDocrootDoc The method start is called from within the Doclet API. It is the main entry point of the doclet. This method catches all Exceptions and prints a stacktrace if necessary. Klasse DitaManager DitaManager ClassesDitaManager public class DitaManager MediaManager // Public Constructors public DitaManager DbdOptionsoptions ResourceBundleres DocletException Paket org.­dbdoclet.­doclet.­docbook The package contains the following classes: DocBookDoclet DocBookProperties InvalidPropertyException Klasse ArticleManager ArticleManager ClassesArticleManager public class ArticleManager MediaManager // Public Constructors public ArticleManager DbdOptionsoptions ResourceBundleres DocletException Klasse BookManager BookManager ClassesBookManager public class BookManager MediaManager // Public Constructors public BookManager DbdOptionsoptions ResourceBundleres DocletException Klasse DbdContext DbdContext ClassesDbdContext public class DbdContext DocletContext // Public Constructors public DbdContext // Public Methods public DeprecatedManager getDeprecatedManager public DbdOptions getOptions public ReferenceManager getReferenceManager public ResourceBundle getResourceBundle public DocBookTagFactory getTagFactory public TagManager getTagManager public void setDeprecatedManager DeprecatedManagerdeprecatedManager public void setOptions DbdOptionsoptions public void setReferenceManager ReferenceManagerreferenceManager public void setResourceBundle ResourceBundleres public void setTagFactory DocBookTagFactorydbfactory public void setTagManager TagManagertagManager Klasse DbdServices DbdServices ClassesDbdServices public class DbdServices // Public Constructors public DbdServices // Public Static Methods public static void addNamespace DocBookElementelem public static void appendDoctype DocBookDocumentdoc StringtagName public static ArrayList<Doc> createDocList TreeMap<String, TreeMap<String, ClassDoc>>pkgMap public static final Tag findComment Stringtag Tag[]tags public static final Tag[] findComments Stringtag Tag[]tags public static final Tag findReturnComment Tag[]tags Klasse DbdTransformer DbdTransformer ClassesDbdTransformer The class DbdTransformer transforms the information created by the javadoc tool to DocBook trees. Syntax public class DbdTransformer // Public Constructors public DbdTransformer // Public Static Methods public static NodeImpl transform Docdoc DocBookElementparent DbdContextcontext DocletException public static NodeImpl transform Tagtag DocBookElementparent DbdContextcontext DocletException public static NodeImpl transform Tag[]tags DocBookElementparent DbdContextcontext DocletException public static NodeImpl transform Stringcomment DocBookElementparent DbdContextcontext DocletException public static NodeImpl transform Stringcomment DocBookElementparent DbdContextcontext HtmlElementskipTo DocletException Autor Michael Fuchs transform(Doc, DocBookElement, DbdContext)<indexterm><primary>transform</primary></indexterm><indexterm><primary>Methods</primary><secondary>transform</secondary></indexterm> public static NodeImpl transform Docdoc DocBookElementparent DbdContextcontext DocletException The method transform transforms the documentation of java language constructs (class, package, method, ...), which are represented by a Doc object. Parameter doc a Doc value parent a DocBookElement value context a DbdContext value return a Element value Exceptions DocletException if an error occurs transform(String, DocBookElement, DbdContext)<indexterm><primary>transform</primary></indexterm><indexterm><primary>Methods</primary><secondary>transform</secondary></indexterm> public static NodeImpl transform Stringcomment DocBookElementparent DbdContextcontext DocletException The method transform transforms the content of a String buffer into a DocBook tree. Parameter comment a String value parent a DocBookElement value context a DbdContext value return a Element value Exceptions DocletException if an error occurs transform(String, DocBookElement, DbdContext, HtmlElement)<indexterm><primary>transform</primary></indexterm><indexterm><primary>Methods</primary><secondary>transform</secondary></indexterm> public static NodeImpl transform Stringcomment DocBookElementparent DbdContextcontext HtmlElementskipTo DocletException The method transform transforms the content of a String buffer into a DocBook tree. Parameter comment a String value parent a DocBookElement value context a String value skipTo skip all lines until the the tag skipTo is found. return a Element value Exceptions DocletException if an error occurs transform(Tag[], DocBookElement, DbdContext)<indexterm><primary>transform</primary></indexterm><indexterm><primary>Methods</primary><secondary>transform</secondary></indexterm> public static NodeImpl transform Tag[]tags DocBookElementparent DbdContextcontext DocletException The method transform transforms the documentation of an array of javadoc tag. Parameter tags a Tag[] value parent a DocBookElement value context a DbdContext value return a Element value Exceptions DocletException if an error occurs transform(Tag, DocBookElement, DbdContext)<indexterm><primary>transform</primary></indexterm><indexterm><primary>Methods</primary><secondary>transform</secondary></indexterm> public static NodeImpl transform Tagtag DocBookElementparent DbdContextcontext DocletException The method transform transforms the documentation of a javadoc tag. Parameter tag a Tag value parent a DocBookElement value context a DocBookContext value return a Element value Exceptions DocletException if an error occurs Klasse DocBookDoclet DocBookDoclet ClassesDocBookDoclet The class DocBookDoclet implements a doclet, which creates a 1 * DocBook XML file from the javadoc information. It also creates an XML document with the information about the classes, fields and methods found. This document is used to create an XMI file for use with an UML modelling tool. Syntax public final class DocBookDoclet AbstractDoclet // Public Constructors public DocBookDoclet // Public Static Methods public static boolean start RootDocrootDoc Autor Michael Fuchs start(RootDoc)<indexterm><primary>start</primary></indexterm><indexterm><primary>Methods</primary><secondary>start</secondary></indexterm> public static boolean start RootDocrootDoc The method start is called from within the Doclet API. It is the main entry point of the doclet. This method catches all Exceptions and prints a stacktrace if necessary. Klasse DodoManager DodoManager ClassesDodoManager public class DodoManager MediaManager // Public Constructors public DodoManager DbdOptionsoptions ResourceBundleres DocletException // Public Methods public void process RootDocrootDoc DocletException Klasse ExceptionHandler ExceptionHandler ClassesExceptionHandler public class ExceptionHandler // Public Constructors public ExceptionHandler // Public Static Methods public static void handleException DbdContextcontext Throwableoops Klasse LinkSourceManager LinkSourceManager ClassesLinkSourceManager public class LinkSourceManager // Public Constructors public LinkSourceManager RootDocrootDoc DbdOptionsoptions // Public Static Methods public static File getDestinationDirectory DbdOptionsoptions public static File getDocBookFile ClassDoccdoc DbdOptionsoptions public static File getRelativeDocBookFile ClassDoccdoc public static File getRelativeTargetFile ClassDoccdoc // Public Methods public void createDocBook IOException Klasse MediaManager MediaManager ClassesMediaManager public abstract class MediaManager // Public Constructors public MediaManager DbdOptionsoptions ResourceBundleres DocletException // Public Methods public Style getStyle public void writeContents RootDocrootDoc DocletException Direkt abgeleitete Klassen: org.­dbdoclet.­doclet.­dita.­DitaManagerorg.­dbdoclet.­doclet.­docbook.­ArticleManagerorg.­dbdoclet.­doclet.­docbook.­BookManagerorg.­dbdoclet.­doclet.­docbook.­DodoManagerorg.­dbdoclet.­doclet.­docbook.­RefentryManager Klasse RefentryManager RefentryManager ClassesRefentryManager public class RefentryManager MediaManager // Public Constructors public RefentryManager DbdOptionsoptions ResourceBundleres DocletException Klasse StrictSynopsis StrictSynopsis ClassesStrictSynopsis public class StrictSynopsis Synopsis // Public Constructors public StrictSynopsis ClassDocdoc DocBookElementparent DbdContextcontext DocBookTagFactorydbfactory // Public Methods public void addConstructorSynopsis ConstructorDocdoc DocBookElementparent public void addFieldSynopsis FieldDocdoc DocBookElementparent public void addMethodSynopsis MethodDocdoc DocBookElementparent public boolean process DocletException Schnittstelle Style Style InterfacesStyle public interface Style // Public Methods public boolean addClassSynopsis ClassDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addFieldSynopsis FieldDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addInheritancePath ClassDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addMemberSynopsis ExecutableMemberDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addMetaInfo Docdoc DocBookElementparent DbdContextcontext DocletException public boolean addMethodSpecifiedBy MethodDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addParamInfo ExecutableMemberDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addSerialFieldsInfo FieldDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addThrowsInfo ExecutableMemberDocdoc DocBookElementparent DbdContextcontext DocletException public void finish DbdContextcontext DocletException public void init DbdContextcontext DocletException Klasse StyleBase StyleBase ClassesStyleBase public class StyleBase // Public Constructors public StyleBase DocBookTagFactorydbfactory // Public Static Methods public static final LinkedHashMap<String, ArrayList<Tag>> createTagMap Docdoc public static final ArrayList<MemberDoc> getPackageMembers MemberDoc[]members public static final ArrayList<MemberDoc> getPrivateMembers MemberDoc[]members public static final ArrayList<MemberDoc> getProtectedMembers MemberDoc[]members public static final ArrayList<MemberDoc> getPublicMembers MemberDoc[]members Direkt abgeleitete Klassen: org.­dbdoclet.­doclet.­docbook.­StyleCoded Klasse StyleCoded StyleCoded ClassesStyleCoded The class StyleCoded is the super class for the coded styles. Syntax public abstract class StyleCoded StyleBase Style // Public Constructors public StyleCoded DocBookTagFactorydbfactory // Public Methods public boolean addClassSynopsis ClassDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addFieldSynopsis FieldDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addInheritancePath ClassDocclassDoc DocBookElementparent DbdContextcontext DocletException public boolean addMemberSynopsis ExecutableMemberDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addMethodSpecifiedBy MethodDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addParamInfo ExecutableMemberDocmemberDoc DocBookElementparent DbdContextcontext DocletException public boolean addSerialFieldsInfo FieldDocfieldDoc DocBookElementparent DbdContextcontext DocletException public boolean addThrowsInfo ExecutableMemberDocmemberDoc DocBookElementparent DbdContextcontext DocletException public void finish DbdContextcontext DocletException public void init DbdContextcontext DocletException Direkt abgeleitete Klassen: org.­dbdoclet.­doclet.­docbook.­StyleTableorg.­dbdoclet.­doclet.­docbook.­StyleVariableList Autor Michael Fuchs Klasse StyleTable StyleTable ClassesStyleTable The class StyleNoTables provides a layout without any tables. There could be tables in the comments of cours!e, but the style will not generate any tables by itself. Syntax public class StyleTable StyleCoded Style // Public Constructors public StyleTable DocBookTagFactorydbfactory // Public Methods public boolean addClassSynopsis ClassDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addMetaInfo Docdoc DocBookElementparent DbdContextcontext DocletException public boolean addParamInfo ExecutableMemberDocmemberDoc DocBookElementparent DbdContextcontext DocletException public boolean addSerialFieldsInfo FieldDocfieldDoc DocBookElementparent DbdContextcontext DocletException public boolean addThrowsInfo ExecutableMemberDocmemberDoc DocBookElementparent DbdContextcontext DocletException Autor Michael Fuchs addParamInfo(ExecutableMemberDoc, DocBookElement, DbdContext)<indexterm><primary>addParamInfo</primary></indexterm><indexterm><primary>Methods</primary><secondary>addParamInfo</secondary></indexterm> public boolean addParamInfo ExecutableMemberDocmemberDoc DocBookElementparent DbdContextcontext DocletException Spezifiziert durch: Methode addParamInfo in der Schnittstelle Style The method addParamInfo adds a list containing all parameter tags with their comments. Parameter memberDoc an ExecutableMemberDoc value parent a DocBookElement value Klasse StyleVariableList StyleVariableList ClassesStyleVariableList The class StyleNoTables provides a layout without any tables. There could be tables in the comments of cours!e, but the style will not generate any tables by itself. Syntax public class StyleVariableList StyleCoded Style // Public Constructors public StyleVariableList DocBookTagFactorydbfactory // Public Methods public boolean addClassSynopsis ClassDocdoc DocBookElementparent DbdContextcontext DocletException public boolean addMetaInfo Docdoc DocBookElementparent DbdContextcontext DocletException public boolean addParamInfo ExecutableMemberDocmemberDoc DocBookElementparent DbdContextcontext DocletException public boolean addSerialFieldsInfo FieldDocfieldDoc DocBookElementparent DbdContextcontext DocletException public boolean addThrowsInfo ExecutableMemberDocmemberDoc DocBookElementparent DbdContextcontext DocletException Autor Michael Fuchs addParamInfo(ExecutableMemberDoc, DocBookElement, DbdContext)<indexterm><primary>addParamInfo</primary></indexterm><indexterm><primary>Methods</primary><secondary>addParamInfo</secondary></indexterm> public boolean addParamInfo ExecutableMemberDocmemberDoc DocBookElementparent DbdContextcontext DocletException Spezifiziert durch: Methode addParamInfo in der Schnittstelle Style The method addParamInfo adds a list containing all parameter tags with their comments. Parameter memberDoc an ExecutableMemberDoc value parent a DocBookElement value Klasse Synopsis Synopsis ClassesSynopsis public class Synopsis // Public Constructors public Synopsis DocBookTagFactorydbfactory DbdContextcontext // Public Methods public final void createMemberModifier MemberDocdoc DocBookElementparent public final void createType Typetype DocBookElementparent booleanshowFullQualifiedName public final void createVisibility ProgramElementDocdoc DocBookElementparent Direkt abgeleitete Klassen: org.­dbdoclet.­doclet.­docbook.­StrictSynopsis Paket org.­dbdoclet.­doclet.­statistic Klasse ClassesPerPackage ClassesPerPackage ClassesClassesPerPackage public class ClassesPerPackage Diagram // Public Constructors public ClassesPerPackage DbdOptionsoptions ResourceBundleres IOException // Public Methods public void createDiagram IOException Klasse Diagram Diagram ClassesDiagram public abstract class Diagram // Public Constructors public Diagram DbdOptionsoptions ResourceBundleres IOException // Public Methods public void add LabeledIntegeritem public abstract void createDiagram IOException public InformalTable createTable Stringtitle List<LabeledInteger>itemList DocBookTagFactorydbfactory public String getImageHeight public String getImageHref public String getImagePath public String getImageWidth public String getImagesRef public ArrayList<LabeledInteger> getItemList public boolean isEmpty public void setImageHref StringimageHref public void setImagePath StringimagePath public void setImageRef StringimageRef public void setItemList ArrayList<LabeledInteger>itemList Direkt abgeleitete Klassen: org.­dbdoclet.­doclet.­statistic.­ClassesPerPackageorg.­dbdoclet.­doclet.­statistic.­DirectKnownSubclassesorg.­dbdoclet.­doclet.­statistic.­TotalsDiagram Klasse DirectKnownSubclasses DirectKnownSubclasses ClassesDirectKnownSubclasses public class DirectKnownSubclasses Diagram // Public Constructors public DirectKnownSubclasses DbdOptionsoptions ResourceBundleres IOException // Public Methods public void createDiagram IOException Klasse LabeledInteger LabeledInteger ClassesLabeledInteger public class LabeledInteger // Public Constructors public LabeledInteger Integerinteger Stringlabel public LabeledInteger Integerinteger Stringcategory Stringlabel // Public Methods public String getCategory public Integer getInteger public String getLabel public void setCategory Stringcategory public void setInteger Integerinteger public void setLabel Stringlabel Klasse TotalsDiagram TotalsDiagram ClassesTotalsDiagram public class TotalsDiagram Diagram // Public Constructors public TotalsDiagram DbdOptionsoptions ResourceBundleres IOException // Public Methods public void createDiagram IOException public ArrayList<LabeledInteger> getItemList public int getTotalClasses public int getTotalFields public int getTotalMethods public int getTotalPackagePrivateClasses public int getTotalPackagePrivateFields public int getTotalPackagePrivateMethods public int getTotalPackages public int getTotalPrivateFields public int getTotalPrivateMethods public int getTotalProtectedFields public int getTotalProtectedMethods public int getTotalPublicClasses public int getTotalPublicFields public int getTotalPublicMethods public void setTotalClasses inttotalClasses public void setTotalFields inttotalFields public void setTotalMethods inttotalMethods public void setTotalPackagePrivateClasses inttotalPackagePrivateClasses public void setTotalPackagePrivateFields inttotalPackagePrivateFields public void setTotalPackagePrivateMethods inttotalPackagePrivateMethods public void setTotalPackages inttotalPackages public void setTotalPrivateFields inttotalPrivateFields public void setTotalPrivateMethods inttotalPrivateMethods public void setTotalProtectedFields inttotalProtectedFields public void setTotalProtectedMethods inttotalProtectedMethods public void setTotalPublicClasses inttotalPublicClasses public void setTotalPublicFields inttotalPublicFields public void setTotalPublicMethods inttotalPublicMethods Paket org.­dbdoclet.­util Klasse MethodServices MethodServices ClassesMethodServices public class MethodServices // Public Constructors public MethodServices // Public Static Methods public static MethodDoc implementedMethod MethodDocmethodDoc Klasse PackageServices PackageServices ClassesPackageServices The class PackageServices provides some static methods for dealing with packages. Syntax public class PackageServices // Public Constructors public PackageServices // Public Static Methods public static ArrayList<String> findDocFilesDirectories PackageDocpkg Stringsourcepath public static String findPackageDirectory PackageDocpkg Stringsourcepath Autor Michael Fuchs findPackageDirectory(PackageDoc, String)<indexterm><primary>findPackageDirectory</primary></indexterm><indexterm><primary>Methods</primary><secondary>findPackageDirectory</secondary></indexterm> public static String findPackageDirectory PackageDocpkg Stringsourcepath The findPackageDirectory method returns the absolute path of a package. Therefore all entries in the sourcepath are scanned. If the package can not be found null is returned. Parameter pkg a PackageDoc value sourcepath a String value return a String value Klasse ReleaseServices ReleaseServices ClassesReleaseServices public class ReleaseServices // Public Constructors public ReleaseServices // Public Static Methods public static String getBuild public static String getTimestamp public static String getVersion Klasse RuntimeClassLoader RuntimeClassLoader ClassesRuntimeClassLoader public class RuntimeClassLoader ClassLoader // Public Constructors public RuntimeClassLoader // Public Methods public InputStream getResourceAsStream Stringname public Class<?> loadClass StringclassName ClassNotFoundException public synchronized Class<?> loadClass StringclassName booleanresolveIt ClassNotFoundException Statistiken
Gesamtsummen Gesamtsummen Gesamtsummen Pakete 5 Gesamtsummen Klassen 44 Gesamtsummen Attribute 138 Gesamtsummen Methoden 375 Public Klassen 44 Public Attribute 0 Public Methoden 284 Protected Attribute 20 Protected Methoden 39 Package Klassen 0 Package Attribute 1 Package Methoden 0 Private Attribute 117 Private Methoden 52
Klassen pro Package Klassen pro Package org.dbdoclet.doclet.docbook 18 org.dbdoclet.doclet 15 org.dbdoclet.doclet.statistic 5 org.dbdoclet.util 4 org.dbdoclet.doclet.dita 2
Die besten Zehn - Direkt abgeleitete Klassen Direkt abgeleitete Klassen org.dbdoclet.doclet.docbook.MediaManager 5 org.dbdoclet.doclet.statistic.Diagram 3 org.dbdoclet.doclet.AbstractDoclet 2 org.dbdoclet.doclet.docbook.StyleCoded 2 org.dbdoclet.doclet.DocletContext 1 org.dbdoclet.doclet.DocletOptions 1 org.dbdoclet.doclet.docbook.StyleBase 1 org.dbdoclet.doclet.docbook.Synopsis 1