Germain Garand > PerlQt-3.008 > kdocParseDoc

Download:
PerlQt-3.008.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  6
Open  0
View/Report Bugs
Source  

kdocParseDoc ^

        Routines for parsing of javadoc comments.

newDocComment

        Parameters: begin (starting line of declaration)

        Reads a doc comment to the end and creates a new doc node.

        Read a line
        check if it changes the current context
                yes
                        flush old context
                        check if it is a non-text tag 
                                                (ie internal/deprecated etc)
                                yes
                                        reset context to text
                                        set associated property
                                no
                                        set the new context
                                        assign text to new buffer
                no      add to text buffer
                        continue
        at end
                flush anything pending.

setType

        Parameters: propname, proptype ( 0 = single, 1 = list, 2 = text )

        Set the name and type of the pending property.

flushProp

        Flush any pending item and reset the buffer. type is set to DocText.

codeProp

        Flush the last node, add a new property and reset type to DocText.

docListProp

        The next item is a list property of docNode.

docProp

        The next item is a simple property of docNode.

textProp

        Parameters: prop, val

        Set next item to be a 'Text' list node. if val is assigned, the
        new node is assigned that text and flushed immediately. If this
        is the case, the next item is given the 'DocText' text property.

initDocNode

        Creates docNode if it is not defined.

attachDoc

Connects a docnode to a code node, setting any other properties if required, such as groups, internal/deprecated flags etc.

syntax highlighting: