Mercurial > octave-dspies

comparison doc/interpreter/external.txi @ 17097:e7a059a9a644

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Correctly use @xref, @pxref, @ref macros in documentation. * doc/interpreter/arith.txi, doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/debug.txi, doc/interpreter/diagperm.txi, doc/interpreter/eval.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/intro.txi, doc/interpreter/java.txi, doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl, doc/interpreter/numbers.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/sparse.txi, doc/interpreter/stats.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/var.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/error.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/regexp.cc, scripts/general/accumarray.m, scripts/general/structfun.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/setfield.m, scripts/miscellaneous/warning_ids.m, scripts/optimization/fminbnd.m, scripts/optimization/fzero.m, scripts/optimization/lsqnonneg.m: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Correctly use @xref, @pxref, @ref macros in documentation. * scripts/plot/line.m: Remove extra ')' in @deftypefn. * libgui/src/qtinfo/parser.cc(find_ref): Change doc anchor search pattern to XREF.
author Rik <rik@octave.org>
date Sat, 27 Jul 2013 10:49:21 -0700
parents be41c30bcb44
children f2a8592b8fbd
comparison
equal deleted inserted replaced
17096:33037eddecd2 17097:e7a059a9a644
1199 @node Documentation and Test of Oct-Files 1199 @node Documentation and Test of Oct-Files
1200 @subsection Documentation and Test of Oct-Files 1200 @subsection Documentation and Test of Oct-Files
1201 1201
1202 The documentation of an oct-file is the fourth string parameter of the 1202 The documentation of an oct-file is the fourth string parameter of the
1203 @w{@code{DEFUN_DLD}} macro. This string can be formatted in the same manner 1203 @w{@code{DEFUN_DLD}} macro. This string can be formatted in the same manner
1204 as the help strings for user functions (@ref{Documentation Tips}), 1204 as the help strings for user functions (@pxref{Documentation Tips}),
1205 however there are some issue that are particular to the formatting of 1205 however there are some issue that are particular to the formatting of
1206 help strings within oct-files. 1206 help strings within oct-files.
1207 1207
1208 The major issue is that the help string will typically be longer than a 1208 The major issue is that the help string will typically be longer than a
1209 single line of text, and so the formatting of long help strings needs to 1209 single line of text, and so the formatting of long help strings needs to
1229 which is an embedded new-line in the string together with a C++ string 1229 which is an embedded new-line in the string together with a C++ string
1230 continuation character. Note that the final @code{\} must be the last 1230 continuation character. Note that the final @code{\} must be the last
1231 character on the line. 1231 character on the line.
1232 1232
1233 Octave also includes the ability to embed test and demonstration 1233 Octave also includes the ability to embed test and demonstration
1234 code for a function within the code itself (@ref{Test and Demo Functions}). 1234 code for a function within the code itself (@pxref{Test and Demo Functions}).
1235 This can be used from within oct-files (or in fact any file) with 1235 This can be used from within oct-files (or in fact any file) with
1236 certain provisos. First, the test and demo functions of Octave look 1236 certain provisos. First, the test and demo functions of Octave look
1237 for @code{%!} as the first two characters of a line to identify test 1237 for @code{%!} as the first two characters of a line to identify test
1238 and demonstration code. This is a requirement for oct-files as well. 1238 and demonstration code. This is a requirement for oct-files as well.
1239 In addition, the test and demonstration code must be wrapped in a comment 1239 In addition, the test and demonstration code must be wrapped in a comment