This really look interesting. > > An example of the system's use can be found in my GUI builder project Guido > on SourceForge. One of the files in the application's CVS directory might be > a good example: > > http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/guido/guido/lib/Guido/Applica t > ion.pm?rev=1.9&content-type=text/vnd.viewcvs-markup > > (Whereever you see # MODINFO comments is where the documentation is being > placed) >
Do have considered to use JavaDoc like comments. This would allow to have the same way of comments in C (using doxygen) and Perl (and Java) . Example: #* # @method TRACE Tracing function for logging diagnostic messages # @param msg STRING Message to send to trace # @param trace_lvl STRING Level of tracing required to log msg Instead of # MODINFO, we start a special comment with #* and keywords are beginning with @. The "modinfo comment" ends as soon as there is a non comment line. What do you think ? > > I designed the system to do two things, a) make it easy to update your API > documentation when you make changes to your code, and b) get the API info > into XML stored alongside the module itself so that you can convert it to > whatever you want whenever you want. Along the way, I ended up designing the > primary module for the system so that it could parse the XML into a set of > perl objects, which enables runtime inspection of API documentation from your > script (intellisense, anyone? ;-) > This maybe usefull for Perl beans interface description. At least it will be a good idea to feed Perl beans interface description and docs from the same source. Since I am planning to do more work for the p5ee documention system during the next time, will take a closer look at your module as soon as I have the time. Gerald ------------------------------------------------------------- Gerald Richter ecos electronic communication services gmbh Internetconnect * Webserver/-design/-datenbanken * Consulting Post: Tulpenstrasse 5 D-55276 Dienheim b. Mainz E-Mail: [EMAIL PROTECTED] Voice: +49 6133 925131 WWW: http://www.ecos.de Fax: +49 6133 925152 -------------------------------------------------------------
