Re: 2.1.33 changelogs/cells

[John W. Eaton]

On 22-Feb-2001, Gabor Zoltan Csejtey <address@hidden> wrote:

| Question:  how to put this function into the octave info file?

Since the function definition

| DEFUN (cellget, args, ,
|   "-*- texinfo -*-\n\
| @deftypefn {Built-in Function} {} cellget (@var{cell}, @var{i}, @var{j})\n\
| Return the @var{i,j}-th element of @var{cell}.\n\
| @end deftypefn")

has a doc string, it will be available in the on-line help if the
function is available to Octave.

To add it to the Octave manual, you need to modify one of the .txi
files (the section on Cell Arrays in container.txi is the likely
place) and add a line like

  @DOCSTRING(cellget)

in an appropriate place, then rebuild the documentation from the
sources (this is done automatically as part of building Octave).

BTW, Texinfo formatting is not required for the on-line help to work,
but it is needed for proper formatting of the doc string of any
function that will be documented in the Octave manual.

jwe



-------------------------------------------------------------
Octave is freely available under the terms of the GNU GPL.

Octave's home on the web:  http://www.octave.org
How to fund new projects:  http://www.octave.org/funding.html
Subscription information:  http://www.octave.org/archive.html
-------------------------------------------------------------