To Werner and Hazen:

I have recently made a number of general changes related to doxygen.

1.  I have changed the doxygen configuration in doc/Doxyfile.in such
that EXTRACT_ALL, EXTRACT_PRIVATE, and EXTRACT_STATIC are all set to
YES.  This means that an attempt is made to document all our source
code even if there is no explicit doxygen-related commentary.

This makes the doxygen-generated documentation much more complete.
For example, the exact API for each of our core library functions is
now listed in the doxygen-generated HTML results.  Of course, adding
doxygen documentation of those arguments with specific changes to the
commentary lines preceding each function like we have already done for
src/pllegend.c and src/plpage.c is strongly encouraged, but the results
already look pretty good for the src files where we have not done
that yet.

2.  I have modified the build system to install these more complete
doxygen results as well as include them in our source-release tarball
when BUILD_DOX_DOC is ON.

3.  I have modified scripts/make_tarball.sh to use the
-DBUILD_DOX_DOC=ON cmake option.  I tested that updated script and all
seems to be well.  The tarball has a relatively small increase in size
from 6.9M to 8.3M.  I think that price is worth paying to have the
doxygen-generated documentation included in our tarball along with the
generated DocBook documentation that is already there.

4.  I have modified scripts/generate_website.sh to generate doxygen
results and install them at the remote website that is populated
by that script.  All seems to be well in that case also.

N.B. Hazen, you must now have doxygen installed on the Ubuntu computer
you use to generate our website and make a release.  I believe the
logic is in place to skip all doxygen-related stuff without errors if
doxygen is not installed, but the website and tarball results would be
incomplete.

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
__________________________

------------------------------------------------------------------------------
Beautiful is writing same markup. Internet Explorer 9 supports
standards for HTML5, CSS3, SVG 1.1,  ECMAScript5, and DOM L2 & L3.
Spend less time writing and  rewriting code and more time creating great
experiences on the web. Be a part of the beta today
http://p.sf.net/sfu/msIE9-sfdev2dev
_______________________________________________
Plplot-devel mailing list
Plplot-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/plplot-devel

Reply via email to