Mercurial > octave-antonio
view scripts/help/lookfor.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 | 4c6d70a35192 |
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 {Command} {} lookfor @var{str} ## @deftypefnx {Command} {} lookfor -all @var{str} ## @deftypefnx {Function File} {[@var{fcn}, @var{help1str}] =} lookfor (@var{str}) ## @deftypefnx {Function File} {[@var{fcn}, @var{help1str}] =} lookfor ("-all", @var{str}) ## Search for the string @var{str} in the documentation of all functions in the ## current function search path. ## ## By default, @code{lookfor} looks for @var{str} in just the first sentence of ## the help string for each function found. The entire help text of each ## function can be searched by using the @qcode{"-all"} argument. All searches ## are case insensitive. ## ## When called with no output arguments, @code{lookfor} prints the list of ## matching functions to the terminal. Otherwise, the output argument ## @var{fcns} contains the function names and @var{help1str} contains the first ## sentence from the help string of each function. ## ## Programming Note: The ability of @code{lookfor} to correctly identify the ## first sentence of the help text is dependent on the format of the function's ## help. All Octave core functions are correctly formatted, but the same can ## not be guaranteed for external packages and user-supplied functions. ## Therefore, the use of the @qcode{"-all"} argument may be necessary to find ## related functions that are not a part of Octave. ## ## The speed of lookup is greatly enhanced by having a cached documentation ## file. See @code{doc_cache_create} for more information. ## @seealso{help, doc, which, path, doc_cache_create} ## @end deftypefn function [fcn, help1str] = lookfor (str, arg2) if (strcmpi (str, "-all")) ## The difference between using '-all' and not is which part of the caches ## we search. The cache is organized such that row ## 1) contains the function name ## 2) contains the full help text ## 3) contains the first sentence of the help text. str = arg2; search_type = 2; # search the second row (full help text) else search_type = 3; # search the third column (first help sentence) endif str = lower (str); # Compare is case insensitive ## Search functions, operators, and keywords that come with Octave cache_file = doc_cache_file (); if (exist (cache_file, "file")) [fcnlist, help_text] = search_cache (str, cache_file, search_type); had_core_cache = true; else fcnlist = help_text = {}; had_core_cache = false; endif ## Search functions in new path dirs. orig_path = ostrsplit (__pathorig__ (), pathsep ()); ## ditto for path. new_path = ostrsplit (path (), pathsep ()); ## remove directories already covered by orig_path. if (had_core_cache) new_path = setdiff (new_path, orig_path); endif for n = 1:numel (new_path) fcndir = new_path{n}; cache_file = fullfile (fcndir, "doc-cache"); if (exist (cache_file, "file")) ## We have a cache in the directory, then read it and search it! [fcns, htext] = search_cache (str, cache_file, search_type); fcnlist(end+1:end+length (fcns)) = fcns; help_text(end+1:end+length (htext)) = htext; else ## We don't have a cache. Search files. for fcn_in_fcndir = (__list_functions__ (fcndir)).' fn = fcn_in_fcndir{1}; ## Skip files that start with "__" if (strncmp (fn, "__", 2)) continue; endif status = 0; ## Extract first sentence try warn_state = warning (); unwind_protect warning ("off"); first_sentence = get_first_help_sentence (fn, 1024); unwind_protect_cleanup warning (warn_state); end_unwind_protect catch status = 1; end_try_catch if (status) ## Error getting first help sentence elseif (search_type == 3) ## only search the first sentence of the help text text = first_sentence; elseif (search_type == 2) ## search entire help text try warn_state = warning (); unwind_protect warning ("off"); [text, fmt] = get_help_text (fn); switch (lower (fmt)) case "plain text" status = 0; case "texinfo" [text, status] = __makeinfo__ (text, "plain text"); case "html" [text, status] = strip_html_tags (text); otherwise status = 1; endswitch unwind_protect_cleanup warning (warn_state); end_unwind_protect catch status = 1; end_try_catch endif ## Search the help text if (status == 0 && strfind (lower (text), str)) fcnlist(end+1) = fn; help_text(end+1) = first_sentence; endif endfor endif endfor if (nargout == 0) ## Print the results (FIXME: it would be nice to break at word boundaries) indent = 20; term_width = (terminal_size ())(2); desc_width = term_width - indent - 2; indent_space = blanks (indent); for k = 1:length (fcnlist) f = fcnlist{k}; f(end+1:indent-1) = " "; puts ([f " "]); lf = length (f); desc = strtrim (strrep (help_text{k}, "\n", " ")); ldesc = length (desc); printf ("%s\n", desc(1:min (ldesc, desc_width - (lf - indent)))); for start = (desc_width - (lf - indent) + 1):desc_width:ldesc stop = min (start + desc_width, ldesc); printf ("%s%s\n", indent_space, strtrim (desc (start:stop))); endfor endfor else ## Return the results instead of displaying them fcn = fcnlist; help1str = help_text; endif endfunction function [fcns, help_texts] = search_cache (str, cache_file, search_type) load (cache_file); if (! isempty (cache)) t1 = strfind (lower (cache (1, :)), str); t2 = strfind (lower (cache (search_type, :)), str); cache_idx = find (! (cellfun ("isempty", t1) & cellfun ("isempty", t2))); fcns = cache(1, cache_idx); help_texts = cache(3, cache_idx); else fcns = help_texts = {}; endif endfunction