Mercurial > hg > octave-nkf
comparison src/help.cc @ 13773:59e5f8e1d516
Fix block comment Texinfo not appearing in documentation
* help.cc: Rephrase docstring for block comment operators.
* __makeinfo__.m: Use greedy regexp to parse all of @seealso macro
even when it contains a closing curly brace.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 30 Oct 2011 16:57:03 -0700 |
parents | 62d1f56b0be7 |
children | 79aa00a94e9e |
comparison
equal
deleted
inserted
replaced
13772:ebefc477607b | 13773:59e5f8e1d516 |
---|---|
150 @end deftypefn"), | 150 @end deftypefn"), |
151 | 151 |
152 pair_type ("#{", | 152 pair_type ("#{", |
153 "-*- texinfo -*-\n\ | 153 "-*- texinfo -*-\n\ |
154 @deftypefn {Operator} {} #@{\n\ | 154 @deftypefn {Operator} {} #@{\n\ |
155 Begin block comment. There must be nothing else other than\n\ | 155 Begin block comment. There must be nothing else, other than\n\ |
156 whitespace in the line, both before and after @code{#@{}. Also,\n\ | 156 whitespace, in the line both before and after @code{#@{}.\n\ |
157 it is possible to nest block comments.\n\ | 157 It is possible to nest block comments.\n\ |
158 @seealso{#, #@}, %@{}\n\ | 158 @seealso{%@{, #@}, #}\n\ |
159 @end deftypefn"), | 159 @end deftypefn"), |
160 | 160 |
161 pair_type ("%{", | 161 pair_type ("%{", |
162 "-*- texinfo -*-\n\ | 162 "-*- texinfo -*-\n\ |
163 @deftypefn {Operator} {} %@{\n\ | 163 @deftypefn {Operator} {} %@{\n\ |
164 Begin block comment. There must be nothing else other than\n\ | 164 Begin block comment. There must be nothing else, other than\n\ |
165 whitespace in the line, both before and after @code{%@{}. Also,\n\ | 165 whitespace, in the line both before and after @code{%@{}.\n\ |
166 it is possible to nest block comments.\n\ | 166 It is possible to nest block comments.\n\ |
167 @seealso{%, %@}, #@{}\n\ | 167 @seealso{#@{, %@}, %}\n\ |
168 @end deftypefn"), | 168 @end deftypefn"), |
169 | 169 |
170 pair_type ("#}", | 170 pair_type ("#}", |
171 "-*- texinfo -*-\n\ | 171 "-*- texinfo -*-\n\ |
172 @deftypefn {Operator} {} #@}\n\ | 172 @deftypefn {Operator} {} #@}\n\ |
173 Close block comment. There must be nothing else other than\n\ | 173 Close block comment. There must be nothing else, other than\n\ |
174 whitespace in the line, both before and after @code{#@}}. Also,\n\ | 174 whitespace, in the line both before and after @code{#@}}.\n\ |
175 it is possible to nest block comments.\n\ | 175 It is possible to nest block comments.\n\ |
176 @seealso{#, #@{, %@}}\n\ | 176 @seealso{%@}, #@{, #}\n\ |
177 @end deftypefn"), | 177 @end deftypefn"), |
178 | 178 |
179 pair_type ("%}", | 179 pair_type ("%}", |
180 "-*- texinfo -*-\n\ | 180 "-*- texinfo -*-\n\ |
181 @deftypefn {Operator} {} %@}\n\ | 181 @deftypefn {Operator} {} %@}\n\ |
182 Close block comment. There must be nothing else other than\n\ | 182 Close block comment. There must be nothing else, other than\n\ |
183 whitespace in the line, both before and after @code{%@}}. Also,\n\ | 183 whitespace, in the line both before and after @code{%@}}.\n\ |
184 it is possible to nest block comments.\n\ | 184 It is possible to nest block comments.\n\ |
185 @seealso{%, %@{, #@}}\n\ | 185 @seealso{#@}, %@{, %}\n\ |
186 @end deftypefn"), | 186 @end deftypefn"), |
187 | 187 |
188 pair_type ("...", | 188 pair_type ("...", |
189 "-*- texinfo -*-\n\ | 189 "-*- texinfo -*-\n\ |
190 @deftypefn {Operator} {} ...\n\ | 190 @deftypefn {Operator} {} ...\n\ |
191 Continuation marker. Joins current line with following line.\n\ | 191 Continuation marker. Joins current line with following line.\n\ |
192 @end deftypefn"), | 192 @end deftypefn"), |
193 | 193 |
194 pair_type ("&", | 194 pair_type ("&", |
195 "-*- texinfo -*-\n\ | 195 "-*- texinfo -*-\n\ |
196 @deftypefn {Operator} {} &\n\ | 196 @deftypefn {Operator} {} &\n\ |
206 @end deftypefn"), | 206 @end deftypefn"), |
207 | 207 |
208 pair_type ("'", | 208 pair_type ("'", |
209 "-*- texinfo -*-\n\ | 209 "-*- texinfo -*-\n\ |
210 @deftypefn {Operator} {} '\n\ | 210 @deftypefn {Operator} {} '\n\ |
211 Matrix transpose operator. For complex matrices, computes the\n\ | 211 Matrix transpose operator. For complex matrices, computes the\n\ |
212 complex conjugate (Hermitian) transpose.\n\ | 212 complex conjugate (Hermitian) transpose.\n\ |
213 \n\ | 213 \n\ |
214 The single quote character may also be used to delimit strings, but\n\ | 214 The single quote character may also be used to delimit strings, but\n\ |
215 it is better to use the double quote character, since that is never\n\ | 215 it is better to use the double quote character, since that is never\n\ |
216 ambiguous\n\ | 216 ambiguous.\n\ |
217 @seealso{.', transpose}\n\ | 217 @seealso{.', transpose}\n\ |
218 @end deftypefn"), | 218 @end deftypefn"), |
219 | 219 |
220 pair_type ("(", | 220 pair_type ("(", |
221 "-*- texinfo -*-\n\ | 221 "-*- texinfo -*-\n\ |
258 @end deftypefn"), | 258 @end deftypefn"), |
259 | 259 |
260 pair_type ("++", | 260 pair_type ("++", |
261 "-*- texinfo -*-\n\ | 261 "-*- texinfo -*-\n\ |
262 @deftypefn {Operator} {} ++\n\ | 262 @deftypefn {Operator} {} ++\n\ |
263 Increment operator. As in C, may be applied as a prefix or postfix\n\ | 263 Increment operator. As in C, may be applied as a prefix or postfix\n\ |
264 operator.\n\ | 264 operator.\n\ |
265 @seealso{--}\n\ | 265 @seealso{--}\n\ |
266 @end deftypefn"), | 266 @end deftypefn"), |
267 | 267 |
268 pair_type (",", | 268 pair_type (",", |
279 @end deftypefn"), | 279 @end deftypefn"), |
280 | 280 |
281 pair_type ("--", | 281 pair_type ("--", |
282 "-*- texinfo -*-\n\ | 282 "-*- texinfo -*-\n\ |
283 @deftypefn {Operator} {} --\n\ | 283 @deftypefn {Operator} {} --\n\ |
284 Decrement operator. As in C, may be applied as a prefix or postfix\n\ | 284 Decrement operator. As in C, may be applied as a prefix or postfix\n\ |
285 operator.\n\ | 285 operator.\n\ |
286 @seealso{++}\n\ | 286 @seealso{++}\n\ |
287 @end deftypefn"), | 287 @end deftypefn"), |
288 | 288 |
289 pair_type (".'", | 289 pair_type (".'", |
290 "-*- texinfo -*-\n\ | 290 "-*- texinfo -*-\n\ |
291 @deftypefn {Operator} {} .'\n\ | 291 @deftypefn {Operator} {} .'\n\ |
292 Matrix transpose operator. For complex matrices, computes the\n\ | 292 Matrix transpose operator. For complex matrices, computes the\n\ |
293 transpose, @emph{not} the complex conjugate transpose.\n\ | 293 transpose, @emph{not} the complex conjugate transpose.\n\ |
294 @seealso{', transpose}\n\ | 294 @seealso{', transpose}\n\ |
295 @end deftypefn"), | 295 @end deftypefn"), |
296 | 296 |
297 pair_type (".*", | 297 pair_type (".*", |
626 parfor i = 1:10\n\ | 626 parfor i = 1:10\n\ |
627 i\n\ | 627 i\n\ |
628 endparfor\n\ | 628 endparfor\n\ |
629 @end group\n\ | 629 @end group\n\ |
630 @end example\n\ | 630 @end example\n\ |
631 @seealso{do, for, while}\n\ | 631 @seealso{for, do, while}\n\ |
632 @end deftypefn"), | 632 @end deftypefn"), |
633 | 633 |
634 pair_type ("persistent", | 634 pair_type ("persistent", |
635 "-*- texinfo -*-\n\ | 635 "-*- texinfo -*-\n\ |
636 @deftypefn {Keyword} {} persistent @var{var}\n\ | 636 @deftypefn {Keyword} {} persistent @var{var}\n\ |