Package adams.doc.javadoc

Class FlowJavadoc

  • All Implemented Interfaces:
    Destroyable, LoggingSupporter, OptionHandler, UserModeSupporter, SizeOfHandler, Serializable
    public class FlowJavadoc
extends Javadoc
    Generates Javadoc comments for the AbstractActor. Can automatically update the comments if they're surrounded by the FLOW_STARTTAG and FLOW_ENDTAG (the indention is determined via the FLOW_STARTTAG).

    In addition to the flow tags, one can also place the tags ACCEPTS_STARTTAG/ACCEPTS_ENDTAG and GENERATES_STARTTAG/GENERATES_ENDTAG in the Javadoc. These tags don't add blocks of comments, but just a single classname. Valid options are: 

    -env <java.lang.String> (property: environment)
         The class to use for determining the environment.
         default: adams.core.Environment
 
    -W <java.lang.String> (property: classname)
         The class to load.
         default: adams.doc.AllJavadoc
 
    -nostars (property: useStars)
         Controls the use of '*' in the Javadoc.
 
    -dir <java.lang.String> (property: dir)
         The directory above the package hierarchy of the class.
         default: .
 
    -silent (property: silent)
         Suppresses printing in the console.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    FLOW_STARTTAG, FLOW_ENDTAG, ACCEPTS_METHOD, ACCEPTS_STARTTAG, ACCEPTS_ENDTAG, GENERATES_METHOD, GENERATES_STARTTAG, GENERATES_ENDTAG, Serialized Form

    • Field Detail

      • FLOW_STARTTAG

        public static final String FLOW_STARTTAG
        the start comment tag for inserting the generated Javadoc (all).
        See Also:
        Constant Field Values

      • FLOW_ENDTAG

        public static final String FLOW_ENDTAG
        the end comment tag for inserting the generated Javadoc (all).
        See Also:
        Constant Field Values

      • ACCEPTS_STARTTAG

        public static final String ACCEPTS_STARTTAG
        the start comment tag for inserting the generated Javadoc (just "accepts").
        See Also:
        Constant Field Values

      • ACCEPTS_ENDTAG

        public static final String ACCEPTS_ENDTAG
        the end comment tag for inserting the generated Javadoc (just "accepts").
        See Also:
        Constant Field Values

      • GENERATES_STARTTAG

        public static final String GENERATES_STARTTAG
        the start comment tag for inserting the generated Javadoc (just "generates").
        See Also:
        Constant Field Values

      • GENERATES_ENDTAG

        public static final String GENERATES_ENDTAG
        the end comment tag for inserting the generated Javadoc (just "generates").
        See Also:
        Constant Field Values

    • Constructor Detail

      • FlowJavadoc

        public FlowJavadoc()

    • Method Detail

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class Javadoc

      • generateJavadoc

        protected String generateJavadoc​(int index)
                          throws Exception
        generates and returns the Javadoc for the specified start/end tag pair.
        Specified by:
        generateJavadoc in class Javadoc
        Parameters:
        index - the index in the start/end tag array
        Returns:
        the generated Javadoc
        Throws:
        Exception - in case the generation fails

      • main

        public static void main​(String[] args)
        Parses the given commandline parameters and generates the Javadoc.
        Parameters:
        args - the commandline parameters for the object