Mercurial > hg > octave-lyh

diff src/data.cc @ 8812:7d48766c21a5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use consistent format for doc strings of internal functions
author John W. Eaton <jwe@octave.org>
date Thu, 19 Feb 2009 02:16:34 -0500
parents f6dc6eb57045
children eb63fbe60fab
line wrap: on
line diff
--- a/src/data.cc
+++ b/src/data.cc
@@ -5624,14 +5624,16 @@
 
 */
 
+// Sort the rows of the matrix @var{a} according to the order
+// specified by @var{mode}, which can either be `ascend' or `descend'
+// and return the index vector corresponding to the sort order.
+//
+// This function does not yet support sparse matrices.
+
 DEFUN (__sort_rows_idx__, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Function File} {} __sort_rows_idx__ (@var{a}, @var{mode})\n\
-Sort the rows of the matrix @var{a} according to the order specified\n\
-by @var{mode}, which can either be `ascend' or `descend'.\n\
-Returns the index vector.\n\
-\n\
-This function does not yet support sparse matrices.\n\
+Undocumented internal function.\n\
 @end deftypefn\n")
 {
   octave_value retval;