Hi Phil: In all the excitement of moving from svn-based to git-based development, I forgot to comment on a last-minute svn commit (revision 13138 = git commit 1baadca) you made by adding some key shapelib functionality that is illustrated by another page in both the C and C++ example 19 results.
The added functions for both C and C++ and the new pages work fine on my Linux box confirming your good results on Windows so I think we can conclude there are no obvious issues with your src/plmap.c changes and the equivalent changes to the C++ bindings. Furthermore, I think that additional page for example 19 is a quite attractive addition to our examples since it illustrates a realistic and also interesting contour map result. So I am completely satisfied with what you have done so far, and if nobody else spots problems, I think it is getting close to the time when we should be propagating this new API and the new example 19 page to all other languages. To make that propagation somewhat easier, I suggest you document your shapelib work both in doxygen and docbook. The doxygen documentation is straightforward. For every routine in plmap.c, just follow the style of the doxygen comments (every comment that starts with "//!") that occur in src/pllegend.c. Note also the position of most of those comments which is just before each function that is being documented. So the one bit of doxygen comment in src/plmap.c at this time (for OpenShapeFile) is not quite in the correct position. It is currently just before the CustomErrors implementation when it should be just before the OpenShapeFile implemention. The docbook documentation is also straightforward. For the subset of the plmap.c routines that are in the public API, e.g., called directly from example 19, you should make an entry in doc/docbook/src/api.xml following what is done for other routines there such as plmeridians. For the documentation of the individual arguments of that subset of routines you can usually just copy the wording you used above in the Doxygen case. (Compare, for example, the api.xml documentation for pllegend with the doxygen documentation of the pllegend routine in src/pllegend.c.) You should also add a short section to advanced.xml concerning the map functionality for PLplot following what I did relatively recently there with the pllegend and plcolorbar new API. (See http://plplot.sourceforge.net/docbook-manual/plplot-html-5.10.0/legends.html for how that new section looks). Don't worry about testing any of these results; once your wording is committed, I can do the DocBook testing myself and make any final tweaks that might be required to get everyting to work smoothly. One final issue is you should add a paragraph describing the licensing terms for the new shapelib files to the Copyright file in the top-level directory of the source tree. 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); the Time Ephemerides project (timeephem.sf.net); PLplot scientific plotting software package (plplot.sf.net); 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 __________________________ ------------------------------------------------------------------------------ Want excitement? Manually upgrade your production database. When you want reliability, choose Perforce Perforce version control. Predictably reliable. http://pubads.g.doubleclick.net/gampad/clk?id=157508191&iu=/4140/ostg.clktrk _______________________________________________ Plplot-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/plplot-devel
