Mercurial > octave
changeset 24551:a7b6502b5cb5
doc: Add @ref from graphic object creation functions to list of graphic properties (bug #52816).
* uimenu.m, image.m, text.m, light.m, line.m, patch.m, surface.m, axes.m,
figure.m: Add @ref from graphic object creation functions to list of graphic
properties (bug #52816).
author | Rik <rik@octave.org> |
---|---|
date | Sun, 07 Jan 2018 21:11:39 -0800 |
parents | 966c3283a164 |
children | 48830eeb348b |
files | scripts/gui/uimenu.m scripts/image/image.m scripts/plot/appearance/text.m scripts/plot/draw/light.m scripts/plot/draw/line.m scripts/plot/draw/patch.m scripts/plot/draw/surface.m scripts/plot/util/axes.m scripts/plot/util/figure.m |
diffstat | 9 files changed, 27 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/gui/uimenu.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/gui/uimenu.m Sun Jan 07 21:11:39 2018 -0800 @@ -62,6 +62,9 @@ ## ## @end table ## +## The full list of properties is documented at +## @ref{Uimenu Properties,,Uimenu Properties}. +## ## Examples: ## ## @example
--- a/scripts/image/image.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/image/image.m Sun Jan 07 21:11:39 2018 -0800 @@ -53,6 +53,9 @@ ## and axes. When the only inputs to @code{image} are property/value pairs ## the Low-Level form is used which creates a new instance of an image object ## and inserts it in the current axes. +## +## Graphic Properties: The full list of properties is documented at +## @ref{Image Properties,,Image Properties}. ## @seealso{imshow, imagesc, colormap} ## @end deftypefn
--- a/scripts/plot/appearance/text.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/plot/appearance/text.m Sun Jan 07 21:11:39 2018 -0800 @@ -33,6 +33,9 @@ ## ## The optional return value @var{h} is a vector of graphics handles to the ## created text objects. +## +## Programming Note: The full list of properties is documented at +## @ref{Text Properties,,Text Properties}. ## @seealso{gtext, title, xlabel, ylabel, zlabel} ## @end deftypefn
--- a/scripts/plot/draw/light.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/plot/draw/light.m Sun Jan 07 21:11:39 2018 -0800 @@ -59,6 +59,8 @@ ## The optional return value @var{h} is a graphics handle to the created light ## object. ## +## Programming Note: The full list of properties is documented at +## @ref{Light Properties,,Light Properties}. ## @seealso{lighting, material, patch, surface} ## @end deftypefn
--- a/scripts/plot/draw/line.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/plot/draw/line.m Sun Jan 07 21:11:39 2018 -0800 @@ -37,6 +37,8 @@ ## The optional return value @var{h} is a graphics handle (or vector of ## handles) to the line objects created. ## +## Programming Note: The full list of properties is documented at +## @ref{Line Properties,,Line Properties}. ## @seealso{image, patch, rectangle, surface, text} ## @end deftypefn
--- a/scripts/plot/draw/patch.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/plot/draw/patch.m Sun Jan 07 21:11:39 2018 -0800 @@ -64,11 +64,10 @@ ## The optional return value @var{h} is a graphics handle to the created patch ## object. ## -## Implementation Note: Patches are highly configurable objects. To truly -## customize them requires setting patch properties directly -## (@pxref{Patch Properties}). Useful patch properties include: @qcode{"cdata"}, -## @qcode{"edgecolor"}, @qcode{"facecolor"}, @qcode{"faces"}, -## @qcode{"facevertexcdata"}. +## Programming Note: The full list of properties is documented at +## @ref{Patch Properties,,Patch Properties}. Useful patch properties include: +## @qcode{"cdata"}, @qcode{"edgecolor"}, @qcode{"facecolor"}, @qcode{"faces"}, +## and @qcode{"facevertexcdata"}. ## @seealso{fill, get, set} ## @end deftypefn
--- a/scripts/plot/draw/surface.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/plot/draw/surface.m Sun Jan 07 21:11:39 2018 -0800 @@ -35,14 +35,16 @@ ## taken to be @code{1:columns (@var{z})} and @var{y} is ## @code{1:rows (@var{z})}. ## -## Any property/value input pairs are assigned to the surface object -## (@pxref{Surface Properties}). +## Any property/value input pairs are assigned to the surface object. ## ## If the first argument @var{hax} is an axes handle, then plot into this axes, ## rather than the current axes returned by @code{gca}. ## ## The optional return value @var{h} is a graphics handle to the created ## surface object. +## +## Programming Note: The full list of properties is documented at +## @ref{Surface Properties,,Surface Properties}. ## @seealso{surf, mesh, patch, line} ## @end deftypefn
--- a/scripts/plot/util/axes.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/plot/util/axes.m Sun Jan 07 21:11:39 2018 -0800 @@ -25,8 +25,7 @@ ## axes to @var{hax}. ## ## Called without any arguments, or with @var{property}/@var{value} pairs, -## construct a new axes. For accepted properties and corresponding values, -## @pxref{XREFset,,set}. +## construct a new axes. ## ## Called with a single axes handle argument @var{hax}, the function makes ## @var{hax} the current axes (as returned by @code{gca}). It also makes @@ -37,6 +36,8 @@ ## objects (Z-order stacking). In addition it restacks any legend or colorbar ## objects associated with @var{hax} so that they are also visible. ## +## Programming Note: The full list of properties is documented at +## @ref{Axes Properties,,Axes Properties}. ## @seealso{gca, set, get} ## @end deftypefn
--- a/scripts/plot/util/figure.m Sun Jan 07 20:19:51 2018 -0800 +++ b/scripts/plot/util/figure.m Sun Jan 07 21:11:39 2018 -0800 @@ -36,6 +36,9 @@ ## ## The optional return value @var{h} is a graphics handle to the created figure ## object. +## +## Programming Note: The full list of properties is documented at +## @ref{Figure Properties,,Figure Properties}. ## @seealso{axes, gcf, clf, close} ## @end deftypefn