fincs / gendocs Goto Github PK

It's possible to use Remarks:-Keyword within Method-documentation section. This way additional information can be added to Method-documentation. This is especially useful if you want to add structure to your remarks using Markup:

/*!
    Method: test(x)
        bla
    Parameters:
        x - *(Optional)* bla
    Remarks:
        ### See also: 
            [test2](#test2)

        ### Author(s)
            * 20130308 - [hoppfrosch]([email protected]) - bla
*/

I failed to find a way to add something similar to the class- or library-documentation block ..

Wouldn't it make sense to support Remarks:-Keyword within method as well as property, class and library documentation (what else?) sections to get some consistency and make usage of Remarks: more intuitive?

The usage/non-usage of attribute @UseShortForm within documentation results in different output.

For example: omitting "@UseShortForm", the keyword "Parameters:" for a "Property: " does not produce an output. Using "@UseShortForm" the keyword "Parameters:" for a "Property:" produces an output ....

Example

/*! ---------------------------------------------------------------------------------------
Property: alwaysOnTop[flag] [get/set]
    Get or Set the *AlwaysOnTop*-Property. To toogle current *Always-On-Top*-Property, simply use `obj.alwaysOnTop := !obj.alwaysOnTop`
Parameters:
    flag - true or false (activates/deactivates *AlwaysOnTop*-Property)
   */

Within my class I've implemented a method named test() and within _Get() of my class I've created a property with the same name test.

Documenting the code using the following:

/*!
    Class: MyClass
    @UseShortForm
*/
...
    /*! 
    Method: test(mode)
        ...
    */
    ...
    /*! 
    Property: test [get]
        ...
    */

Everything seems to be fine, but looking inside html, both test entries are generated with the same id (anchor). Therefore linking to one of these test entries is ambiguous..

Omitting the @UseShortForm the generated output is obviously erroneous as well:

• Duplicate id is generated within MyClass.html as well.
• Both test-entries result in the same outputtfile MyClass.test.html - only the "last" test-documentation is available (in example above property documentation is available - method documentation is overwritten ...)

Hi,
I was looking for an AHK script that converts the selected text from Markdown to HTML, and looking at your repository I think we can extract this function from it... could you help me doing this please ? :D

Generating the main library documentation page the contents of author and the license fileds are included in pagetitle.
Include a Version field as well.