OpenChange documentation has now moved to doxygen and is available in the latest trunk revision r300.
We've introduced doxygen as a program dependency when running ./configure "make doxygen" will generate the HTML and man pages output respectively in apidocs/html and apidocs/man. When loading apidocs/html with your favorite browser, you should have similar result to http://www.openchange.org/apidocs/ There is still a couple of man pages in doc/man but they are either related to (1) man pages for openchange-tools or related to functions (3) not yet documented using doxygen. We also have to document data structures and improve the general documentation but this is already a good step for further commit (post libmapi-0.6). libmapi-0.6 is planned to be released within a couple of days. If you have some time and are willing to help, contributing to the documentation would be greatly appreciated -- fix typo, mistakes etc, add new documentation samples or description. Cheers, Julien On Thu, 2007-10-25 at 15:17 +0200, Julien Kerihuel wrote: > A preliminary version of the HTML documentation generated with doxygen > is available at the following URL: > > http://www.openchange.org/apidocs/ > > The current doygen documentation does not cover the whole libmapi API, > however (and thanks to Brad), it provides a good overview of how it will > look like once completed. > > Prior I push the initial doxygen documentation commit, I'd like to fix > man pages output and maybe work on the latex template. > > Bugs/Suggestions/Ideas -- feel free to share your comments with us ;-) > > Cheers, > Julien. > > On Tue, 2007-10-23 at 20:39 +0200, Julien Kerihuel wrote: > > Brad, > > > > I'm currently working on the integration of your patch against latest > > trunk revision. > > > > On Thu, 2007-09-27 at 15:59 +1000, Brad Hards wrote: > > > 2. Modified scripts/mkproto.pl so that the comments are also put into the > > > header. This is the most hairy part, because I don't grok perl at all. I > > > used > > > the samba4 script as a model - thanks to Jelmer for the suggestion. > > > > Have seen the modification. Will give it a closer look. > > > > > 3. Added the examples from the linuxconf.eu paper. > > > 4. Added some content for the "main page" (start page). Mostly from the > > > intro > > > to the linuxconf.eu paper. > > > 5. Added an example of additional content. This page (on MAPI concepts) > > > is > > > only to show what is possible. Again, content is from the linuxconf.eu > > > paper. > > > I'd like to extract more from that paper, including the diagrams. > > > > Thanks for the examples! This will be really useful when we add > > additional documentation such as examples, FAQs or code samples in > > further releases. > > > > > There are still some parts that aren't as good as I'd like: > > > - the man3 version is pig-ugly > > > > I agree ;-) Will take time to see how we can improve this. > > > > > - the documentation shows <libmapi/proto.h>, and there should be some > > > explanation that the right header is <libmapi.h>. That might be quite > > > hard to > > > fix. > > > > Fixed: using INPUT_FILTERS and sed in Doxyfile. Have also removed > > _PUBLIC_ from the generated documentation. > > > > > - there are too many undocumented functions/data structures/enums. I need > > > to > > > suppress some of it, and fix the rest. > > > > I've almost finished with libmapi-0.6 development. Conclusion: I can > > take a couple of days to work on the documentation until we release the > > new version. > > > > _______________________________________________ > > devel mailing list > > [email protected] > > http://mailman.openchange.org/listinfo/devel > _______________________________________________ > devel mailing list > [email protected] > http://mailman.openchange.org/listinfo/devel -- Julien Kerihuel [EMAIL PROTECTED] OpenChange Project Manager GPG Fingerprint: 0B55 783D A781 6329 108A B609 7EF6 FE11 A35F 1F79
signature.asc
Description: This is a digitally signed message part
_______________________________________________ devel mailing list [email protected] http://mailman.openchange.org/listinfo/devel
