search

mrash / fwknop

Single Packet Authorization > Port Knocking
http://www.cipherdyne.org/fwknop/
GNU General Public License v2.0
1.13k stars 232 forks source link

Add doxygen documentation #42

Open mrash opened 11 years ago

mrash commented 11 years ago

We should follow Franck's lead and add doxygen documentation to fwknop sources.

fjoncourt commented 11 years ago

I will submit my doxygen configuration to you this week. That would be a start.

jp-bennett commented 8 years ago

@mrash This would be helpful for some of the upcoming work. @fjoncourt Did you ever publish a doxygen config file for fwknop? I'll eventually start work on doxygen support, but I'll base off your work if I can.

jp-bennett commented 8 years ago

I've spent part of today toying with this, and I'm quite liking the results. A temporary preview: http://incomsystems.biz/misc/doxygen/html/

Most of my work so far has been in fko.h, seen here: http://incomsystems.biz/misc/doxygen/html/fko_8h.html

So far what seems to work best is adding the Doxygen markup to the header files. I want to finish the function descriptions for the fko_ functions, then I'll commit and make a pull request for it.

We should consider whether long term we want move as much documentation into doxygen as possible. I'm impressed with how useful the html documentation is, particularly the ability to jump from the function documentation directly to the code for the implementation.