Hi, I've worked a little on issue 15, about generating api doc. You can see the very first results here:
* http://code.google.com/p/jallib/wiki/JalapiAdcHardware * http://code.google.com/p/jallib/wiki/JalapiPwmCcp1 The script (not committed yet) produces a wiki page, with a naming convention. It also shows dependencies ("include ..." in lib's code) and samples (search for "include <libname>" in sample dir). Everything is quite ok... except GC wiki is kind of a crap: I can't force line feed (\n) except by creating paragraph (that is, double \n, which is quite ugly). This means if, in the comment, there's a carriage return, it won't necessarily be reproduced in the wiki page. Quite confusing... I could use verbatim block to preserve comment's layout, but we'd also loose other wiki formatting stuff that could be put in jal comments (bullet list, table, ...). The syntax highlight is also turned on by default, which can be confusing while reading doc (dunno how to disable it). So... : 1. either we decide to be careful while writing comments in jal code, and have to have in mind wiki syntax stuff. 2. or I could generate an HTML file, instead of a wiki page For option 2., I think it's possible to put html file in svn which can be accessed from googlecode website (to be tested). While we can have better formatting results, we'd loose the searching capabilities of GC wiki, which comes with no cost... For this last reason, I'd prefer 1., but it's a new constraint: what you write in jal comment won't give the same results in GC wiki. Let me know your choice ! Cheers, Seb --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "jallib" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/jallib?hl=en -~----------~----~----~----~------~----~------~--~---
