Mercurial > forge
changeset 11976:ec033a9a1c88 octave-forge
Fix documentation for TexInfo 5. Third try.
author | asnelt |
---|---|
date | Mon, 29 Jul 2013 13:16:49 +0000 |
parents | 0a4c31c0585c |
children | ef817df6442f |
files | main/statistics/inst/dendogram.m main/statistics/inst/hist3.m |
diffstat | 2 files changed, 27 insertions(+), 39 deletions(-) [+] |
line wrap: on
line diff
--- a/main/statistics/inst/dendogram.m Mon Jul 29 12:51:20 2013 +0000 +++ b/main/statistics/inst/dendogram.m Mon Jul 29 13:16:49 2013 +0000 @@ -15,20 +15,15 @@ %% -*- texinfo -*- %% @deftypefn {Function File} {@var{p} = } dendogram (@var{tree}) +%% @deftypefnx {Function File} {@var{p, t} = } dendogram (@var{tree}) +%% @deftypefnx {Function File} {@var{p, t, perm} = } dendogram (@var{tree}) %% Plots a dendogram using the output of function @command{linkage}. %% -%% @end deftypefn +%% t is a vector containing the leaf node number for each object in the +%% original dataset. For now, all objects are leaf nodes. %% -%% @deftypefn {Function File} {@var{p, t} = } dendogram (@var{tree}) -%% Plots the dendrogram and returns a vector t of containing the leaf -%% node number for each object in the original dataset. For now, all -%% objects are leaf nodes. -%% -%% @end deftypefn -%% -%% @deftypefn {Function File} {@var{p, t, perm} = } dendogram (@var{tree}) -%% Plots the dendrogram, and returns the permutation of the input objects -%% used to display the dendrogram, in left-to-right order. +%% perm is the permutation of the input objects used to display the +%% dendrogram, in left-to-right order. %% %% TODO: Return handle to lines to set properties %% TODO: Rescale the plot automatically based on data.
--- a/main/statistics/inst/hist3.m Mon Jul 29 12:51:20 2013 +0000 +++ b/main/statistics/inst/hist3.m Mon Jul 29 13:16:49 2013 +0000 @@ -19,42 +19,35 @@ ## -*- texinfo -*- ## @deftypefn {Function File} hist3(@var{X}) +## @deftypefns {Function File} hist3(@var{X}, @var{nbins}) +## @deftypefnx {Function File} hist3(@var{X}, 'Nbins', @var{nbins}) +## @deftypefnx {Function File} hist3(@var{X}, @var{centers}) +## @deftypefnx {Function File} hist3(@var{X}, 'Centers', @var{centers}) +## @deftypefnx {Function File} hist3(@var{X}, 'Edges', @var{edges}) +## @deftypefnx {Function File} {@var{N} =} hist3(@var{X}, ...) +## @deftypefnx {Function File} {[@var{N}, @var{C}] =} hist3(@var{X}, ...) ## Plots a 2D histogram of the N x 2 matrix @var{X} with 10 equally spaced ## bins in both the x and y direction using the @code{mesh} function ## -## @end deftypefn -## -## @deftypefn {Function File} hist3(@var{X}, @var{nbins}) -## @deftypefnx {Function File} hist3(@var{X}, 'Nbins', @var{nbins}) -## Use @var{nbins} equally spaced bins to compute histogram. If @var{nbins} is -## a 2 element vector, use the two values as the number of bins in the x and y -## axis, respectively, otherwise, use the same value for each. -## -## @end deftypefn +## The number of equally spaced bins to compute histogram can be specified with +## @var{nbins}. If @var{nbins} is a 2 element vector, use the two values as the +## number of bins in the x and y axis, respectively, otherwise, use the same +## value for each. ## -## @deftypefn {Function File} hist3(@var{X}, @var{centers}) -## @deftypefnx {Function File} hist3(@var{X}, 'Centers', @var{centers}) -## Specify the centers of the histogram bins. @var{centers} should be a cell -## array containing two arrays of the bin centers on the x and y axis, -## respectively. -## -## @end deftypefn +## The centers of the histogram bins can be specified with @var{centers}. +## @var{centers} should be a cell array containing two arrays of the bin +## centers on the x and y axis, respectively. ## -## @deftypefn {Function File} hist3(@var{X}, 'Edges', @var{edges}) -## Specify the edges of the histogram bins. @var{edges} should be a cell array -## containing two arrays of the bin edges on the x and y axis, respectively. +## The edges of the histogram bins can be specified with @var{edges}. +## @var{edges} should be a cell array containing two arrays of the bin edges +## on the x and y axis, respectively. ## -## @end deftypefn -## -## @deftypefn {Function File} {@var{N} =} hist3(@var{X}, ...) -## returns the 2D array of bin counts in @var{N}, and does not plot the +## @var{N} returns the 2D array of bin counts, and does not plot the ## histogram ## -## @end deftypefn -## -## @deftypefn {Function File} {[@var{N}, @var{C}] =} hist3(@var{X}, ...) -## returns the 2D array of bin counts in @var{N} and the bin centers in the -## 2 element cell array @var{C}, and does not plot the histogram +## @var{N} and @var{C} returns the 2D array of bin counts in @var{N} and the +## bin centers in the 2 element cell array @var{C}, and does not plot the +## histogram ## ## @seealso{hist, mesh} ## @end deftypefn