search

dparrish / libcli

Libcli provides a shared library for including a Cisco-like command-line interface into other software. It's a telnet interface which supports command-line editing, history, authentication and callbacks for a user-definable function tree.
https://dparrish.com/link/libcli
GNU Lesser General Public License v2.1
289 stars 143 forks source link

adding doxygen documentations to all libcli.h header functions #74

Closed mpzanoosi closed 1 year ago

mpzanoosi commented 3 years ago

Hi I used your library somewhere and I found a Doxygen documentation can help a lot! So I've added Doxygen to all libcli.h functions! I've also added Doxygen configuration file conf.doxygen which can be used with command doxygen conf.doxygen then the documentation can be found in doc/ folder

RobSanders commented 1 year ago

Thank you for this. I'll merge to the staging-1.10.8, and may make some very minor changes to the comments.

RobSanders commented 1 year ago

Mohamad, do you have a preferred email address to use in the spec file change log to recognize your contribution? Trying to finalize the 1.10.8 release over then week or so.

RobSanders commented 1 year ago

Or, if you'd rather, I'll use my email for the header, but specifically recognize code coming from you github handle in the comment itself.