Mercurial > octave
view doc/interpreter/macros.texi @ 17268:1c21f264d26f
doc: Rename @xcode macro to @tcode (transpose code) for clarity.
* doc/interpreter/macros.texi: Rename macro @xcode to @tcode.
* libinterp/corefcn/data.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/schur.cc, libinterp/dldfcn/symbfact.cc,
scripts/linear-algebra/krylov.m, scripts/sparse/etreeplot.m:
Rename @xcode macro instances to @tcode.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 17 Aug 2013 11:45:20 -0700 |
parents | bf1de4943a5d |
children | bc924baa2c4e |
line wrap: on
line source
@c Copyright (C) 2012 John W. Eaton @c @c This file is part of Octave. @c @c Octave is free software; you can redistribute it and/or modify it @c under the terms of the GNU General Public License as published by the @c Free Software Foundation; either version 3 of the License, or (at @c your option) any later version. @c @c Octave is distributed in the hope that it will be useful, but WITHOUT @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License @c for more details. @c @c You should have received a copy of the GNU General Public License @c along with Octave; see the file COPYING. If not, see @c <http://www.gnu.org/licenses/>. @c FIXME: someday, when Texinfo 5.X is standard, we might replace this with @c @backslashchar, which is an new addition to Texinfo. @macro xbackslashchar \\ @end macro @c The following macro is used for the on-line help system, but we don't @c want lots of `See also: foo, bar, and baz' strings cluttering the @c printed manual (that information should be in the supporting text for @c each group of functions and variables). @c @c Implementation Note: @c For TeX, @vskip produces a nice separation. @c For Texinfo '@sp 1' should work, but in practice produces ugly results @c for HTML. We use a simple blank line to produce the correct behavior. @macro seealso {args} @iftex @vskip 2pt @end iftex @ifnottex @end ifnottex @ifinfo @noindent See also: \args\. @end ifinfo @ifnotinfo @noindent @strong{See also:} \args\. @end ifnotinfo @end macro @c The following macro marks words that aspell should ignore during @c spellchecking. Within Texinfo it has no effect as it merely replaces @c the macro call with the argument itself. @macro nospell {arg} \arg\ @end macro @c The following macro works around a situation where the Info/plain text @c expansion of the @code{XXX} macro is `XXX'. The use of the apostrophe @c can be confusing if the code segment itself ends with a transpose operator. @ifinfo @macro tcode{arg} \arg\ @end macro @end ifinfo @ifnotinfo @macro tcode{arg} @code{\arg\} @end macro @end ifnotinfo