bugGNU Parallel - Bugs: bug #44723, Doxygen preparation


bug #44723: Doxygen preparation

Submitter:  Ole Tange <tange>
Submitted:  Sat 04 Apr 2015 05:40:30 PM UTC
Category:  None Severity:  3 - Normal
Item Group:  None Status:  None
Privacy:  Public Assigned to:  None
Open/Closed:  Open
* Mandatory Fields

Add a New Comment Rich Markup

Sun 10 Dec 2023 07:39:39 PM UTC, comment #3: 
Ole Tange <tange>
Group administrator
Sun 10 Dec 2023 07:30:37 PM UTC, comment #2: 

Need HelloWorld.pl example to proceed.

It is unclear how to get started.

However, it seems a LLM can help doing the actual work when the task is more clear.

https://metacpan.org/pod/Doxygen::Filter::Perl allows for comments to be put inside sub-definition. This is will make it easier to move complete subs.

sub test1
    #** @method public test1 ($value)
    # ....

Ole Tange <tange>
Group administrator
Sat 04 Apr 2015 05:42:24 PM UTC, comment #1: 

Better example:

    #** @method private _RemovePerlCommentFlags ($aBlock)
    # This method will remove all of the comment marks "#" for our output to Doxygen.  If the line is
    # flagged for verbatim then lets not do anything.
    # @param aBlock - required array_ref (doxygen comment as an array of code lines)
    # @retval sBlockDetails - string (doxygen comments in one long string)

Ole Tange <tange>
Group administrator
Sat 04 Apr 2015 05:40:30 PM UTC, original submission:  

Convert all function comments to:

    #** @method private _PrintMethodBlock ($class, $methodDef)
    # This method will print the various subroutines/functions/methods in apprporiate doxygen syntax
    # @param class - required string (name of the class)
    # @param state - required string (current state)
    # @param type - required string (type)
    # @param method - required string (name of method)

Ole Tange <tange>
Group administrator


(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:

No files currently attached


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -email is unavailable- added by tange (Submitted the item)

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.


    No changes have been made to this item

    Back to the top

    Powered by Savane 3.12.
    Corresponding source code