Mercurial > octave-antonio
view scripts/help/print_usage.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2009-2015 Søren Hauberg ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} print_usage () ## @deftypefnx {Function File} {} print_usage (@var{name}) ## Print the usage message for the function @var{name}. ## ## When called with no input arguments the @code{print_usage} function displays ## the usage message of the currently executing function. ## @seealso{help} ## @end deftypefn function print_usage (name) x = dbstack (); ## Handle input if (nargin == 0) ## Determine the name of the calling function if (numel (x) > 1) name = x(2).name; else error ("Octave:invalid-context", "print_usage: invalid function\n"); endif fullpath = evalin ("caller", 'mfilename ("fullpath")'); if (strcmp (fullpath(end-length(name)+1:end), name)) fullname = [fullpath ".m"]; endif elseif (! ischar (name)) error ("Octave:invalid-input-arg", "print_usage: input argument must be a string"); else fullname = name; endif ## Determine if we were called from top level. at_toplev = length (x) < 2 || (length (x) == 2 && strcmp (x(2).name, name)); ## Do the actual work [text, format] = get_help_text (fullname); max_len = 80; switch (lower (format)) case "plain text" [usage_string, status] = get_usage_plain_text (text, max_len); case "texinfo" [usage_string, status] = get_usage_texinfo (text, max_len); case "html" [usage_string, status] = get_usage_html (text, max_len); case "not documented" error ("print_usage: '%s' is not documented\n", name); case "not found" error ("print_usage: '%s' not found\n", name); otherwise error ("print_usage: internal error: unsupported help text format: '%s'\n", format); endswitch ## Raise the final error if (status != 0) warning ("print_usage: Texinfo formatting filter exited abnormally"); warning ("print_usage: raw Texinfo source of help text follows...\n"); endif if (at_toplev) error ("Octave:invalid-fun-call", "Invalid call to %s. Correct usage is:\n\n%s\n%s", name, usage_string, __additional_help_message__ ()); else msg = sprintf ("Invalid call to %s. Correct usage is:\n\n%s", name, usage_string); ## Ensure that the error doesn't end up with a newline, as that disables ## backtraces. if (msg(end) == "\n") msg(end) = " "; endif error ("Octave:invalid-fun-call", msg); endif endfunction function [retval, status] = get_usage_plain_text (help_text, max_len) ## Extract first line by searching for a double line-end. line_end_idx = strfind (help_text, "\n\n"); retval = help_text (1:min ([line_end_idx , max_len, length(help_text)])); status = 0; endfunction function [retval, status] = get_usage_texinfo (help_text, max_len) ## Lines ending with "@\n" are continuation lines, so they should be ## concatenated with the following line. help_text = strrep (help_text, "@\n", " "); ## Find, and keep, lines that start with @def or @end def. This should ## include things such as @deftypefn, @deftypefnx, @defvar, etc. and their ## corresponding @end's. def_idx = strfind (help_text, "@def"); if (! isempty (def_idx)) endf_idx = strfind (help_text, "@end def"); def_idx = sort ([def_idx, endf_idx]); endl_idx = find (help_text == "\n"); buffer = ""; for k = 1:length (def_idx) endl = endl_idx(find (endl_idx > def_idx(k), 1)); if (isempty (endl)) buffer = strcat (buffer, help_text (def_idx(k):end), "\n"); else buffer = strcat (buffer, help_text (def_idx(k):endl)); endif endfor else [retval, status] = get_usage_plain_text (help_text, max_len); endif ## Run makeinfo to generate plain text [retval, status] = __makeinfo__ (buffer, "plain text"); endfunction function [retval, status] = get_usage_html (help_text, max_len) ## Strip tags [help_text, status] = strip_html_tags (help_text); ## Extract first line with plain text method. retval = get_usage_plain_text (help_text, max_len); endfunction ## Stop reporting function as missing tests. No good tests possible. %!assert (1)