Mercurial > hg > octave-shane
changeset 16808:772f51539af8
doc: Add gco() to documentation.
* doc/interpreter/plot.txi: Add gco() to manual.
* scripts/plot/gco.m: Add seealso links to docstring.
* scripts/plot/gcbf.m: Re-arrange seealso links. Improve docstring.
* scripts/plot/gcbo.m: Rewrite second paragraph of docstring.
Add seealso link to gco.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 22 Jun 2013 11:16:04 -0700 |
| parents | 2fd22fbaffa3 |
| children | 84505f200e05 |
| files | doc/interpreter/plot.txi scripts/plot/gcbf.m scripts/plot/gcbo.m scripts/plot/gco.m |
| diffstat | 4 files changed, 9 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -1096,6 +1096,8 @@ @DOCSTRING(gca) +@DOCSTRING(gco) + The @code{get} and @code{set} functions may be used to examine and set properties for graphics objects. For example,
--- a/scripts/plot/gcbf.m +++ b/scripts/plot/gcbf.m @@ -21,9 +21,9 @@ ## Return a handle to the figure containing the object whose callback ## is currently executing. If no callback is executing, this function ## returns the empty matrix. The handle returned by this function is -## the same as the second output argument of gcbo. +## the same as the second output argument of @code{gcbo}. ## -##@seealso{gcf, gca, gcbo} +##@seealso{gcbo, gcf, gca} ##@end deftypefn function fig = gcbf ()
--- a/scripts/plot/gcbo.m +++ b/scripts/plot/gcbo.m @@ -24,11 +24,11 @@ ## empty matrix. This handle is obtained from the root object property ## "CallbackObject". ## -## Additionally return the handle of the figure containing the -## object whose callback is currently executing. If no callback is -## executing, the second output is also set to the empty matrix. +## When called with a second output argument, return the handle of the figure +## containing the object whose callback is currently executing. If no callback +## is executing the second output is also set to the empty matrix. ## -##@seealso{gcf, gca, gcbf} +##@seealso{gcbf, gco, gcf, gca} ##@end deftypefn function [h, fig] = gcbo ()