Mercurial > octave-nkf

comparison scripts/help/get_first_help_sentence.m @ 10793:be55736a0783

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents 1bf0ce0930be
children 2c356a35d7f5
comparison
equal deleted inserted replaced
10792:91342260063e 10793:be55736a0783
19 ## Return the first sentence of a function help text. 19 ## Return the first sentence of a function help text.
20 ## 20 ##
21 ## The function reads the first sentence of the help text of the function 21 ## The function reads the first sentence of the help text of the function
22 ## @var{name}. The first sentence is defined as the text after the function 22 ## @var{name}. The first sentence is defined as the text after the function
23 ## declaration until either the first period (".") or the first appearance of 23 ## declaration until either the first period (".") or the first appearance of
24 ## two consecutive end-lines ("\n\n"). The text is truncated to a maximum length 24 ## two consecutive end-lines ("\n\n"). The text is truncated to a maximum
25 ## length
25 ## of @var{max_len}, which defaults to 80. 26 ## of @var{max_len}, which defaults to 80.
26 ## 27 ##
27 ## The optional output argument @var{status} returns the status reported by 28 ## The optional output argument @var{status} returns the status reported by
28 ## @code{makeinfo}. If only one output argument is requested, and @var{status} 29 ## @code{makeinfo}. If only one output argument is requested, and @var{status}
29 ## is non-zero, a warning is displayed. 30 ## is non-zero, a warning is displayed.