tasklwIP - A Lightweight TCP/IP stack - Tasks: task #14052, Update doxygen documentation

 
 

You are not allowed to post comments on this tracker with your current authentication level.

task #14052: Update doxygen documentation

Submitter:  Dirk Ziegelmeier <dziegel>
Submitted:  Wed 22 Jun 2016 10:44:06 AM UTC
   
 
Category:  Documentation Should Start On:  Wed 22 Jun 2016 12:00:00 AM UTC
Should be Finished on:  Wed 22 Jun 2016 12:00:00 AM UTC Priority:  5 - Normal
Status:  Done Privacy:  Public
Assigned to:  None Percent Complete:  0%
Open/Closed:  Closed Planned Release:  None
Effort:  0.00

Fri 12 Aug 2016 09:08:56 PM UTC, comment #3: 

I'm satisfied with the current state for now

Dirk Ziegelmeier <dziegel>
Group administrator
Thu 23 Jun 2016 06:26:40 PM UTC, comment #2: 

Is there a reason for not documenting the direction of function parameters?
-> No. It was just not done by the developers.

Thanks for pointing to @cond.

Dirk Ziegelmeier <dziegel>
Group administrator
Thu 23 Jun 2016 10:46:39 AM UTC, comment #1: 

Is there a reason for not documenting the direction of function parameters? See https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdparam

Regarding item 2, you can specify aliases in the doxyfile, see the ALIASES item.
You can for example specify 'api' and 'notapi' and use it in the comments as @api and @notapi.

Something like:
ALIASSES = \
"api=Normal API, this function can be used by the programmer."\
"notapi=Internal API, this function is only used internally."

The drawback of this method is that the internal APIs are still documented.

Another way is using the @cond and @endcond commands. See https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdcond

Something like:
@cond INTERNAL
<internal code here>
@endcond

If you set ENABLED_SECTIONS = INTERNAL in the doxyfile, then the internal APIs are also documented.

This way you can create documentation for the all APIs but also for external APIs only.

Marco Veeneman <mave>
Wed 22 Jun 2016 10:44:06 AM UTC, original submission:  

1) There are many places in the code where doxygen docs are only partly added.

2) There should also be different docs for internal and external APIs. Currently, all functions are documented regardless whether they are intended to be used in user code or not. Does doxygen provide such a functionality?

Dirk Ziegelmeier <dziegel>
Group administrator

 

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

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 mave (Posted a comment)
  • -email is unavailable- added by dziegel (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.

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2016-08-12 dziegel StatusNone Done
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-f8d8.
    Corresponding source code