changeset 12527:30ee8f0cc7c2

Add dump_prefs to documentation.
author Rik <octave@nomad.inbox5.com>
date Sat, 19 Mar 2011 12:33:09 -0700
parents f8ea3eabcb85
children 2ac5028e5cb7
files doc/ChangeLog doc/interpreter/basics.txi scripts/ChangeLog scripts/miscellaneous/dump_prefs.m
diffstat 4 files changed, 18 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Sat Mar 19 12:12:57 2011 -0700
+++ b/doc/ChangeLog	Sat Mar 19 12:33:09 2011 -0700
@@ -1,3 +1,7 @@
+2010-03-19  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/basics.txi: Add dump_prefs to documentation.
+
 2010-03-19  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/octave.texi, interpreter/plot.txi: Add daspect, pbaspect
--- a/doc/interpreter/basics.txi	Sat Mar 19 12:12:57 2011 -0700
+++ b/doc/interpreter/basics.txi	Sat Mar 19 12:33:09 2011 -0700
@@ -336,6 +336,11 @@
 invoke Octave with the @option{--verbose} option but without the
 @option{--silent} option.
 
+The @code{dump_prefs} function is useful for determining what customizations
+to Octave are possible and which are in effect.
+
+@DOCSTRING(dump_prefs)
+
 @node Quitting Octave
 @section Quitting Octave
 @cindex exiting octave
--- a/scripts/ChangeLog	Sat Mar 19 12:12:57 2011 -0700
+++ b/scripts/ChangeLog	Sat Mar 19 12:33:09 2011 -0700
@@ -1,3 +1,7 @@
+2010-03-19  Rik  <octave@nomad.inbox5.com>
+
+	* miscellaneous/dump_prefs.m: Improve docstring.
+
 2010-03-19  Rik  <octave@nomad.inbox5.com>
 
 	* plot/daspect.m, plot/pbaspect.m: Use newline between @deftypefnx
--- a/scripts/miscellaneous/dump_prefs.m	Sat Mar 19 12:12:57 2011 -0700
+++ b/scripts/miscellaneous/dump_prefs.m	Sat Mar 19 12:33:09 2011 -0700
@@ -17,10 +17,11 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} dump_prefs (@var{file})
-## Have Octave dump all the current user preference variables to
-## @var{file} in a format that can be parsed by Octave later.  If
-## @var{file} is omitted, the listing is printed to stdout.
+## @deftypefn {Function File} {} dump_prefs ()
+## @deftypefn {Function File} {} dump_prefs (@var{fid})
+## Dump all of the current user preference variables in a format that can be
+## parsed by Octave later.  @var{fid} is a file descriptor as returned by
+## @code{fopen}.  If @var{file} is omitted, the listing is printed to stdout.
 ## @end deftypefn
 
 ## Author: jwe