changeset 8516:e2a179415bac

doc fixes
author John W. Eaton <jwe@octave.org>
date Wed, 14 Jan 2009 16:49:45 -0500
parents ec2715c76039
children 81d6ab3ac93c
files doc/interpreter/contrib.txi examples/@polynomial/subsref.m scripts/general/quadgk.m scripts/miscellaneous/intwarning.m scripts/sparse/spaugment.m src/variables.cc
diffstat 6 files changed, 25 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/contrib.txi	Wed Jan 14 16:06:48 2009 -0500
+++ b/doc/interpreter/contrib.txi	Wed Jan 14 16:49:45 2009 -0500
@@ -317,6 +317,8 @@
 width:
 
 @example
-         1         2         3         4         5         6         7         8
-12345678901234567890123456789012345678901234567890123456789012345678901234567890
+@group
+         1         2         3         4         5         6
+123456789012345678901234567890123456789012345678901234567890
+@end group
 @end example
--- a/examples/@polynomial/subsref.m	Wed Jan 14 16:06:48 2009 -0500
+++ b/examples/@polynomial/subsref.m	Wed Jan 14 16:49:45 2009 -0500
@@ -11,7 +11,8 @@
       if (strcmp (fld, "poly"))
 	b = a.poly;
       else
-	error ("subsref: unrecognized property \"%s\" of a polynomial", fld);
+	error ("@polynomial/subsref: invalid property \"%s\"",
+	       fld);
       endif
   endswitch
 endfunction
--- a/scripts/general/quadgk.m	Wed Jan 14 16:06:48 2009 -0500
+++ b/scripts/general/quadgk.m	Wed Jan 14 16:49:45 2009 -0500
@@ -74,11 +74,11 @@
 ##
 ## @item WayPoints
 ## If there exists discontinuities in the first derivative of the
-## function to integrate, then these can be flagged with teh 'WayPoints'
-## property. This forces the ends of a sub-interval to fall on the
-## breakpoints of the function and can result in significantly improved
-## estimated of the error in the integral, faster computation or both.
-## For example
+## function to integrate, then these can be flagged with the
+## @code{"WayPoints"} property. This forces the ends of a sub-interval
+## to fall on the breakpoints of the function and can result in
+## significantly improved estimated of the error in the integral, faster
+## computation or both.  For example,
 ##
 ## @example
 ## quadgk (@@(x) abs (1 - x .^ 2), 0, 2, 'Waypoints', 1)
@@ -98,7 +98,8 @@
 ## assuemd to have no edge singularities. For example
 ##
 ## @example
-## quadgk (@@ (z) log (z), 1+1i, 1+1i, 'WayPoints', [1-1i, -1,-1i, -1+1i])
+## quadgk (@@(z) log (z), 1+1i, 1+1i, "WayPoints",
+##         [1-1i, -1,-1i, -1+1i])
 ## @end example
 ##
 ## @noindent
--- a/scripts/miscellaneous/intwarning.m	Wed Jan 14 16:06:48 2009 -0500
+++ b/scripts/miscellaneous/intwarning.m	Wed Jan 14 16:49:45 2009 -0500
@@ -30,13 +30,15 @@
 ## Otherwise it is returned in a structure with the fields "identifier"
 ## and "state".
 ##
-## @example
+## @smallexample
+## @group
 ## intwarning ("query")
 ## The state of warning "Octave:int-convert-nan" is "off"
 ## The state of warning "Octave:int-convert-non-int-val" is "off"
 ## The state of warning "Octave:int-convert-overflow" is "off"
 ## The state of warning "Octave:int-math-overflow" is "off"
-## @end example 
+## @end group
+## @end smallexample 
 ##
 ## @item "on"
 ## Turn integer conversion and math warnings "on". If there is no output
--- a/scripts/sparse/spaugment.m	Wed Jan 14 16:06:48 2009 -0500
+++ b/scripts/sparse/spaugment.m	Wed Jan 14 16:49:45 2009 -0500
@@ -50,7 +50,8 @@
 ## @example
 ## @group
 ## m = 11; n = 10; mn = max(m ,n);
-## a = spdiags ([ones(mn,1), 10*ones(mn,1), -ones(mn,1)],[-1,0,1], m, n);
+## a = spdiags ([ones(mn,1), 10*ones(mn,1), -ones(mn,1)],
+##              [-1, 0, 1], m, n);
 ## x0 = a \ ones (m,1);
 ## s = spaugment (a);
 ## [L, U, P, Q] = lu (s);
--- a/src/variables.cc	Wed Jan 14 16:06:48 2009 -0500
+++ b/src/variables.cc	Wed Jan 14 16:49:45 2009 -0500
@@ -2502,18 +2502,19 @@
 \n\
 A command is composed like this:\n\
 \n\
-@example\n\
+@smallexample\n\
 %[modifier]<command>[:size_of_parameter[:center-specific[:balance]]];\n\
-@end example\n\
+@end smallexample\n\
 \n\
-Command and modifier is already explained. Size_of_parameter\n\
-tells how many columns the parameter will need for printing.\n\
+Command and modifier is already explained.  The @code{size_of_parameter}\n\
+parameter tells how many columns the parameter will need for printing.\n\
 The @code{center-specific} parameter may only be applied to command\n\
 @samp{%s}.\n\
 The @code{balance} parameter specifies the offset for printing\n\
 the dimensions string.\n\
 \n\
-The default format is \"  %a:4; %ln:6; %cs:16:6:1;  %rb:12;  %lc:-1;\\n\".\n\
+The default format is\n\
+@code{\"  %a:4; %ln:6; %cs:16:6:1;  %rb:12;  %lc:-1;\\n\"}.\n\
 @end deftypefn")
 {
   return SET_INTERNAL_VARIABLE (whos_line_format);