Hi Werner:

As of revision 11648 I have made a number of changes in the way
our doxygen documentation is generated.

I.  It is much more comprehensive with source coverage expanding from
just src to all the source code in lib, src, drivers, bindings
include, and corresponding generated source code in the build tree.
This makes the generated documentation much more comprehensive with
many useful additional cross references.  However, the
downside is that our doxygen documentation build now takes close to 10
seconds.  That is still fairly small, but nevertheless it could be an
annoying latency for developers who are using the "all" target or
"install" target (which depends on "all") in the build tree.  That
concern leads to II.

II. We don't build the doxygen documentation by default any more to
reduce build latency for the "all" and "install" targets. However, I
highly recommend using the cmake option -DBUILD_DOX_DOC=ON to turn on
generation of our doxygen documentation if you are at all interested
as a developer in all the html code cross references that are
generated by such documentation in doc/doxygen/html in the build tree.
The -DBUILD_DOX_DOC=ON option enables the specific target
"build_doxygen" which you should run if you want to build the doxygen
documentation. The general "all" and "install" targets also depend on
"build_doxygen". (Note, I normally always use -DBUILD_DOX_DOC=ON since
there is no doxygen build latency for the more specific targets I tend
to use in the test framework such as "test_noninteractive" and
"test_diff_psc" since such specific test targets do not depend on
"build_doxygen".)

III.  The file dependencies of the "build_doxygen" target have been
much improved so that any source code changes (except for the rare
case of a developer making changes to run-time generated source code
prerequisites) insure the doxygen documentation is rebuilt when you
run the "build_doxygen" target.  The target dependencies of the
"build_doxygen" target now include some selected PLplot library
builds. This improvement insures source code generated by those
library builds is available before the doxygen run is started.

One interesting result of running the "build_doxygen" target is that
virtually all the remaining warnings are associated with the wxwidgets
device driver.  It should be worthwhile for you to look at those
warnings in detail just in case they result from a subtle bug in the
code for the wxwidgets driver or even if they result from some
uncommon C++ programming style for the wxwidgets driver code that
doxygen is having trouble understanding.

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
__________________________

------------------------------------------------------------------------------
Colocation vs. Managed Hosting
A question and answer guide to determining the best fit
for your organization - today and in the future.
http://p.sf.net/sfu/internap-sfd2d
_______________________________________________
Plplot-devel mailing list
Plplot-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/plplot-devel

Reply via email to