search

FreeRADIUS / freeradius-client

A BSD licenced RADIUS client library
http://freeradius.org/freeradius-client/
Other
143 stars 100 forks source link

Auto-generate development manpages based on source description #31

Closed nmav closed 9 years ago

nmav commented 9 years ago

This patch set auto-generates manpages from source code description. It also includes the auto-generated files.

nmav commented 9 years ago

The patch set was updated to remove the auto-generated files.

arr2036 commented 9 years ago

We use doxygen for the main server, which has significantly more functions documented. Please could you redo this pull request with doxygen headers.

nmav commented 9 years ago

doxygen doesn't generate manpages, gdoc is more powerful.

arr2036 commented 9 years ago

No, you're wrong. http://www.stack.nl/~dimitri/doxygen/manual/starting.html#man_out

nmav commented 9 years ago

It's a petty this wasn't merged, I'm not adding doxygen support, so we are stuck with bad comments instead of better comments. I'll try to rebase my branch on the current comments in freeradius-clients.

arr2036 commented 9 years ago

When you don't consult with the project maintainers the result is wasted effort.

nmav commented 9 years ago

Thanks for that.

arr2036 commented 9 years ago

The majority of it would be simple search/replace. If you're not willing to do it, I'll take a look tomorrow (please leave the branch in your repo).

We should be working towards convergence between the PAM module, the apache module, this library and the FreeRADIUS decoder/encoder. Using the same code style, system functions, and documentation tools will help with that.