What the first part of the subject means is I have put in (as of revision 11229) a special form of commentary in pllegend.c that allows it to be processed by doxygen to generate documentation.
If you want to see the definitive pllegend documentation generated by doxygen as a result of this special pllegend.c commentary, please use the -DBUILD_DOX_DOC=ON cmake option on Linux and run make build_doxygen in the doc directory of the build tree. You should view the doxygen-generated pllegend documentation results in doc/doxygen/html/main.html ==> files ==> pllegend using a browser. That definitive documentation of pllegend should help those of you reviewing that function's API to understand everything that is possible with the current pllegend implementation. Furthermore, for those of you lurking on this list who are looking for a way to give important help to the PLplot project, the doxygen-generated documentation effort is a good place to start. Most PLplot functions are already self-documented so in those cases it is simply a matter of converting existing commentary into the doxygen form. To see what that form is, look for the special doxygen commentary (all lines beginning with "//!") in the template files src/plpage.c and src/pllegend.c which already have complete self-documentation in doxygen form. Follow the above instructions to view the results of your changes, and once you are happy with the doxygenated code comments in one src file, please send in a patch immediately showing your changes for that file to minimize the probability of duplicating effort. "Many hands make light work" so if enough of you are inspired to help out this way, we should complete the doxygen-generated documentation of the complete PLplot API rather quickly. Alan __________________________ Alan W. Irwin Astronomical research affiliation with Department of Physics and Astronomy, University of Victoria (astrowww.phys.uvic.ca). Programming affiliations with the FreeEOS equation-of-state implementation for stellar interiors (freeeos.sf.net); PLplot scientific plotting software package (plplot.org); the libLASi project (unifont.org/lasi); the Loads of Linux Links project (loll.sf.net); and the Linux Brochure Project (lbproject.sf.net). __________________________ Linux-powered Science __________________________ ------------------------------------------------------------------------------ Start uncovering the many advantages of virtual appliances and start using them to simplify application deployment and accelerate your shift to cloud computing. http://p.sf.net/sfu/novell-sfdev2dev _______________________________________________ Plplot-devel mailing list Plplot-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/plplot-devel
