On 5 Sep 2008, at 20:26 , Sebastien LELONG wrote:
>
> 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
Fantastic. We can't have too much documentation.
>
>
> 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
>
> >
>
>
---
ir EE van Andel [EMAIL PROTECTED] http://www.fiwihex.nl
Fiwihex B.V. Wierdensestraat 74, NL7604BK Almelo, Netherlands
tel+31-546-491106 fax+31-546-491107
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
