Re: [Plplot-devel] Improvement in API documentation

[Alan W. I. <ir...@be...>]

That is an interesting list Joao.  I have divided them into two groups:

(1) Does not appear in plplot.h.  I assume these are all internal
to plplot_octave.

plplot_octave_txt/plclabel_format.txt not found, using plplot.doc
plplot_octave_txt/plclabel_param.txt not found, using plplot.doc
plplot_octave_txt/plcont0.txt not found, using plplot.doc
plplot_octave_txt/plcont1.txt not found, using plplot.doc
plplot_octave_txt/plcont2.txt not found, using plplot.doc
plplot_octave_txt/plcont2p.txt not found, using plplot.doc
plplot_octave_txt/pplimage.txt not found, using plplot.doc
plplot_octave_txt/plshade2.txt not found, using plplot.doc


(2) Does appear in plplot.h, but not with a "c_" prefix.  So these are all
public API, but not common API.

Of course it is a judgement call which subset of the public API is the
common API, i.e, that part of the public API that is considered to be useful
enough so that all front ends should have wrappers for the common API. In
future we may take certain functions out of the common API or put certain
functions into the common API.  For example, plarrows below is a possible
candidate for being put into the common API.

BTW, the chapter where we document C specific public API that is not part of
the common API is called api-c.xml. It is totally incomplete because I have
been concentrating on the common API chapter, api.xml.

Another complication is just because a front end should have wrappers for
all the common API doesn't mean it does at the moment.  For example,
Geoffrey is still working on the Java wrappers, and there are still a few
common API functions I need to add to both the tcl and python wrappers.  If
anybody cares to extend the fortran and C++ examples to be the same as the
C, python, tcl, and Java examples, I am sure they will find plenty of common
API that needs wrappers for fortran and C++.  Octave is an exception to this
rule of missing common API.  Apparently you have implemented not only wrappers
for the common API, but also parts of the public API that are not common.

Here is the public API list that you wrap, but which is not part of the
common API.

plplot_octave_txt/plGetCursor.txt not found, using plplot.doc
plplot_octave_txt/plTranslateCursor.txt not found, using plplot.doc
plplot_octave_txt/plClearOpts.txt not found, using plplot.doc
plplot_octave_txt/plGetFlt.txt not found, using plplot.doc
plplot_octave_txt/plGetInt.txt not found, using plplot.doc
plplot_octave_txt/plHLS_RGB.txt not found, using plplot.doc
plplot_octave_txt/plOptUsage.txt not found, using plplot.doc
plplot_octave_txt/plParseOpts.txt not found, using plplot.doc
plplot_octave_txt/plRGB_HLS.txt not found, using plplot.doc
plplot_octave_txt/plResetOpts.txt not found, using plplot.doc
plplot_octave_txt/plSetOpt.txt not found, using plplot.doc
plplot_octave_txt/plSetUsage.txt not found, using plplot.doc
plplot_octave_txt/plarrows.txt not found, using plplot.doc
plplot_octave_txt/pldid2pc.txt not found, using plplot.doc
plplot_octave_txt/pldip2dc.txt not found, using plplot.doc
plplot_octave_txt/plsError.txt not found, using plplot.doc
plplot_octave_txt/plsxwin.txt not found, using plplot.doc

Alan