Mercurial > octave-antonio

comparison build-aux/mk-opts.pl @ 20163:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 21:52:42 -0700
parents 4197fc428c7d
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
230 $STATIC_OBJECT_NAME = "${FCN_NAME}_opts"; 230 $STATIC_OBJECT_NAME = "${FCN_NAME}_opts";
231 231
232 if (not defined $DOC_STRING) 232 if (not defined $DOC_STRING)
233 { 233 {
234 $DOC_STRING = "Query or set options for the function \@code{$FCN_NAME}.\\n\\ 234 $DOC_STRING = "Query or set options for the function \@code{$FCN_NAME}.\\n\\
235 \\n\\
235 When called with no arguments, the names of all available options and\\n\\ 236 When called with no arguments, the names of all available options and\\n\\
236 their current values are displayed.\\n\\ 237 their current values are displayed.\\n\\
237 Given one argument, return the value of the corresponding option.\\n\\ 238 \\n\\
238 When called with two arguments, \@code{$OPT_FCN_NAME} set the option\\n\\ 239 Given one argument, return the value of the option \@var{opt}.\\n\\
240 \\n\\
241 When called with two arguments, \@code{$OPT_FCN_NAME} sets the option\\n\\
239 \@var{opt} to value \@var{val}."; 242 \@var{opt} to value \@var{val}.";
240 } 243 }
241 } 244 }
242 245
243 ## FIXME: What does this routine do? And can it be simpler to understand? 246 ## FIXME: What does this routine do? And can it be simpler to understand?