Milos, Thank for providing this, and in the form that you did so it fits in within existing documentation framework. The doc directory hierarchy could be improved slightly to segregate man pages for the tools versus man pages for system configuration files (pkcs11.txt) but that's another topic. As it is now what you have done fits in well.
I applied your patch and recreated the doxygen pages it without any problems. Your writeup explaining how to write the comments is clear. Writing the doxygen-friendly comments would be a major tasks that would take quite some time. The public functions, comments, and data structures would be the ones folks care the most about. There are internal functions and data structures that would need a disclaimer as developers can't not count of them as staying the same. If you have a mozilla-bugzilla account please log a bug. If not then one of us could do it on your behalf. Thanks, Elio On Thu, Aug 29, 2013 at 2:12 AM, Milan Bartos <mbar...@redhat.com> wrote: > Hi, > currently there is no usable NSS documentation that would cover all NSS > functions, macros, structures... > I've made some documentation preview, currently available at > http://mbartos.fedorapeople.org/doxygen3/html/ > It's dogyxen-generated documentation from current NSS source code. You can > find some examples of > documented fucntions at > http://mbartos.fedorapeople.org/doxygen3/html/pk11cxt_8c.html. > Functions, macros and structures are split to public and private (Modules > tab), > according to header files (only some so far). > I've integrated doxygen documentation generation into build system on my > branch. > > I'd like to know whether this could be the way to create and maintain NSS > documentation, I'd like > to get some feedback and opinions. > > Thanks for comments, > Milan Bartos > -- > dev-tech-crypto mailing list > dev-tech-crypto@lists.mozilla.org > https://lists.mozilla.org/listinfo/dev-tech-crypto > -- dev-tech-crypto mailing list dev-tech-crypto@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-tech-crypto
