I have moved this to the more appropriate list. Sorry, Jerry, it took us so long to respond to your comments about problems with our documentation.
On 2006-07-07 17:05-0700 Jerry wrote: [...] > The following subprograms in the Common API had output scalars which > required special attention to make sure that Ada understands that > some arguments are output scalars and not pointers to arrays. I've > included a few notes that may be of interest to the documentation > writers and to the Modula-3 binding writer. Please note that I have > used 5.5.3 for plplot.h and 5.6.1 for the API documentation. Also, > note that not all routines which return results begin with "plg". > plgcol0 API reference says this is 8 bits but plplot.h says integer Actually the PLINT * types of the arguments are all identified correctly in the documentation. The 8-bit comment simply means legitimate values are in the range from 0-255. > plgcolbg API reference says this is 8 bits but plplot.h says integer Same comment. > plgriddata API description of parameter "type" is incomplete. Seems OK to me now. Perhaps there has been a change? > plrgbhls API description reverses "input" and "output". Fixed. > > Other Notes: > > plexit is listed in the API reference but does not appear in > plplot.h. Specifically, it is listed in the special C API chapter, not the common API chapter, and it is declared in our "private" API header, plplotP.h. If plexit is generally useful to external programmers I suppose we could move it to plplot.h. Any PLplot C library expert here have an opinion on this? > plsdev In API description, the parameter is marked as output but is > input. Fixed. > plsetopt Ditto both args Fixed. > (Note: [plsetopt] not part of common API) It is for the current version of PLplot. In sum, Jerry, thanks for your notes of things you spotted in our API documentation (controlled by the file api.xml). While looking into this, I also found and fixed a number of other typographical errors. For all the changes, see the patch of my commit posted to plplot-cvs. I also made a change so that "make validate" in the build-tree doc/docbook/src directory would always conveniently run the docbook validation rule. (My above changes pass this "make validate" test.) 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 Yorick front-end to PLplot (yplot.sf.net); the Loads of Linux Links project (loll.sf.net); and the Linux Brochure Project (lbproject.sf.net). __________________________ Linux-powered Science __________________________ ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys-and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV _______________________________________________ Plplot-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/plplot-devel
