A package for translating JavaDoc topics into Natural Docs.
These will appear literally in the output because I cannot handle them easily.
These will appear literally in the output because I cannot handle them easily.
http://java.sun.com
| NaturalDocs:: | A package for translating JavaDoc topics into Natural Docs. |
| Variables | |
| blockTags | An existence hash of the all-lowercase JavaDoc block tags, not including the @. |
| inlineTags | An existence hash of the all-lowercase JavaDoc inline tags, not including the @. |
| Functions | |
| IsMine | Examines the comment and returns whether it is definitely JavaDoc content, i.e. |
| ParseComment | Parses the JavaDoc-syntax comment and adds it to the parsed topic list. |
| FormatText | Translates any inline tags or HTML codes to NDMarkup and returns it. |
| ConvertAmpChars | |
| ConvertLink | |
| MakeURLLink | |
| MakeEMailLink |
sub IsMine #( string[] commentLines, bool isJavaDoc )
Examines the comment and returns whether it is definitely JavaDoc content, i.e. is owned by this package.
| commentLines | An arrayref of the comment lines. Must have been run through NaturalDocs::Parser->CleanComment(). |
| isJavaDoc | Whether the comment is JavaDoc styled. This doesn’t necessarily mean it has JavaDoc content. |
Whether the comment is definitely JavaDoc content.
sub ParseComment #( string[] commentLines, bool isJavaDoc, int lineNumber, ParsedTopics[] * parsedTopics )
Parses the JavaDoc-syntax comment and adds it to the parsed topic list.
| commentLines | An arrayref of the comment lines. Must have been run through NaturalDocs::Parser->CleanComment(). The original memory will be changed. |
| isJavaDoc | Whether the comment is JavaDoc styled. This doesn’t necessarily mean it has JavaDoc content. |
| lineNumber | The line number of the first of the comment lines. |
| parsedTopics | A reference to the array where any new NaturalDocs::Parser::ParsedTopics should be placed. |
The number of parsed topics added to the array, which in this case will always be one.
sub FormatText #( string text, bool inParagraph )
Translates any inline tags or HTML codes to NDMarkup and returns it.
An existence hash of the all-lowercase JavaDoc block tags, not including the @.
my %blockTags
An existence hash of the all-lowercase JavaDoc inline tags, not including the @.
my %inlineTags
Examines the comment and returns whether it is definitely JavaDoc content, i.e.
sub IsMine #( string[] commentLines, bool isJavaDoc )
Parses the JavaDoc-syntax comment and adds it to the parsed topic list.
sub ParseComment #( string[] commentLines, bool isJavaDoc, int lineNumber, ParsedTopics[] * parsedTopics )
Translates any inline tags or HTML codes to NDMarkup and returns it.
sub FormatText #( string text, bool inParagraph )
sub ConvertAmpChars #( text )
sub ConvertLink #( text )
sub MakeURLLink #( target, text )
sub MakeEMailLink #( target, text )
Removes any extraneous formatting and whitespace from the comment.
sub CleanComment #( commentLines )