Mercurial > octave
changeset 26877:83774c2a1b92 stable
doc: Place cross-reference from list of graphics object properties back to object (bug #46076).
* genpropdoc.m: Place a header line above each table of graphics object
properties with a cross-reference to the function call that creates the object
* plot.txi: Remove header line above each @include of graphics object
properties.
* uibuttongroup.m, uicontextmenu.m, uicontrol.m, uimenu.m, uipanel.m,
uipushtool.m, uitable.m, uitoggletool.m, uitoolbar.m: Use common phrasing in
docstring for the cross-reference to the table of graphics object properties.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 11 Mar 2019 11:15:24 -0700 |
| parents | b4a9888bb3c9 |
| children | 3c7c5b7c3044 |
| files | doc/interpreter/genpropdoc.m doc/interpreter/plot.txi scripts/gui/uibuttongroup.m scripts/gui/uicontextmenu.m scripts/gui/uicontrol.m scripts/gui/uimenu.m scripts/gui/uipanel.m scripts/gui/uipushtool.m scripts/gui/uitable.m scripts/gui/uitoggletool.m scripts/gui/uitoolbar.m |
| diffstat | 11 files changed, 18 insertions(+), 51 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/genpropdoc.m Wed Mar 06 12:41:14 2019 -0800 +++ b/doc/interpreter/genpropdoc.m Mon Mar 11 11:15:24 2019 -0700 @@ -1906,8 +1906,15 @@ fields = sort (fieldnames (obj)); nf = numel (fields); - ## File header and begining of properties table - str = [warn_autogen() "\n\n@table @asis"]; + ## File header and beginning of properties table + str = warn_autogen (); + if (strcmp (objname, "root")) + str = sprintf ("%s\n\nProperties of the root graphics object:", str); + else + str = sprintf ("%s\n\nProperties of @code{%s} objects (@pxref{XREF%s,,%s}):", + str, objname, objname, objname); + endif + str = sprintf ("%s\n\n@table @asis", str); for ii = 1:nf field = fields{ii};
--- a/doc/interpreter/plot.txi Wed Mar 06 12:41:14 2019 -0800 +++ b/doc/interpreter/plot.txi Mon Mar 11 11:15:24 2019 -0700 @@ -1508,8 +1508,6 @@ @subsubsection Root Figure Properties @prindex @sortas{@ Root Figure Properties} Root Figure Properties -The @code{root figure} properties are: - @include plot-rootproperties.texi @@ -1517,8 +1515,6 @@ @subsubsection Figure Properties @prindex @sortas{@ Figure Properties} Figure Properties -The @code{figure} properties are: - @include plot-figureproperties.texi @@ -1526,8 +1522,6 @@ @subsubsection Axes Properties @prindex @sortas{@ Axes Properties} Axes Properties -The @code{axes} properties are: - @include plot-axesproperties.texi @@ -1535,8 +1529,6 @@ @subsubsection Line Properties @prindex @sortas{@ Line Properties} Line Properties -The @code{line} properties are: - @include plot-lineproperties.texi @@ -1544,8 +1536,6 @@ @subsubsection Text Properties @prindex @sortas{@ Text Properties} Text Properties -The @code{text} properties are: - @include plot-textproperties.texi @@ -1553,8 +1543,6 @@ @subsubsection Image Properties @prindex @sortas{@ Image Properties} Image Properties -The @code{image} properties are: - @include plot-imageproperties.texi @@ -1562,8 +1550,6 @@ @subsubsection Patch Properties @prindex @sortas{@ Patch Properties} Patch Properties -The @code{patch} properties are: - @include plot-patchproperties.texi @@ -1571,8 +1557,6 @@ @subsubsection Surface Properties @prindex @sortas{@ Surface Properties} Surface Properties -The @code{surface} properties are: - @include plot-surfaceproperties.texi @@ -1580,80 +1564,60 @@ @subsubsection Light Properties @prindex @sortas{@ Light Properties} Light Properties -The @code{light} properties are: - @include plot-lightproperties.texi @node Uimenu Properties @subsubsection Uimenu Properties @prindex @sortas{@ Uimenu Properties} Uimenu Properties -The @code{uimenu} properties are: - @include plot-uimenuproperties.texi @node Uibuttongroup Properties @subsubsection Uibuttongroup Properties @prindex @sortas{@ Uibuttongroup Properties} Uibuttongroup Properties -The @code{uibuttongroup} properties are: - @include plot-uibuttongroupproperties.texi @node Uicontextmenu Properties @subsubsection Uicontextmenu Properties @prindex @sortas{@ Uicontextmenu Properties} Uicontextmenu Properties -The @code{uicontextmenu} properties are: - @include plot-uicontextmenuproperties.texi @node Uipanel Properties @subsubsection Uipanel Properties @prindex @sortas{@ Uipanel Properties} Uipanel Properties -The @code{uipanel} properties are: - @include plot-uipanelproperties.texi @node Uicontrol Properties @subsubsection Uicontrol Properties @prindex @sortas{@ Uicontrol Properties} Uicontrol Properties -The @code{uicontrol} properties are: - @include plot-uicontrolproperties.texi @node Uitable Properties @subsubsection Uitable Properties @cindex uitable properties -The @code{uitable} properties are: - @include plot-uitableproperties.texi @node Uitoolbar Properties @subsubsection Uitoolbar Properties @prindex @sortas{@ Uitoolbar Properties} Uitoolbar Properties -The @code{uitoolbar} properties are: - @include plot-uitoolbarproperties.texi @node Uipushtool Properties @subsubsection Uipushtool Properties @prindex @sortas{@ Uipushtool Properties} Uipushtool Properties -The @code{uipushtool} properties are: - @include plot-uipushtoolproperties.texi @node Uitoggletool Properties @subsubsection Uitoggletool Properties @prindex @sortas{@ Uitoggletool Properties} Uitoggletool Properties -The @code{uitoggletool} properties are: - @include plot-uitoggletoolproperties.texi @node Searching Properties
--- a/scripts/gui/uibuttongroup.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uibuttongroup.m Mon Mar 11 11:15:24 2019 -0700 @@ -34,8 +34,7 @@ ## Any provided property value pairs will override the default values of the ## created uibuttongroup object. ## -## Properties of uibuttongroup objects are documented at -## @ref{Uibuttongroup Properties}. +## The full list of properties is documented at @ref{Uibuttongroup Properties}. ## ## Examples: ##
--- a/scripts/gui/uicontextmenu.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uicontextmenu.m Mon Mar 11 11:15:24 2019 -0700 @@ -30,7 +30,7 @@ ## Any provided property value pairs will override the default values of the ## created uicontextmenu object. ## -## Uicontextmenu properties are documented at @ref{Uicontextmenu Properties}. +## The full list of properties is documented at @ref{Uicontextmenu Properties}. ## ## Examples: ##
--- a/scripts/gui/uicontrol.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uicontrol.m Mon Mar 11 11:15:24 2019 -0700 @@ -35,8 +35,7 @@ ## Any provided property value pairs will override the default values of the ## created uicontrol object. ## -## Properties of uicontrol objects are documented at -## @ref{Uicontrol Properties}. +## The full list of properties is documented at @ref{Uicontrol Properties}. ## ## The type of uicontrol created is specified by the @var{style} property. If ## no style property is provided, a push button will be created.
--- a/scripts/gui/uimenu.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uimenu.m Mon Mar 11 11:15:24 2019 -0700 @@ -62,8 +62,7 @@ ## ## @end table ## -## The full list of properties is documented at -## @ref{Uimenu Properties,,Uimenu Properties}. +## The full list of properties is documented at @ref{Uimenu Properties}. ## ## Examples: ##
--- a/scripts/gui/uipanel.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uipanel.m Mon Mar 11 11:15:24 2019 -0700 @@ -33,7 +33,7 @@ ## Any provided property value pairs will override the default values of the ## created uipanel object. ## -## Uipanel properties are documented at @ref{Uipanel Properties}. +## The full list of properties is documented at @ref{Uipanel Properties}. ## ## The optional return value @var{hui} is a graphics handle to the created ## uipanel object.
--- a/scripts/gui/uipushtool.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uipushtool.m Mon Mar 11 11:15:24 2019 -0700 @@ -38,7 +38,7 @@ ## Any provided property value pairs will override the default values of the ## created uipushtool object. ## -## Uipushtool properties are documented at @ref{Uipushtool Properties}. +## The full list of properties is documented at @ref{Uipushtool Properties}. ## ## The optional return value @var{hui} is a graphics handle to the created ## uipushtool object.
--- a/scripts/gui/uitable.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uitable.m Mon Mar 11 11:15:24 2019 -0700 @@ -32,8 +32,7 @@ ## Any provided property value pairs will override the default values of the ## created uitable object. ## -## Properties of uitable objects are documented at -## @ref{Uitable Properties}. +## The full list of properties is documented at @ref{Uitable Properties}. ## ## Examples: ##
--- a/scripts/gui/uitoggletool.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uitoggletool.m Mon Mar 11 11:15:24 2019 -0700 @@ -38,7 +38,7 @@ ## Any provided property value pairs will override the default values of the ## created uitoggletool object. ## -## Uitoggletool properties are documented at @ref{Uitoggletool Properties}. +## The full list of properties is documented at @ref{Uitoggletool Properties}. ## ## The optional return value @var{hui} is a graphics handle to the created ## uitoggletool object.
--- a/scripts/gui/uitoolbar.m Wed Mar 06 12:41:14 2019 -0800 +++ b/scripts/gui/uitoolbar.m Mon Mar 11 11:15:24 2019 -0700 @@ -33,7 +33,7 @@ ## Any provided property value pairs will override the default values of the ## created uitoolbar object. ## -## Uitoolbar properties are documented at @ref{Uitoolbar Properties}. +## The full list of properties is documented at @ref{Uitoolbar Properties}. ## ## The optional return value @var{hui} is a graphics handle to the created ## uitoolbar object.