Skip to end of metadata
Go to start of metadata

About 'JavaDoc' Macro:

The javadoc macro extracts class and method information from javadoc
source. In the process javadoc source must be packed in a zip-archive and
stored as an attachment at the root page of a space.
parameter description
'class' Shows class detail information or is used in combination with 'method' or 'like'.
'method' This parameter only works in combination with 'class'. Put in the name of the one method which should be displaied.
Also Wildcard ' * ' is allowed to display all methods of a class.
'like' This parameter only works in combination with 'class'. Put in a substring and displaied will be all methods of
the specified class which names contain this substring.
'genuine' Displays a class in original javadoc style.
'clean' As an option with other parameters, 'clean' deletes temporary files onlyfrom the actual Space.
Separate usage of 'clean' deletes all files and dirs this pluginever created.
'help' Prints out this Help.
This macro uses the following other macros:

{warning}; {info}; {code}; {html}

Please activate or even install them.
The following combinations of the parameters are possible:
combination option effect
'class' 'clean' Displays class information and optional deletes tempfiles from this space.
'class' + 'method' 'clean' Displays the information to one specific complete methodname. If a method is overwritten, the result displays all overwritten methods
with the name 'method'. Optional deletes tempfiles from this space.
'class' + 'like' 'clean' Displays the information from multiple methods which names matches that substring. Optional deletes tempfiles from this space.
'genuine' 'clean' Displays the class information in original javadoc style, optional deletes tempfiles from this space.
'clean'   Deletes any tempdir and tempfile from this plugin for all spaces, if 'clean' is the sole parameter.
'help'   Prints out this Help.
Any other combination (default) leads to an error message.
Examples: (with JDK-JavaDoc as an Attachment in root page of space)
{javadoc:genuine=String} Prints out original javadoc page.
{javadoc:genuine=String|clean=true} Prints out original javadoc page and deletes tempfile of this space.
{javadoc:class=String} Prints out class-information of the class 'String'.
{javadoc:class=String|clean=true} Prints out class-information of the class 'String' and deletes tempfile of this space.
{javadoc:class=String|method=*} Prints out all methods of the class 'String'.
{javadoc:class=String|method=equals} Prints out method-information of all methods matching 'equals' in class 'String'.
{javadoc:class=String|method=equals|clean=true} Like above plus deletes tempfile of this space.
{javadoc:class=String|like=equa} Prints out method-information of all methods containing 'equa' in class 'String'.
{javadoc:clean=true|class=String|like=equa} Like above plus deletes tempfile of this space.
{javadoc:clean=true} Deletes all files and dirs this plugin ever created.
{javadoc:help=true} Prints out this help.
Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.