Re: [Simple-support] Best way to start reusing simple code in order to automatically generate documentation

[Niall G. <gal...@ya...>]

There is an example in a test called CommentTest of how to add your own annotations that can be used by Simple. This allows you to add custom annotations that can be processed, perhaps this can help with documentation generation? 


________________________________
From: Serge SIMON <ser...@gm...>
To: sim...@li...
Sent: Sunday, 2 October 2011 9:30 PM
Subject: [Simple-support] Best way to start reusing simple code in order to automatically generate documentation


Hello,

I'm using Simple with great success on various projects.
One of my usual use is to read and write application configuration. 
Sometimes this configuration becomes quite heavy and complicated.

I would like to write something to automatically generate my documentation (in HTML, Wiki, or Doxia format) from the annotations used for Simple (maybe with a few additionnal ones, for example a new @Description one). This way i would have an always up-to-date configuration accessible to users, without the hassle of maintaining this by hand.

What would be in your opinion the best and easiest way to start ? (i can of course do the while thing outside the Simple code, but it would maybe be a better idea to reuse as much code as possible from Simple). Any clues about where to start (in a few words) ?

Regards.

-- 
Serge.

------------------------------------------------------------------------------
All of the data generated in your IT infrastructure is seriously valuable.
Why? It contains a definitive record of application performance, security
threats, fraudulent activity, and more. Splunk takes this data and makes
sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-d2dcopy2
_______________________________________________
Simple-support mailing list
Sim...@li...
https://lists.sourceforge.net/lists/listinfo/simple-support