Documentation patch

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Documentation patch

Bill Denney
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).

Changelog:

2005-06-15  Bill Denney  <[hidden email]>

    * src/help.cc: added more documentation.

Bill

--
"To steal ideas from one person is plagiarism; to steal from many is
research."
   -- Steven Wright

help-doc-patch (9K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Documentation patch

John W. Eaton-6
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

Reply | Threaded
Open this post in threaded view
|

Re: Documentation patch

Bill Denney
On Wed, 15 Jun 2005, John W. Eaton wrote:

> Thanks for taking a look at this.
>
> Probably all of these should use Texinfo markup.  For keywords,
> perhaps we should use

OK, I didn't see any texinfo in there, so I didn't know if these may have
been special and not able to do texinfo.  I meant to ask about that.  I'll
try to do this soon.

Bill

--
"I intend to live forever -- so far, so good." -- Steven Wright

Reply | Threaded
Open this post in threaded view
|

Re: Documentation patch

Bill Denney
In reply to this post by John W. Eaton-6
On Wed, 15 Jun 2005, John W. Eaton wrote:

> Thanks for taking a look at this.
>
> Probably all of these should use Texinfo markup.

OK, I've added these.  I didn't know what some of the functions did, so I
just added a bit of texinfo and left them pretty much as is.  I also did
the operators with a @deffn Operator.

> |    { "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.

I clipped 'em out.  I wasn't sure what to do with gsplot, but I left it
in.

Bill

--
"I don't see how anyone could ever fall in love.  People are jerks"
   -- Calvin (of Calvin and Hobbes)

help-doc-patch (24K) Download Attachment