changeset 3405:a020244950f9

[project @ 2000-01-05 08:09:27 by jwe]
author jwe
date Wed, 05 Jan 2000 08:09:29 +0000
parents c4ba3cada9cb
children 772cc0f88f09
files doc/interpreter/octave.texi scripts/ChangeLog scripts/set/complement.m scripts/set/create_set.m scripts/set/intersection.m scripts/set/union.m src/ChangeLog src/help.cc
diffstat 8 files changed, 32 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/octave.texi
+++ b/doc/interpreter/octave.texi
@@ -5,6 +5,14 @@
 \input texinfo
 @setfilename octave.info
 
+@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 symbol).
+
+@macro seealso {args}
+@end macro
+
 @ifinfo
 @format
 START-INFO-DIR-ENTRY
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,10 @@
+2000-01-05  John W. Eaton  <jwe@bevo.che.wisc.edu>
+
+	* set/complement.m: Add @seealso{} stuff.
+	* set/create_set.m: Likewise.
+	* set/intersection.m: Likewise.
+	* set/union.m: Likewise.
+
 1999-12-22  John W. Eaton  <jwe@bevo.che.wisc.edu>
 
 	* control/d2c.m: Use double quotes instead of single quotes for
--- a/scripts/set/complement.m
+++ b/scripts/set/complement.m
@@ -28,10 +28,10 @@
 ##      @result{} 5
 ## @end group
 ## @end example
+##
+## @seealso{create_set, union, and intersection}
 ## @end deftypefn
 
-## See also: create_set, union, intersection
-
 ## Author: jwe
 
 function y = complement (a, b)
--- a/scripts/set/create_set.m
+++ b/scripts/set/create_set.m
@@ -28,10 +28,10 @@
 ##      @result{} [ 1, 2, 3, 4 ]
 ## @end group
 ## @end example
+##
+## @seealso{union, intersection, and complement}
 ## @end deftypefn
 
-## See also: union, intersection, complement
-
 ## Author: jwe
 
 function y = create_set(x)
--- a/scripts/set/intersection.m
+++ b/scripts/set/intersection.m
@@ -28,10 +28,10 @@
 ##      @result{} [ 2, 3 ]
 ## @end group
 ## @end example
+##
+## @seealso{create_set, union, and complement}
 ## @end deftypefn
 
-## See also: create_set, union, complement
-
 ## Author: jwe
 
 function y = intersection(a,b)
--- a/scripts/set/union.m
+++ b/scripts/set/union.m
@@ -28,10 +28,10 @@
 ##      @result{} [ 1, 2, 3, 4, 5 ]
 ## @end group
 ## @end example
+##
+## @seealso{create_set, intersection, and complement}
 ## @end deftypefn
 
-## See also: create_set, intersection, complement
-
 ## Author: jwe
 
 function y = union(a,b)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2000-01-05  John W. Eaton  <jwe@bevo.che.wisc.edu>
+
+	* help.cc (display_help_text): Pass a definition for @seealso
+	through the filter.
+
 1999-12-22  John W. Eaton  <jwe@bevo.che.wisc.edu>
 
 	* lex.l (Vwarn_single_quote_string): New variable.
--- a/src/help.cc
+++ b/src/help.cc
@@ -632,6 +632,10 @@
 
       if (filter)
 	{
+	  filter << "@macro seealso {args}\n"
+		 << "See also: \\args\\.\n"
+                 << "@end macro\n";
+
 	  filter << msg.substr (pos+1);
 
 	  filter.close ();