octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Graphics objects documentation


From: Pantxo Diribarne
Subject: Graphics objects documentation
Date: Thu, 25 Sep 2014 13:51:46 +0200

Hi,

The current documentation for graphics objects is sparse and inhomogeneous. M. Godfrey has already started tidying things up but, as he suggests,  it would certainly be preferable to automate the doc generation for a few reasons:
* Having properties match between doc and octave interpreter
* Homogenize the way we document default values, valid values ...
* Have (as much as possible) common descriptions for properties that are shared by all objects (e.g. type, tag, ...)

In order to make a first step I wrote an octave function that pretty much does the above mentioned tasks, plus add an @anchor for each item so that we can do cross referencing.

Now the questions are:
* Do people think that this automation process is really worth,
* Is it acceptable to do this with octave?  If so, are there examples of .txi files generated  by octave scripts somewhere in the doc (I am interested in Makefile.in rules examples)?

Pantxo

reply via email to

[Prev in Thread] Current Thread [Next in Thread]