On 09/17/2012 08:16 PM, Jason Edgecombe wrote:
On 09/17/2012 01:21 PM, Jeffrey Altman wrote:
On 9/16/2012 9:20 PM, Jason Edgecombe wrote:

I have a basic doxygen config. I've moved some of the specifications to
their own module.

I've pushed three patches to gerrit:
http://gerrit.openafs.org/8128
http://gerrit.openafs.org/8129
http://gerrit.openafs.org/8130
Thanks for taking the time to get this far.  There is much more than
will need to be done before Doxygen generated documentation is useful.
There is very little meaningful organization in the output.

   http://docs.openafs.org/doxygen-test/index.html

I believe that we need to organize the data into libraries, executables,
and other modules.  Very few of the existing source directories contain
Doxygen comments.  Some like the Network Identity Manager Provider are
fully documented.  Others are partial.  But most have nothing.

I think we should start by filtering only directories for which there
known is valid Doxygen commenting.

Jeffrey Altman




You're welcome.

It definitely needs more organization.  That will take time.

The config that you used was already set to only include code that had doxygen comments, but I'll limit the list of input folders to those with QT-style doxygen comments.

What else needs to be done before the current Doxygen commits in gerrit (8128,8129, 8130) will be accepted?

I know that more work is needed, but I think that should happen after the current commits are accepted.

Jason
_______________________________________________
OpenAFS-devel mailing list
[email protected]
https://lists.openafs.org/mailman/listinfo/openafs-devel

Reply via email to