[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Documentation patch
From: |
John W. Eaton |
Subject: |
Documentation patch |
Date: |
Wed, 15 Jun 2005 12:22:05 -0400 |
On 15-Jun-2005, Bill Denney wrote:
| Here is a patch adding more documentation to many of the functions in
| help.cc. I didn't know what some of the functions do, so I didn't add any
| docs for those (perhaps with the exception of some "See also"s).
Thanks for taking a look at this.
Probably all of these should use Texinfo markup. For keywords,
perhaps we should use
@deffn Keyword NAME ARGUMENTS
BODY-OF-DEFINITION
@end deffn
For example, for "if", we would have
{ "if",
"-*- texinfo -*-\n\
@deffn Keyword if (@var{cond}) @dots{} endif\n\
@deffnx Keyword if (@var{cond}) @dots{} else @dots{} endif\n\
@deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif\n\
@deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else
@dots{} endif\n\
Begin an if block.\n\
@end deffn\n\
@seealso{switch}", },
perhaps expanding on the description.
| { "all_va_args",
| { "gplot",
| { "replot",
I think these should be removed because they are obsolete. I would
not replace gplot with __gnuplot_plot__, since that is a function that
already has a doc string. Likewise, replot is now a .m file with a
doc string.
jwe