changeset 12644:0ddee23d3d82 octave-forge

Further documentation fixes.
author michelemartone
date Sun, 21 Jun 2015 14:45:08 +0000
parents dc5803650a98
children d8fd8eb07c8f
files main/sparsersb/doc/sparsersb.txt main/sparsersb/src/sparsersb.cc
diffstat 2 files changed, 11 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/main/sparsersb/doc/sparsersb.txt	Sun Jun 21 14:37:10 2015 +0000
+++ b/main/sparsersb/doc/sparsersb.txt	Sun Jun 21 14:45:08 2015 +0000
@@ -5,8 +5,8 @@
  -- Loadable Function: S = sparsersb (I, J, SV)
  -- Loadable Function: S = sparsersb (M, N)
  -- Loadable Function: S = sparsersb (I, J, S, M, N, "unique")
- -- Loadable Function: S = sparsersb ("set", OPN, OPV)
- -- Loadable Function: S = sparsersb (A, "get", MIF)
+ -- Loadable Function: sparsersb ("set", OPN, OPV)
+ -- Loadable Function: V = sparsersb (A, "get", MIF)
  -- Loadable Function: S = sparsersb (A, QS)
  -- Loadable Function: sparsersb (A,"save",MTXFILENAME)
  -- Loadable Function: [S, NROWS, NCOLS, NNZ, REPINFO, FIELD, SYMMETRY]
@@ -67,12 +67,13 @@
 
      If MIF is a string specifying a valid librsb matrix info string
      (valid for librsb's `rsb_mtx_get_info_from_string()'), then the
-     corresponding value will be returned for matrix A. If MIF is the
-     an empty string (""), matrix structure information will be
-     returned.
+     corresponding value will be returned for matrix `A', in string
+     `V'. If MIF is the an empty string (""), matrix structure
+     information will be returned.
 
      If A is a sparsersb matrix and QS is a string, QS will be
-     interpreted as a query string about matrix A.
+     interpreted as a query string about matrix A. String `V' will be
+     returned.
 
      If A is a sparsersb matrix and the "render" keyword is specified,
      and FILENAME is a string, A will be rendered as an Encapsulated
--- a/main/sparsersb/src/sparsersb.cc	Sun Jun 21 14:37:10 2015 +0000
+++ b/main/sparsersb/src/sparsersb.cc	Sun Jun 21 14:45:08 2015 +0000
@@ -1925,8 +1925,8 @@
 @deftypefnx {Loadable Function} {@var{s} =} "RSBOI_FNS" (@var{i}, @var{j}, @var{sv})\n\
 @deftypefnx {Loadable Function} {@var{s} =} "RSBOI_FNS" (@var{m}, @var{n})\n\
 @deftypefnx {Loadable Function} {@var{s} =} "RSBOI_FNS" (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, \"unique\")\n\
-@deftypefnx {Loadable Function} {@var{s} =} "RSBOI_FNS" (\"set\", @var{opn}, @var{opv})\n\
-@deftypefnx {Loadable Function} {@var{s} =} "RSBOI_FNS" (@var{A}, \"get\", @var{mif})\n\
+@deftypefnx {Loadable Function}             "RSBOI_FNS" (\"set\", @var{opn}, @var{opv})\n\
+@deftypefnx {Loadable Function} {@var{v} =} "RSBOI_FNS" (@var{A}, \"get\", @var{mif})\n\
 @deftypefnx {Loadable Function} {@var{s} =} "RSBOI_FNS" (@var{A}, @var{QS})\n\
 @deftypefnx {Loadable Function} "RSBOI_FNS" (@var{a},\"save\",@var{mtxfilename})\n\
 @deftypefnx {Loadable Function} {[@var{s}, @var{nrows}, @var{ncols}, @var{nnz}, @var{repinfo}, @var{field}, @var{symmetry}] =} "RSBOI_FNS" (@var{mtxfilename}, @var{mtxtypestring})\n\
@@ -1991,10 +1991,10 @@
 If @var{opn} is a string representing a valid librsb option name and @var{opv} is a string representing a valid librsb option value, these will be passed to the @code{rsb_lib_set_opt_str()} function.\n\
 \n\
 \
-If @var{mif} is a string specifying a valid librsb matrix info string (valid for librsb's @code{rsb_mtx_get_info_from_string()}), then the corresponding value will be returned for matrix @var{A}. If @var{mif} is the an empty string (\"\"), matrix structure information will be returned.\n\
+If @var{mif} is a string specifying a valid librsb matrix info string (valid for librsb's @code{rsb_mtx_get_info_from_string()}), then the corresponding value will be returned for matrix @code{@var{A}}, in string @code{@var{v}}. If @var{mif} is the an empty string (\"\"), matrix structure information will be returned.\n\
 \n\
 \
-If @var{A} is a "RSBOI_FNS" matrix and @var{QS} is a string, @var{QS} will be interpreted as a query string about matrix @var{A}.\n\
+If @var{A} is a "RSBOI_FNS" matrix and @var{QS} is a string, @var{QS} will be interpreted as a query string about matrix @var{A}. String @code{@var{v}} will be returned.\n\
 \n"\
 /*If any of @var{sv}, @var{i} or @var{j} are scalars, they are expanded\n\ 
 to have a common size.\n*/