Mercurial > hg > octave-lyh
diff scripts/help/__makeinfo__.m @ 14360:97883071e8e4
doc: Correct off-by-1 spacings in all .cc docstrings
* __makeinfo__.m: Only remove space at beginning of new line for
docstrings from scripts/ directory where this is the convention.
* besselj.cc, betainc.cc, cellfun.cc, dot.cc, fftw.cc, filter.cc, find.cc,
gammainc.cc, gcd.cc, givens.cc, hex2num.cc, kron.cc, lu.cc, max.cc, qr.cc,
quadcc.cc, qz.cc, regexp.cc, strfind.cc, sub2ind.cc, syl.cc, time.cc,
typecast.cc, urlwrite.cc, data.cc, dirfns.cc, file-io.cc, help.cc,
load-path.cc, mappers.cc, oct-parse.yy, ov-base.cc, ov-cell.cc, ov-struct.cc,
ov.cc, pr-output.cc, pt-mat.cc, strfns.cc, syscalls.cc, variables.cc:
Improve appearance of docstring spacing of @example code.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Mon, 13 Feb 2012 07:42:56 -0800 |
| parents | 4d917a6a858b |
| children | f3d52523cde1 |
line wrap: on
line diff
--- a/scripts/help/__makeinfo__.m +++ b/scripts/help/__makeinfo__.m @@ -86,10 +86,13 @@ error ("__makeinfo__: third input argument must be a function handle"); endif - - ## It seems like makeinfo sometimes gets angry if the first character - ## on a line is a space, so we remove these. - text = strrep (text, "\n ", "\n"); + ## Formatting in m-files has an extra space at the beginning of every line. + ## Remove these unwanted spaces if present. First text char is "\n" delim. + if (text(2) == " ") + text = strrep (text, "\n ", "\n"); + endif + ## Texinfo crashes if @end tex does not appear first on the line. + text = regexprep (text, '^ +@end tex', '@end tex', 'lineanchors'); ## Handle @seealso macro see_also_pat = '@seealso *\{(.*)\}';