changeset 11973:73112b913bc2 octave-forge

Fixed documentation to work with TexInfo 5.
author asnelt
date Mon, 29 Jul 2013 12:08:24 +0000
parents e4891ec16dc4
children 1971e89bb816
files main/statistics/inst/dendogram.m main/statistics/inst/hist3.m
diffstat 2 files changed, 24 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/main/statistics/inst/dendogram.m	Mon Jul 29 07:42:55 2013 +0000
+++ b/main/statistics/inst/dendogram.m	Mon Jul 29 12:08:24 2013 +0000
@@ -17,20 +17,24 @@
 %% @deftypefn {Function File} {@var{p} = } dendogram (@var{tree})
 %% Plots a dendogram using the output of function @command{linkage}.
 %%
-%% @deftypefnx {Function File} {@var{p, t} = } dendogram (@var{tree})
+%% @end deftypefn
+%%
+%% @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.
 %%
-%% @deftypefnx {Function File} {@var{p, t, perm} = } dendogram (@var{tree})
+%% @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.
 %%
-%% TODO: Return handle to lines to set properties
-%% TODO: Rescale the plot automatically base don data.
-%%
 %% @seealso{linkage}
 %% @end deftypefn
+%%
+%% TODO: Return handle to lines to set properties
+%% TODO: Rescale the plot automatically based on data.
 
 function [p, t, perm] = dendogram (tree)
 
--- a/main/statistics/inst/hist3.m	Mon Jul 29 07:42:55 2013 +0000
+++ b/main/statistics/inst/hist3.m	Mon Jul 29 12:08:24 2013 +0000
@@ -22,27 +22,37 @@
 ## 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
 ##
-## @deftypefnx {Function File} hist3(@var{X}, @var{nbins})
+## @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.
 ##
-## @deftypefnx {Function File} hist3(@var{X}, @var{centers})
+## @end deftypefn
+##
+## @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.
 ##
-## @deftypefnx {Function File} hist3(@var{X}, 'Edges', @var{edges})
+## @end deftypefn
+##
+## @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.
 ##
-## @deftypefnx {Function File} {@var{N} =} hist3(@var{X}, ...)
+## @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
 ## histogram
 ##
-## @deftypefnx {Function File} {[@var{N}, @var{C}] =} hist3(@var{X}, ...)
+## @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
 ##