octave-maintainers
[Top][All Lists]
Advanced

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

Re: Patch proposal for axes.m


From: Michael Goffioul
Subject: Re: Patch proposal for axes.m
Date: Thu, 30 Aug 2007 11:06:40 +0200

Thanks. I commited it to CVS (of octave-forge).

Michael.


On 8/30/07, David Bateman <address@hidden> wrote:
> Hey this is an easy one as there are no equations or examples.. Try the
> string
>
> ## -*- texinfo -*-
> ## @deftypefn {Function File} address@hidden =} ancestor (@var{h},
> @var{type})
> ## @deftypefnx {Function File} address@hidden =} ancestor (@var{h},
> @var{type}, 'toplevel')
> ## Returns the first ancestor of handle object @var{h} whose type matches
> ## @var{type}, where @var{type} is a character string. If @var{type} is a
> ## cell array of strings, the first parent whose type matches any of the
> ## given type strings is returned.
> ##
> ## If the handle object @var{h} is of type @var{type}, @var{h} is returned.
> ##
> ## If 'toplevel' is given as a 3rd argument, @code{ancestor} returns the
> ## highest parent in the object hierarchy that matches the condition,
> instead
> ## of the first (nearest) one.
> ## @seealso{get, set}
> ## @end deftypefn
>
> BTW, the appendix C "Tips and Standards" in the sub-section "Tips for
> Documentation" has some hints on how to write texinfo help strings...
>
> Cheers
> David
>
>
>
> Cheers
> David
>
>
> >
>
>


reply via email to

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