Mercurial > hg > octave-avbm
changeset 8768:e0fbf17a17bb
__makeinfo__.m: rename from makeinfo.m
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 16 Feb 2009 17:01:17 -0500 |
parents | 026c6732ec7a |
children | a186c5b4f264 |
files | scripts/ChangeLog scripts/help/Makefile.in scripts/help/__additional_help_message__.m scripts/help/__makeinfo__.m scripts/help/__strip_html_tags__.m scripts/help/get_first_help_sentence.m scripts/help/help.m scripts/help/lookfor.m scripts/help/makeinfo.m scripts/help/print_usage.m |
diffstat | 9 files changed, 41 insertions(+), 34 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,12 @@ +2009-02-16 John W. Eaton <jwe@octave.org> + + * help/__makeinfo__.m: Rename from help/makeinfo.m. Delete tmp file. + * help/Makefile.in (SOURCES): Add __makeinfo__.m, delete makeinfo.m. + * help/get_first_help_sentence.m, help/help.m, help/lookfor.m, + help/print_usage.m: Call __makeinfo__ instead of makeinfo. + * help/__strip_html_tags__.m, help/__additional_help_message__.m: + Doc fix. + 2009-02-16 Ben Abbott <bpabbott@mac.com> * plot/shading.m: No new figure windows for the demos.
--- a/scripts/help/Makefile.in +++ b/scripts/help/Makefile.in @@ -34,13 +34,13 @@ SOURCES = \ __additional_help_message__.m \ + __makeinfo__.m \ __strip_html_tags__.m \ doc.m \ gen_doc_cache.m \ get_first_help_sentence.m \ help.m \ lookfor.m \ - makeinfo.m \ print_usage.m \ type.m \ which.m
--- a/scripts/help/__additional_help_message__.m +++ b/scripts/help/__additional_help_message__.m @@ -15,11 +15,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} __additional_help_message__ () -## Return additional help message. -## -## This is an internal function and should not be used directly. -## @seealso{suppress_verbose_help_message} +## @deftypefn {Function File} {} __additional_help_message__ () +## Undocumented internal function. ## @end deftypefn function msg = __additional_help_message__ ()
rename from scripts/help/makeinfo.m rename to scripts/help/__makeinfo__.m --- a/scripts/help/makeinfo.m +++ b/scripts/help/__makeinfo__.m @@ -15,15 +15,16 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{retval}, @var{status}] =} makeinfo (@var{text}, @ -## @var{output_type}) -## @deftypefnx{Function File} {[@var{retval}, @var{status}] =} makeinfo (@var{text}, @ -## @var{output_type}, @var{see_also}) +## @deftypefn {Function File} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}) +## @deftypefnx{Function File} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}, @var{see_also}) +## Undocumented internal function. +## @end deftypefn + ## Run @code{makeinfo} on a given text. ## -## The string @var{text} is run through the @code{makeinfo} program to generate -## output in various formats. This string must contain valid Texinfo formatted -## text. +## The string @var{text} is run through the @code{__makeinfo__} program +## to generate output in various formats. This string must contain valid +## Texinfo formatted text. ## ## The @var{output_type} selects the format of the output. This can be either ## @t{"html"}, @t{"texinfo"}, or @t{"plain text"}. By default this is @@ -53,20 +54,20 @@ ## ## The optional output argument @var{status} contains the exit status of the ## @code{makeinfo} program as returned by @code{system}. -## @end deftypefn -function [retval, status] = makeinfo (text, output_type = "plain text", see_also = []) +function [retval, status] = __makeinfo__ (text, output_type = "plain text", see_also = []) + ## Check input if (nargin == 0) print_usage (); endif if (!ischar (text)) - error ("makeinfo: first input argument must be a string"); + error ("__makeinfo__: first input argument must be a string"); endif if (!ischar (output_type)) - error ("makeinfo: second input argument must be a string"); + error ("__makeinfo__: second input argument must be a string"); endif ## Define the @seealso macro @@ -79,7 +80,7 @@ endif if (!isa (see_also, "function_handle")) - error ("makeinfo: third input argument must be the empty matrix, or a function handle"); + error ("__makeinfo__: third input argument must be the empty matrix, or a function handle"); endif ## It seems like makeinfo sometimes gets angry if the character on a line is @@ -136,16 +137,16 @@ cmd = sprintf ("%s --no-headers --html --no-warn --no-validate --force %s", makeinfo_program (), name); otherwise - error ("makeinfo: unsupported output type: '%s'", output_type); + error ("__makeinfo__: unsupported output type: '%s'", output_type); endswitch ## Call makeinfo [status, retval] = system (cmd); unwind_protect_cleanup -# if (exist (name, "file")) -# delete (name); -# endif + if (exist (name, "file")) + delete (name); + endif end_unwind_protect endfunction
--- a/scripts/help/__strip_html_tags__.m +++ b/scripts/help/__strip_html_tags__.m @@ -16,12 +16,12 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{text}, @var{status}] =} __strip_html_tags__ (@var{html_text}) -## This function removes html tags from a text. This is used as a simple -## html-to-text function. -## -## This is an internal function and should not be used directly. +## Undocumented internal function. ## @end deftypefn +## Remove HTML tags from text. This is used as a simple HTML-to-text +## function. + function [text, status] = __strip_html_tags__ (html_text) start = find (html_text == "<"); stop = find (html_text == ">");
--- a/scripts/help/get_first_help_sentence.m +++ b/scripts/help/get_first_help_sentence.m @@ -133,7 +133,7 @@ endif ## Run makeinfo to generate plain text - [help_text, status] = makeinfo (help_text, "plain text"); + [help_text, status] = __makeinfo__ (help_text, "plain text"); ## Extract first line with plain text method. retval = first_sentence_plain_text (help_text, max_len);
--- a/scripts/help/help.m +++ b/scripts/help/help.m @@ -59,7 +59,7 @@ case "plain text" status = 0; case "texinfo" - [text, status] = makeinfo (text, "plain text"); + [text, status] = __makeinfo__ (text, "plain text"); case "html" [text, status] = strip_html_tags (text); case "not documented" @@ -75,7 +75,7 @@ ## Print text if (status != 0) - warning ("makeinfo: Texinfo formatting filter exited abnormally; raw Texinfo source of help text follows...\n"); + warning ("help: Texinfo formatting filter exited abnormally; raw Texinfo source of help text follows...\n"); endif which (name); @@ -104,7 +104,7 @@ case "plain text" status = 0; case "texinfo" - [text, status] = makeinfo (text, "plain text"); + [text, status] = __makeinfo__ (text, "plain text"); case "html" [text, status] = strip_html_tags (text); endswitch
--- a/scripts/help/lookfor.m +++ b/scripts/help/lookfor.m @@ -105,7 +105,7 @@ case "plain text" status = 0; case "texinfo" - [text, status] = makeinfo (text, "plain text"); + [text, status] = __makeinfo__ (text, "plain text"); case "html" [text, status] = strip_html_tags (text); otherwise
--- a/scripts/help/print_usage.m +++ b/scripts/help/print_usage.m @@ -57,8 +57,8 @@ ## Raise the final error if (status != 0) - warning ("makeinfo: Texinfo formatting filter exited abnormally"); - warning ("makeinfo: raw Texinfo source of help text follows...\n"); + warning ("print_usage: Texinfo formatting filter exited abnormally"); + warning ("print_usage: raw Texinfo source of help text follows...\n"); endif error ("Invalid call to %s. Correct usage is:\n\n%s\n%s", @@ -101,7 +101,7 @@ endif ## Run makeinfo to generate plain text - [retval, status] = makeinfo (buffer, "plain text"); + [retval, status] = __makeinfo__ (buffer, "plain text"); endfunction function [retval, status] = get_usage_html (help_text, max_len)