Mercurial > octave-nkf

comparison doc/interpreter/dynamic.txi @ 6606:2c19eaa2c6f7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-05-07 17:09:38 by jwe]
author jwe
date Mon, 07 May 2007 17:09:38 +0000
parents 3da1f4a41455
children 2aad75fcc93a
comparison
equal deleted inserted replaced
6605:376b71574728 6606:2c19eaa2c6f7
1097 however there are some issue that are particular to the formatting of 1097 however there are some issue that are particular to the formatting of
1098 help strings within oct-files. 1098 help strings within oct-files.
1099 1099
1100 The major issue is that the help string will typically be longer than a 1100 The major issue is that the help string will typically be longer than a
1101 single line of text, and so the formatting of long help strings need to 1101 single line of text, and so the formatting of long help strings need to
1102 be taken into account. There are several manner in which to happen this 1102 be taken into account. There are several manner in which to treat this
1103 issue, but the most common is illustrated in the following example 1103 issue, but the most common is illustrated in the following example
1104 1104
1105 @example 1105 @example
1106 @group 1106 @group
1107 DEFUN_DLD (do_what_i_want, args, nargout, 1107 DEFUN_DLD (do_what_i_want, args, nargout,
1128 certain provisos. Firstly, the test and demo functions of Octave look 1128 certain provisos. Firstly, the test and demo functions of Octave look
1129 for a @code{%!} as the first characters on a new-line to identify test 1129 for a @code{%!} as the first characters on a new-line to identify test
1130 and demonstration code. This is equally a requirement for 1130 and demonstration code. This is equally a requirement for
1131 oct-files. Furthermore the test and demonstration code must be included 1131 oct-files. Furthermore the test and demonstration code must be included
1132 in a comment block of the compiled code to avoid it being interpreted by 1132 in a comment block of the compiled code to avoid it being interpreted by
1133 the compiler. Finally, he Octave test and demonstration code must have 1133 the compiler. Finally, the Octave test and demonstration code must have
1134 access to the source code of the oct-file and not just the compiled code 1134 access to the source code of the oct-file and not just the compiled code
1135 as th<e tests are stripped from the compiled code. An example in an 1135 as the tests are stripped from the compiled code. An example in an
1136 oct-file might be 1136 oct-file might be
1137 1137
1138 @example 1138 @example
1139 @group 1139 @group
1140 /* 1140 /*