diff doc/interpreter/octave.texi @ 13780:990762e784fe

Fix confusing interaction between @code macro and transpose operator (') in documentation (Bug #34661). * octave.texi: Define new @xcode macro which expands to nothing in plain text or Info output. Expands to normal @code for all other formats. * data.cc: Rephrase documentation for functions which have operator equivalents. Use @xcode macro to mark the operator equivalent for these functions. * expr.txi: Use @asis markup in table to prevent confusion between transpose operator and @code expansion in Info format. * mk_doc_cache.m, __makeinfo__.m: Add processing for new @xcode macro. * krylov.m, etreeplot.m, lu.cc, schur.cc, symbfact.cc: Use new @xcode macro.
author Rik <octave@nomad.inbox5.com>
date Tue, 01 Nov 2011 11:08:18 -0700
parents 13bcd62824a7
children 5820f8ce683e
line wrap: on
line diff
--- a/doc/interpreter/octave.texi	Tue Nov 01 13:30:23 2011 -0400
+++ b/doc/interpreter/octave.texi	Tue Nov 01 11:08:18 2011 -0700
@@ -46,6 +46,20 @@
 \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 xcode{arg}
+\arg\
+@end macro
+@end ifinfo
+@ifnotinfo
+@macro xcode{arg}
+@code{\arg\}
+@end macro
+@end ifnotinfo
+
 @ifinfo
 @format
 START-INFO-DIR-ENTRY