I've selectectively committed the last generated pages + 2 device files html pages, so you can have an idea about how they looks. See:
http://jallib.googlecode.com/svn/trunk/unvalidated/doc/html/index.html Maybe I could skip the "API details" section since there's no doc. Even with that, I think I'd lack some space. Seb Le Saturday 06 September 2008 12:14:35 Sebastien LELONG, vous avez écrit : > OK, we have a problem... Since device files now are JSG compliant, I can > generate html doc for them. The problem is the HTML files weigh about 83MB. > Far too much for our current repos size limit. > > Do we you want doc for device files ? There's no comment saying "This > TRIS_port_bit_nibble_d3 register is for blahblah..." but there's a list of > all available constants, pseudo-var, proc, etc... I think it's worth having > them, even if it's overkilled for our repos. I'd need to ask for more space > at the GC hosting team. > > Another consequence is the jalapi menu is unreadable because the list is > tooooooo long. I need to put a javascript tree here... > > Let me know what you want about doc for device files ! > > Seb > > Le Friday 05 September 2008 20:26:48 Sebastien LELONG, vous avez écrit : > > Hi all, > > > > I've committed the jalapi doc generator script... You can see the results > > here: > > > > http://jallib.googlecode.com/svn/trunk/unvalidated/doc/html/index.html > > > > > > This is old HTML style pages, fast written, this is quite ugly, so please > > forgive me :) At least it's functional, automatic, and the hardest part > > (parsing, extracting) is done. Someone, someday, will write nice css/html > > templates... > > > > (I've also searched for existing tools, such as doxygen, but it needs to > > define a new language because people here on earth don't know jal, it's > > overkill, and won't fit our needs). > > > > To run it, you'll need a wikify.py script + adjust your PYTHONPATH. See > > comments. You'll also need Cheetah Template installed (great tool). > > > > SAMPLEDIR=path/to/sample python jalapi.py jalapi_html.tmpl jal/file > > > result.html > > > > THIS IS FOR TEST ONLY ! Don't run and commit results ! You have another > > script for this, wich deals with valid filename, set correct svn > > properties for html mimetype, etc... > > > > ./jalapi_genetate.sh path/to/validated/or/unvalidated > > > > It'll put results in path/doc/html dir. > > > > > > Few notes: > > > > * it can only run on linux (or the like), because it uses grep, sed... > > > > * no documentation is generated when the jal file is not JSG compliant > > (it's based on jsg_validator.py script) > > > > * it extracts comments just before var/const/proc/func definition. This > > can give weird things... I let you discover them ! > > > > * while it extracts doc, it converts the raw text to html, using wikify. > > This means you can put google code wiki syntax in comments, there will be > > converted as html, while keeping carriage return (\n). This means you can > > have bold, italic, bullet list, tables, etc... :) I think this can be > > quite important to have enough syntax formatting to give a nice doc. > > > > * every lib found in {validated,unvalidated}/include is considered. So > > device files also have their doc page. > > > > * while it generates doc for a given, it searches for dependencies (with > > link to doc page). And it also searches for samples using this lib, with > > link to GC svn. Everything available at your finger tip :) > > > > > > Please give feedback ! > > > > Seb -- Sébastien LELONG http://www.sirloon.net http://sirbot.org --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
