Class HtmlDocletWriter
- Direct Known Subclasses:
AbstractIndexWriter
,AbstractPackageIndexWriter
,AbstractTreeWriter
,AllClassesFrameWriter
,ConstantsSummaryWriterImpl
,FrameOutputWriter
,HelpWriter
,PackageFrameWriter
,PackageWriterImpl
,SubWriterHolderWriter
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionDeprecated.final ConfigurationImpl
Deprecated.The global configuration information for this run.private static final Pattern
Deprecated.final DocPath
Deprecated.Name of the file getting generated.(package private) HtmlTree
Deprecated.private boolean
Deprecated.To check whether the repeated annotations is documented or not.private boolean
Deprecated.To check whether the container annotations is documented or not.final DocPath
Deprecated.Platform-independent path from the current or the destination directory to the file getting generated.final DocPath
Deprecated.Relative path from the file getting generated to the destination directory.protected boolean
Deprecated.To check whether annotation field heading is printed or not.protected boolean
Deprecated.To check whether annotation heading is printed or not.protected final Utils
Deprecated.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
CONTENT_TYPE
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
allclassesLabel, allpackagesLabel, annotationTypeDetailsLabel, classLabel, constructorDetailsLabel, defaultPackageLabel, deprecatedLabel, deprecatedPhrase, descfrmClassLabel, descfrmInterfaceLabel, descriptionLabel, detailLabel, enumConstantsDetailsLabel, fieldDetailsLabel, framesLabel, helpLabel, indexLabel, memberDetailsListPrinted, methodDetailsLabel, modifierTypeHeader, nextclassLabel, nextLabel, nextpackageLabel, noframesLabel, overridesLabel, overviewLabel, packageLabel, packagesLabel, packageTableHeader, prevclassLabel, prevLabel, prevpackageLabel, propertyDetailsLabel, script, seeLabel, specifiedByLabel, summaryLabel, treeLabel, useLabel, useTableSummary, winTitle
-
Constructor Summary
ConstructorsConstructorDescriptionHtmlDocletWriter
(ConfigurationImpl configuration, DocPath path) Deprecated.Constructor to construct the HtmlStandardWriter object. -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
addAnnotationInfo
(int indent, Doc doc, AnnotationDesc[] descList, boolean lineBreak, Content htmltree) Deprecated.Adds the annotation types for the given doc.boolean
addAnnotationInfo
(int indent, Doc doc, Parameter param, Content tree) Deprecated.Add the annotatation types for the given doc and parameter.private void
addAnnotationInfo
(Doc doc, AnnotationDesc[] descList, Content htmltree) Deprecated.Adds the annotatation types for the given doc.void
addAnnotationInfo
(PackageDoc packageDoc, Content htmltree) Deprecated.Adds the annotatation types for the given packageDoc.void
addAnnotationInfo
(ProgramElementDoc doc, Content htmltree) Deprecated.Adds the annotatation types for the given doc.private void
addAnnotations
(AnnotationTypeDoc annotationDoc, LinkInfoImpl linkInfo, ContentBuilder annotation, AnnotationDesc.ElementValuePair[] pairs, int indent, boolean linkBreak) Deprecated.Add annotation to the annotation string.void
Deprecated.Adds the user specified bottom.private void
addCommentTags
(Doc doc, Tag[] tags, boolean depr, boolean first, Content htmltree) Deprecated.Adds the comment tags.private void
addCommentTags
(Doc doc, Tag holderTag, Tag[] tags, boolean depr, boolean first, Content htmltree) Deprecated.Adds the comment tags.void
addInlineComment
(Doc doc, Tag tag, Content htmltree) Deprecated.Add the inline comment.void
addInlineComment
(Doc doc, Content htmltree) Deprecated.Adds the inline comment.void
addInlineDeprecatedComment
(Doc doc, Tag tag, Content htmltree) Deprecated.Add the inline deprecated comment.private void
addJQueryFile
(Content head, DocPath filePath) Deprecated.Add a link to the JQuery javascript file.private void
addMethodInfo
(MethodDoc method, Content dl) Deprecated.Add method information.protected void
addNavLinks
(boolean header, Content htmlTree) Deprecated.Adds the navigation bar for the Html page at the top and and the bottom.protected void
addPackageDeprecatedAPI
(List<Doc> deprPkgs, String headingKey, String tableSummary, String[] tableHeader, Content contentTree) Deprecated.Add package deprecation information to the documentation treevoid
addPreQualifiedClassLink
(LinkInfoImpl.Kind context, ClassDoc cd, boolean isStrong, Content contentTree) Deprecated.Add the class link with the package portion of the label in plain text.void
addPreQualifiedClassLink
(LinkInfoImpl.Kind context, ClassDoc cd, Content contentTree) Deprecated.Add the class link.void
addPreQualifiedStrongClassLink
(LinkInfoImpl.Kind context, ClassDoc cd, Content contentTree) Deprecated.Add the class link, with only class name as the strong link and prefixing plain package name.void
addReceiverAnnotationInfo
(ExecutableMemberDoc method, AnnotationDesc[] descList, Content htmltree) Deprecated.Add the annotation types of the executable receiver.void
addScriptProperties
(Content head) Deprecated.Add a link to the JavaScript file.void
addSrcLink
(ProgramElementDoc doc, Content label, Content htmltree) Deprecated.Add the link to the content tree.void
Deprecated.Add a link to the stylesheet file.void
addSummaryComment
(Doc doc, Tag[] firstSentenceTags, Content htmltree) Deprecated.Adds the summary content.void
addSummaryComment
(Doc doc, Content htmltree) Deprecated.Adds the summary content.void
addSummaryDeprecatedComment
(Doc doc, Tag tag, Content htmltree) Deprecated.protected void
addSummaryDetailLinks
(Content navDiv) Deprecated.Do nothing.protected void
addTagsInfo
(Doc doc, Content htmltree) Deprecated.Adds the tags information.void
Deprecated.Adds the user specified top.private Content
annotationValueToContent
(AnnotationValue annotationValue) Deprecated.(package private) String
Deprecated.commentTagsToContent
(Tag holderTag, Doc doc, Tag[] tags, boolean isFirstSentence) Deprecated.Converts inline tags and text to text strings, expanding the inline tags along the way.Deprecated.Return the configuation for this doclet.Deprecated.Get the script to show or hide the All classes link.Deprecated.getAnchor
(ExecutableMemberDoc emd, boolean isProperty) Deprecated.getAnnotations
(int indent, AnnotationDesc[] descList, boolean linkBreak) Deprecated.Return the string representations of the annotation types for the given doc.getAnnotations
(int indent, AnnotationDesc[] descList, boolean linkBreak, boolean isJava5DeclarationLocation) Deprecated.Return the string representations of the annotation types for the given doc.getCrossClassLink
(String qualifiedClassName, String refMemName, Content label, boolean strong, String style, boolean code) Deprecated.Return a class cross link to external class documentation.getCrossPackageLink
(String pkgName) Deprecated.getDocLink
(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, Content label) Deprecated.Return the link for the given member.getDocLink
(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, Content label, boolean strong) Deprecated.getDocLink
(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, Content label, boolean strong, boolean isProperty) Deprecated.getDocLink
(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, String label, boolean strong) Deprecated.Return the link for the given member.getDocLink
(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, String label, boolean strong, boolean isProperty) Deprecated.Return the link for the given member.getDocLink
(LinkInfoImpl.Kind context, MemberDoc doc, String label) Deprecated.Get the link for the given member.getDocLink
(LinkInfoImpl.Kind context, MemberDoc doc, String label, boolean strong) Deprecated.Return the link for the given member.getLink
(LinkInfoImpl linkInfo) Deprecated.Return the link to the given class.getMarkerAnchor
(SectionName sectionName) Deprecated.Get the marker anchor which will be added to the documentation tree.getMarkerAnchor
(SectionName sectionName, String anchorName) Deprecated.Get the marker anchor which will be added to the documentation tree.getMarkerAnchor
(String anchorName) Deprecated.Get the marker anchor which will be added to the documentation tree.getMarkerAnchor
(String anchorName, Content anchorContent) Deprecated.Get the marker anchor which will be added to the documentation tree.protected Content
getNavHideLists
(DocPath link) Deprecated.Get "NO FRAMES" link, to switch to the non-frame version of the output.protected Content
Deprecated.Get the word "Class", to indicate that class link is not available.protected Content
Deprecated.Get link for generated index.protected Content
Deprecated.Get the word "Use", to indicate that link is not available.protected Content
Deprecated.Get link to the "overview-summary.html" page.protected Content
Deprecated.Get "Deprecated" API link in the navigation bar.protected Content
Deprecated.Get help file link.protected Content
Deprecated.Get link for generated class index.protected Content
getNavLinkMainTree
(String label) Deprecated.Get the overview tree link for the main tree.protected Content
Deprecated.Get the word "NEXT" to indicate that no link is available.getNavLinkNext
(DocPath next) Deprecated.Get link for next file.protected Content
Deprecated.Get the word "Package" , to indicate that link is not available here.protected Content
Deprecated.Get link to the "package-summary.html" page for the package passed.protected Content
Deprecated.Get the word "PREV" to indicate that no link is available.getNavLinkPrevious
(DocPath prev) Deprecated.Get link for previous file.protected Content
Deprecated.Get "Tree" link in the navigation bar.protected Content
Deprecated.Get "FRAMES" link, to switch to the frame version of the output.protected Content
getNavShowLists
(DocPath link) Deprecated.Get "FRAMES" link, to switch to the frame version of the output.getPackageAnchorName
(PackageDoc packageDoc) Deprecated.Given a package, return the name to be used in HTML anchor tag.getPackageLabel
(String packageName) Deprecated.Returns a package name label.getPackageLink
(PackageDoc pkg, Content label) Deprecated.Return the link to the given package.getPackageLink
(PackageDoc pkg, String label) Deprecated.Return the link to the given package.getPackageName
(PackageDoc packageDoc) Deprecated.Returns a packagename content.getPreQualifiedClassLink
(LinkInfoImpl.Kind context, ClassDoc cd, boolean isStrong) Deprecated.Retrieve the class link with the package portion of the label in plain text.getQualifiedClassLink
(LinkInfoImpl.Kind context, ClassDoc cd) Deprecated.Get the class link.getSummaryTableHeader
(String[] header, String scope) Deprecated.Get summary table header.getTableCaption
(Content title) Deprecated.Get table caption.getTagletWriterInstance
(boolean isFirstSentence) Deprecated.Returns a TagletWriter that knows how to write HTML.getTargetPackageLink
(PackageDoc pd, String target, Content label) Deprecated.Get Package link, with target frame.getTypeParameterLinks
(LinkInfoImpl linkInfo) Deprecated.Return the type parameters for the given class.getUserHeaderFooter
(boolean header) Deprecated.Get user specified header and the footer.getWindowTitle
(String title) Deprecated.Get the window title.protected boolean
Deprecated.Check whether there are any tags for Serialization Overview section to be printed.private boolean
Deprecated.Check if the annotation contains an array of annotation as a value.boolean
Deprecated.boolean
isCoreClass
(ClassDoc cd) Deprecated.According to The Java™ Language Specification, all the outer classes and static nested classes are core classes.private static boolean
isHtmlTagLetterOrDigit
(char ch) Deprecated.italicsClassName
(ClassDoc cd, boolean qual) Deprecated.protected DocPath
pathString
(ClassDoc cd, DocPath name) Deprecated.Return the path to the class page for a classdoc.protected DocPath
pathString
(PackageDoc pd, DocPath name) Deprecated.Return path to the given file name in the given package.private Content
plainOrCode
(boolean plain, Content body) Deprecated.void
printHtmlDocument
(String[] metakeywords, boolean includeScript, Content body) Deprecated.Generates the HTML document tree and prints it out.private String
redirectRelativeLinks
(Doc doc, String text) Deprecated.Suppose a piece of documentation has a relative link.static String
Deprecated.replaceDocRootDir
(String htmlstr) Deprecated.Replace {@docRoot} tag used in options that accept HTML text, such as -header, -footer, -top and -bottom, and when converting a relative HREF where commentTagsToString inserts a {@docRoot} where one was missing.seeTagToContent
(SeeTag see) Deprecated.private boolean
Deprecated.Return true if relative links should not be redirected.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
getDocLink, getDocLink, getDocLink, getGeneratedBy, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getMemberDetailsListPrinted, getName, getPkgName, getStyleSheetProperties, printFramesDocument
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
addStyles, close, codeText, generateMethodTypesScript, getBody, getFramesJavaScript, getModifierTypeHeader, getNonBreakResource, getResource, getResource, getResource, getSpace, getTitle, getWinTitleScript, write
-
Field Details
-
pathToRoot
Deprecated.Relative path from the file getting generated to the destination directory. For example, if the file getting generated is "java/lang/Object.html", then the path to the root is "../..". This string can be empty if the file getting generated is in the destination directory. -
path
Deprecated.Platform-independent path from the current or the destination directory to the file getting generated. Used when creating the file. -
filename
Deprecated.Name of the file getting generated. If the file getting generated is "java/lang/Object.html", then the filename is "Object.html". -
configuration
Deprecated.The global configuration information for this run. -
utils
Deprecated. -
printedAnnotationHeading
protected boolean printedAnnotationHeadingDeprecated.To check whether annotation heading is printed or not. -
printedAnnotationFieldHeading
protected boolean printedAnnotationFieldHeadingDeprecated.To check whether annotation field heading is printed or not. -
isAnnotationDocumented
private boolean isAnnotationDocumentedDeprecated.To check whether the repeated annotations is documented or not. -
isContainerDocumented
private boolean isContainerDocumentedDeprecated.To check whether the container annotations is documented or not. -
docrootPattern
Deprecated. -
blockTags
Deprecated.
-
-
Constructor Details
-
HtmlDocletWriter
Deprecated.Constructor to construct the HtmlStandardWriter object.- Parameters:
path
- File to be generated.- Throws:
IOException
-
-
Method Details
-
replaceDocRootDir
Deprecated.Replace {@docRoot} tag used in options that accept HTML text, such as -header, -footer, -top and -bottom, and when converting a relative HREF where commentTagsToString inserts a {@docRoot} where one was missing. (Also see DocRootTaglet for {@docRoot} tags in doc comments.)Replace {@docRoot} tag in htmlstr with the relative path to the destination directory from the directory where the file is being written, looping to handle all such tags in htmlstr.
For example, for "-d docs" and -header containing {@docRoot}, when the HTML page for source file p/C1.java is being generated, the {@docRoot} tag would be inserted into the header as "../", the relative path from docs/p/ to docs/ (the document root).
Note: This doc comment was written with '@' representing '@' to prevent the inline tag from being interpreted.
-
getAllClassesLinkScript
Deprecated.Get the script to show or hide the All classes link.- Parameters:
id
- id of the element to show or hide- Returns:
- a content tree for the script
-
addMethodInfo
Deprecated.Add method information.- Parameters:
method
- the method to be documenteddl
- the content tree to which the method information will be added
-
addTagsInfo
Deprecated.Adds the tags information.- Parameters:
doc
- the doc for which the tags will be generatedhtmltree
- the documentation tree to which the tags will be added
-
hasSerializationOverviewTags
Deprecated.Check whether there are any tags for Serialization Overview section to be printed.- Parameters:
field
- the FieldDoc object to check for tags.- Returns:
- true if there are tags to be printed else return false.
-
getTagletWriterInstance
Deprecated.Returns a TagletWriter that knows how to write HTML.- Returns:
- a TagletWriter that knows how to write HTML.
-
getTargetPackageLink
Deprecated.Get Package link, with target frame.- Parameters:
pd
- The link will be to the "package-summary.html" page for this packagetarget
- name of the target framelabel
- tag for the link- Returns:
- a content for the target package link
-
printHtmlDocument
public void printHtmlDocument(String[] metakeywords, boolean includeScript, Content body) throws IOException Deprecated.Generates the HTML document tree and prints it out.- Parameters:
metakeywords
- Array of String keywords for META tag. Each element of the array is assigned to a separate META tag. Pass in null for no arrayincludeScript
- true if printing windowtitle script false for files that appear in the left-hand framesbody
- the body htmltree to be included in the document- Throws:
IOException
-
getWindowTitle
Deprecated.Get the window title.- Parameters:
title
- the title string to construct the complete window title- Returns:
- the window title string
-
addTop
Deprecated.Adds the user specified top.- Parameters:
htmlTree
- the content tree to which user specified top will be added
-
addBottom
Deprecated.Adds the user specified bottom.- Parameters:
htmlTree
- the content tree to which user specified bottom will be added
-
addSummaryDetailLinks
Deprecated.Do nothing. This is the default method. -
getSummaryTableHeader
Deprecated.Get summary table header.- Parameters:
header
- the header for the tablescope
- the scope of the headers- Returns:
- a content tree for the header
-
getTableCaption
Deprecated.Get table caption.- Parameters:
rawText
- the caption for the table which could be raw Html- Returns:
- a content tree for the caption
-
getMarkerAnchor
Deprecated.Get the marker anchor which will be added to the documentation tree.- Parameters:
anchorName
- the anchor name attribute- Returns:
- a content tree for the marker anchor
-
getMarkerAnchor
Deprecated.Get the marker anchor which will be added to the documentation tree.- Parameters:
sectionName
- the section name anchor attribute for page- Returns:
- a content tree for the marker anchor
-
getMarkerAnchor
Deprecated.Get the marker anchor which will be added to the documentation tree.- Parameters:
sectionName
- the section name anchor attribute for pageanchorName
- the anchor name combined with section name attribute for the page- Returns:
- a content tree for the marker anchor
-
getMarkerAnchor
Deprecated.Get the marker anchor which will be added to the documentation tree.- Parameters:
anchorName
- the anchor name or id attributeanchorContent
- the content that should be added to the anchor- Returns:
- a content tree for the marker anchor
-
getPackageName
Deprecated.Returns a packagename content.- Parameters:
packageDoc
- the package to check- Returns:
- package name content
-
getPackageLabel
Deprecated.Returns a package name label.- Parameters:
packageName
- the package name- Returns:
- the package name content
-
addPackageDeprecatedAPI
protected void addPackageDeprecatedAPI(List<Doc> deprPkgs, String headingKey, String tableSummary, String[] tableHeader, Content contentTree) Deprecated.Add package deprecation information to the documentation tree- Parameters:
deprPkgs
- list of deprecated packagesheadingKey
- the caption for the deprecated package tabletableSummary
- the summary for the deprecated package tabletableHeader
- table headers for the deprecated package tablecontentTree
- the content tree to which the deprecated package table will be added
-
pathString
Deprecated.Return the path to the class page for a classdoc.- Parameters:
cd
- Class to which the path is requested.name
- Name of the file(doesn't include path).
-
pathString
Deprecated.Return path to the given file name in the given package. So if the name passed is "Object.html" and the name of the package is "java.lang", and if the relative path is "../.." then returned string will be "../../java/lang/Object.html"- Parameters:
pd
- Package in which the file name is assumed to be.name
- File name, to which path string is.
-
getPackageAnchorName
Deprecated.Given a package, return the name to be used in HTML anchor tag.- Parameters:
packageDoc
- the package.- Returns:
- the name to be used in HTML anchor tag.
-
getPackageLink
Deprecated.Return the link to the given package.- Parameters:
pkg
- the package to link to.label
- the label for the link.- Returns:
- a content tree for the package link.
-
getPackageLink
Deprecated.Return the link to the given package.- Parameters:
pkg
- the package to link to.label
- the label for the link.- Returns:
- a content tree for the package link.
-
italicsClassName
Deprecated. -
addSrcLink
Deprecated.Add the link to the content tree.- Parameters:
doc
- program element doc for which the link will be addedlabel
- label for the linkhtmltree
- the content tree to which the link will be added
-
getLink
Deprecated.Return the link to the given class.- Parameters:
linkInfo
- the information about the link.- Returns:
- the link for the given class.
-
getTypeParameterLinks
Deprecated.Return the type parameters for the given class.- Parameters:
linkInfo
- the information about the link.- Returns:
- the type for the given class.
-
getCrossClassLink
public Content getCrossClassLink(String qualifiedClassName, String refMemName, Content label, boolean strong, String style, boolean code) Deprecated.Return a class cross link to external class documentation. The name must be fully qualified to determine which package the class is in. The -link option does not allow users to link to external classes in the "default" package.- Parameters:
qualifiedClassName
- the qualified name of the external class.refMemName
- the name of the member being referenced. This should be null or empty string if no member is being referenced.label
- the label for the external link.strong
- true if the link should be strong.style
- the style of the link.code
- true if the label should be code font.
-
isClassLinkable
Deprecated. -
getCrossPackageLink
Deprecated. -
getQualifiedClassLink
Deprecated.Get the class link.- Parameters:
context
- the id of the context where the link will be addedcd
- the class doc to link to- Returns:
- a content tree for the link
-
addPreQualifiedClassLink
Deprecated.Add the class link.- Parameters:
context
- the id of the context where the link will be addedcd
- the class doc to link tocontentTree
- the content tree to which the link will be added
-
getPreQualifiedClassLink
Deprecated.Retrieve the class link with the package portion of the label in plain text. If the qualifier is excluded, it will not be included in the link label.- Parameters:
cd
- the class to link to.isStrong
- true if the link should be strong.- Returns:
- the link with the package portion of the label in plain text.
-
addPreQualifiedClassLink
public void addPreQualifiedClassLink(LinkInfoImpl.Kind context, ClassDoc cd, boolean isStrong, Content contentTree) Deprecated.Add the class link with the package portion of the label in plain text. If the qualifier is excluded, it will not be included in the link label.- Parameters:
context
- the id of the context where the link will be addedcd
- the class to link toisStrong
- true if the link should be strongcontentTree
- the content tree to which the link with be added
-
addPreQualifiedStrongClassLink
public void addPreQualifiedStrongClassLink(LinkInfoImpl.Kind context, ClassDoc cd, Content contentTree) Deprecated.Add the class link, with only class name as the strong link and prefixing plain package name.- Parameters:
context
- the id of the context where the link will be addedcd
- the class to link tocontentTree
- the content tree to which the link with be added
-
getDocLink
Deprecated.Get the link for the given member.- Parameters:
context
- the id of the context where the link will be addeddoc
- the member being linked tolabel
- the label for the link- Returns:
- a content tree for the doc link
-
getDocLink
Deprecated.Return the link for the given member.- Parameters:
context
- the id of the context where the link will be printed.doc
- the member being linked to.label
- the label for the link.strong
- true if the link should be strong.- Returns:
- the link for the given member.
-
getDocLink
public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, String label, boolean strong) Deprecated.Return the link for the given member.- Parameters:
context
- the id of the context where the link will be printed.classDoc
- the classDoc that we should link to. This is not necessarily equal to doc.containingClass(). We may be inheriting comments.doc
- the member being linked to.label
- the label for the link.strong
- true if the link should be strong.- Returns:
- the link for the given member.
-
getDocLink
public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, Content label, boolean strong) Deprecated. -
getDocLink
public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, String label, boolean strong, boolean isProperty) Deprecated.Return the link for the given member.- Parameters:
context
- the id of the context where the link will be printed.classDoc
- the classDoc that we should link to. This is not necessarily equal to doc.containingClass(). We may be inheriting comments.doc
- the member being linked to.label
- the label for the link.strong
- true if the link should be strong.isProperty
- true if the doc parameter is a JavaFX property.- Returns:
- the link for the given member.
-
check
Deprecated. -
getDocLink
public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, Content label, boolean strong, boolean isProperty) Deprecated. -
getDocLink
public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc, Content label) Deprecated.Return the link for the given member.- Parameters:
context
- the id of the context where the link will be addedclassDoc
- the classDoc that we should link to. This is not necessarily equal to doc.containingClass(). We may be inheriting commentsdoc
- the member being linked tolabel
- the label for the link- Returns:
- the link for the given member
-
getAnchor
Deprecated. -
getAnchor
Deprecated. -
seeTagToContent
Deprecated. -
plainOrCode
Deprecated. -
addInlineComment
Deprecated.Add the inline comment.- Parameters:
doc
- the doc for which the inline comment will be addedtag
- the inline tag to be addedhtmltree
- the content tree to which the comment will be added
-
addInlineDeprecatedComment
Deprecated.Add the inline deprecated comment.- Parameters:
doc
- the doc for which the inline deprecated comment will be addedtag
- the inline tag to be addedhtmltree
- the content tree to which the comment will be added
-
addSummaryComment
Deprecated.Adds the summary content.- Parameters:
doc
- the doc for which the summary will be generatedhtmltree
- the documentation tree to which the summary will be added
-
addSummaryComment
Deprecated.Adds the summary content.- Parameters:
doc
- the doc for which the summary will be generatedfirstSentenceTags
- the first sentence tags for the dochtmltree
- the documentation tree to which the summary will be added
-
addSummaryDeprecatedComment
Deprecated. -
addInlineComment
Deprecated.Adds the inline comment.- Parameters:
doc
- the doc for which the inline comments will be generatedhtmltree
- the documentation tree to which the inline comments will be added
-
addCommentTags
Deprecated.Adds the comment tags.- Parameters:
doc
- the doc for which the comment tags will be generatedtags
- the first sentence tags for the docdepr
- true if it is deprecatedfirst
- true if the first sentence tags should be addedhtmltree
- the documentation tree to which the comment tags will be added
-
addCommentTags
private void addCommentTags(Doc doc, Tag holderTag, Tag[] tags, boolean depr, boolean first, Content htmltree) Deprecated.Adds the comment tags.- Parameters:
doc
- the doc for which the comment tags will be generatedholderTag
- the block tag context for the inline tagstags
- the first sentence tags for the docdepr
- true if it is deprecatedfirst
- true if the first sentence tags should be addedhtmltree
- the documentation tree to which the comment tags will be added
-
commentTagsToContent
Deprecated.Converts inline tags and text to text strings, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to non-inline tags.- Parameters:
holderTag
- specific tag where comment residesdoc
- specific doc where comment residestags
- array of text tags and inline tags (often alternating) present in the text of interest for this docisFirstSentence
- true if text is first sentence
-
shouldNotRedirectRelativeLinks
private boolean shouldNotRedirectRelativeLinks()Deprecated.Return true if relative links should not be redirected.- Returns:
- Return true if a relative link should not be redirected.
-
redirectRelativeLinks
Deprecated.Suppose a piece of documentation has a relative link. When you copy that documentation to another place such as the index or class-use page, that relative link will no longer work. We should redirect those links so that they will work again.Here is the algorithm used to fix the link:
<relative link> => docRoot + <relative path to file> + <relative link>
For example, suppose com.sun.javadoc.RootDoc has this link: <a href="package-summary.html">The package Page</a>
If this link appeared in the index, we would redirect the link like this: <a href="./com/sun/javadoc/package-summary.html">The package Page</a>
- Parameters:
doc
- the Doc object whose documentation is being written.text
- the text being written.- Returns:
- the text, with all the relative links redirected to work.
-
removeNonInlineHtmlTags
Deprecated. -
isHtmlTagLetterOrDigit
private static boolean isHtmlTagLetterOrDigit(char ch) Deprecated. -
addStyleSheetProperties
Deprecated.Add a link to the stylesheet file.- Parameters:
head
- the content tree to which the files will be added
-
addScriptProperties
Deprecated.Add a link to the JavaScript file.- Parameters:
head
- the content tree to which the files will be added
-
addJQueryFile
Deprecated.Add a link to the JQuery javascript file.- Parameters:
head
- the content tree to which the files will be addedfilePath
- the DocPath of the file that needs to be added
-
isCoreClass
Deprecated.According to The Java™ Language Specification, all the outer classes and static nested classes are core classes. -
addAnnotationInfo
Deprecated.Adds the annotatation types for the given packageDoc.- Parameters:
packageDoc
- the package to write annotations for.htmltree
- the documentation tree to which the annotation info will be added
-
addReceiverAnnotationInfo
public void addReceiverAnnotationInfo(ExecutableMemberDoc method, AnnotationDesc[] descList, Content htmltree) Deprecated.Add the annotation types of the executable receiver.- Parameters:
method
- the executable to write the receiver annotations for.descList
- list of annotation description.htmltree
- the documentation tree to which the annotation info will be added
-
addAnnotationInfo
Deprecated.Adds the annotatation types for the given doc.- Parameters:
doc
- the package to write annotations forhtmltree
- the content tree to which the annotation types will be added
-
addAnnotationInfo
Deprecated.Add the annotatation types for the given doc and parameter.- Parameters:
indent
- the number of spaces to indent the parameters.doc
- the doc to write annotations for.param
- the parameter to write annotations for.tree
- the content tree to which the annotation types will be added
-
addAnnotationInfo
Deprecated.Adds the annotatation types for the given doc.- Parameters:
doc
- the doc to write annotations for.descList
- the array ofAnnotationDesc
.htmltree
- the documentation tree to which the annotation info will be added
-
addAnnotationInfo
private boolean addAnnotationInfo(int indent, Doc doc, AnnotationDesc[] descList, boolean lineBreak, Content htmltree) Deprecated.Adds the annotation types for the given doc.- Parameters:
indent
- the number of extra spaces to indent the annotations.doc
- the doc to write annotations for.descList
- the array ofAnnotationDesc
.htmltree
- the documentation tree to which the annotation info will be added
-
getAnnotations
Deprecated.Return the string representations of the annotation types for the given doc.- Parameters:
indent
- the number of extra spaces to indent the annotations.descList
- the array ofAnnotationDesc
.linkBreak
- if true, add new line between each member value.- Returns:
- an array of strings representing the annotations being documented.
-
getAnnotations
public List<Content> getAnnotations(int indent, AnnotationDesc[] descList, boolean linkBreak, boolean isJava5DeclarationLocation) Deprecated.Return the string representations of the annotation types for the given doc. Anull
elementType
indicates that all the annotations should be returned without any filtering.- Parameters:
indent
- the number of extra spaces to indent the annotations.descList
- the array ofAnnotationDesc
.linkBreak
- if true, add new line between each member value.elementType
- the type of targeted element (used for filtering type annotations from declaration annotations)- Returns:
- an array of strings representing the annotations being documented.
-
addAnnotations
private void addAnnotations(AnnotationTypeDoc annotationDoc, LinkInfoImpl linkInfo, ContentBuilder annotation, AnnotationDesc.ElementValuePair[] pairs, int indent, boolean linkBreak) Deprecated.Add annotation to the annotation string.- Parameters:
annotationDoc
- the annotation being documentedlinkInfo
- the information about the linkannotation
- the annotation string to which the annotation will be addedpairs
- annotation type element and value pairsindent
- the number of extra spaces to indent the annotations.linkBreak
- if true, add new line between each member value
-
isAnnotationArray
Deprecated.Check if the annotation contains an array of annotation as a value. This check is to verify if a repeatable type annotation is present or not.- Parameters:
pairs
- annotation type element and value pairs- Returns:
- true if the annotation contains an array of annotation as a value.
-
annotationValueToContent
Deprecated. -
configuration
Deprecated.Return the configuation for this doclet.- Specified by:
configuration
in classHtmlDocWriter
- Returns:
- the configuration for this doclet.
-