function htmlOut = helprpt(name, option) %HELPRPT Scan a file or directory for help. % Copyright 1984-2004 The MathWorks, Inc. if nargout == 0 web('text://Generating help report...','-noaddressbox'); end if nargin < 1 option = 'dir'; name = cd; end if nargin == 1 option = 'file'; end noContentsFileFlag = 1; if strcmp(option,'dir') dirname = name; if isdir(dirname) dirFileList = dir([dirname filesep '*.m']); fileList = {dirFileList.name}; % Exclude the Contents file from the list for n = 1:length(fileList) if strcmp(fileList{n},'Contents.m') noContentsFileFlag = 0; fileList(n) = []; break end end else error('%s is not a directory',dirname) end else fullname = which(name); if isempty(fullname) error('file %s not found',name) end dirname = fileparts(fullname); dirFileList = dir([dirname filesep name '.m']); fileList = {dirFileList.name}; end if dirname(1) == '\' % mlint.exe cannot be called on a UNC pathname web(['text://Help Report cannot run when the current ' ... 'directory is a UNC pathname.'],'-noaddressbox'); return end % Manage the preferences h1DisplayMode = getpref('dirtools','h1DisplayMode',1); helpDisplayMode = getpref('dirtools','helpDisplayMode',1); copyrightDisplayMode = getpref('dirtools','copyrightDisplayMode',1); helpSubfunsDisplayMode = getpref('dirtools','helpSubfunsDisplayMode',1); exampleDisplayMode = getpref('dirtools','exampleDisplayMode',1); seeAlsoDisplayMode = getpref('dirtools','seeAlsoDisplayMode',1); % First gather all the data strc = []; for n = 1:length(fileList) filename = fileList{n}; if helpSubfunsDisplayMode callStrc = getcallinfo(filename,'subfuns'); else callStrc = getcallinfo(filename,'file'); end for m = 1:length(callStrc) strc(end+1).filename = filename; strc(end).name = callStrc(m).name; strc(end).type = callStrc(m).type; strc(end).firstLine = callStrc(m).firstline; if strcmp(strc(end).type,'subfunction') helpStr = helpfunc([strc(end).filename filemarker strc(end).name]); else helpStr = helpfunc(strc(end).filename); end strc(end).help = code2html(helpStr); % Remove any leading spaces and percent signs % Grab all the text up to the first carriage return helpTkn = regexp(helpStr,'^\s*%*\s*([^\n]*)\n','tokens','once'); if isempty(helpTkn) strc(end).description = ''; else strc(end).description = helpTkn{1}; end % Now we grep through the function line by line looking for % copyright, example, and see-also information. Don't bother % looking for these things in a subfunction. % NOTE: This will not work for Japanese files if ~strcmp(strc(end).type,'subfunction') % Short-circuit the searches if the user doesn't want to see % the result if copyrightDisplayMode copyrightSuccessFlag = 0; else copyrightSuccessFlag = 1; end if exampleDisplayMode exampleSuccessFlag = 0; else exampleSuccessFlag = 1; end if seeAlsoDisplayMode seeAlsoSuccessFlag = 0; else seeAlsoSuccessFlag = 1; end f = textread(filename,'%s','delimiter','\n','whitespace',''); strc(end).copyright = ''; strc(end).example = ''; strc(end).seeAlso = ''; for i = 1:length(f) % The help report searches all comment lines in the file, % even if they occur after the typical "help block" at the % top of the file. % If there's no comment character, short circuit the loop. if isempty(strfind(f{i},'%')) continue end if ~copyrightSuccessFlag crTkn = regexp(f{i},'^\s*%\s*Copyright\s+(\d+)-?(\d+)?(.*)$','tokens','once'); if ~isempty(crTkn) strc(end).copyright = f{i}; strc(end).copyrightLine = i; if isempty(crTkn{1}) strc(end).copyrightBeginYear = []; else strc(end).copyrightBeginYear = eval(crTkn{1}); end if isempty(crTkn{2}) strc(end).copyrightEndYear = strc(n).copyrightBeginYear; else strc(end).copyrightEndYear = eval(crTkn{2}); end strc(end).copyrightOrganization = crTkn{3}; copyrightSuccessFlag = 1; end end if ~exampleSuccessFlag exTkn = regexpi(f{i},'^\s*%(\s*examples?:?\s*\d*\s*)$','tokens','once'); if ~isempty(exTkn) exampleStr = {' ',exTkn{1}}; strc(end).exampleLine = i; % Loop through and grep the entire example % We assume the example ends when there is a blank % line or when the comments end. exampleCompleteFlag = 0; for j = (i+1):length(f) codeTkn = regexp(f{j},'^\s*%(\s*[^\s].*$)','tokens','once'); if isempty(codeTkn) exampleCompleteFlag = 1; else exampleStr{end+1} = codeTkn{1}; end if exampleCompleteFlag break end end strc(end).example = sprintf('%s\n',exampleStr{:}); exampleSuccessFlag = 1; end end if ~seeAlsoSuccessFlag if strfind(f{i},'See also') seeTkn = regexpi(f{i},'^\s*%\s*(See also:? .*)$','tokens','once'); if ~isempty(seeTkn) strc(end).seeAlso = seeTkn{1}; strc(end).seeAlsoLine = i; % Remove the pattern "See also" seeFcns = strrep(seeTkn{1},'See also',''); strc(end).seeAlsoFcnList = regexpi(seeFcns,'(\w+)','tokens'); end end end if copyrightSuccessFlag && exampleSuccessFlag && seeAlsoSuccessFlag % No need to keep grep'ing once you've found everything break end end end end end % Generate the HTML s = {}; s{1} = makeheadhtml; s{end+1} = 'Help Report'; s{end+1} = ''; s{end+1} = ''; % Make the form s{end+1} = '
'; s{end+1} = ''; s{end+1} = ''; s{end+1} = '
'; s{end+1} = '
'; s{end+1} = ''; s{end+1} = ''; s{end+1} = ''; checkOptions = {'','checked'}; s{end+1} = sprintf('', ... checkOptions{helpSubfunsDisplayMode+1}); s{end+1} = sprintf('', ... checkOptions{h1DisplayMode+1}); s{end+1} = sprintf('', ... checkOptions{exampleDisplayMode+1}); s{end+1} = ''; s{end+1} = sprintf('', ... checkOptions{helpDisplayMode+1}); s{end+1} = sprintf('', ... checkOptions{seeAlsoDisplayMode+1}); s{end+1} = sprintf('', ... checkOptions{copyrightDisplayMode+1}); s{end+1} = ''; s{end+1} = '
Show subfunctionsDescriptionExamples
Show all helpSee alsoCopyright
'; s{end+1} = '
'; if strcmp(option,'dir') && noContentsFileFlag s{end+1} = '
'; s{end+1} = 'This directory has no Contents.m file

'; else s{end+1} = '
'; s{end+1} = sprintf('Help for directory %s

', ... dirname,dirname); end s{end+1} = 'M-File List
'; s{end+1} = ''; for n = 1:length(strc) s{end+1} = ''; % Display all the results if strcmp(strc(n).type,'subfunction') s{end+1} = sprintf('', ... strc(n).filename, ... strc(n).firstLine, ... [strrep(strc(n).filename,'.m','') filemarker strc(n).name]); s{end+1} = '', ... strc(n).filename, ... strrep(strc(n).filename,'.m','')); s{end+1} = ''; end s{end+1} = '
%s'; else s{end+1} = sprintf('%s'; end if h1DisplayMode if isempty(strc(n).description) s{end+1} = 'No description line
'; else s{end+1} = sprintf('
%s
',strc(n).description); end end if helpDisplayMode if isempty(strc(n).help) s{end+1} = 'No help
'; else s{end+1} = '
';
            s{end+1} = sprintf('%s
',regexprep(strc(n).help,'^ %',' '));
            s{end+1} = '
'; end end if ~strcmp(strc(n).type,'subfunction') % We don't check for copyright, examples, and see also in % subfunctions if exampleDisplayMode if isempty(strc(n).example) s{end+1} = 'No example
'; else lineLabel = sprintf('%2d:',strc(n).exampleLine); lineLabel = strrep(lineLabel,' ',' '); s{end+1} = sprintf('
%s %s
', ... [dirname filesep strc(n).filename], ... strc(n).exampleLine, ... lineLabel, ... strc(n).example); end end if seeAlsoDisplayMode if isempty(strc(n).seeAlso) s{end+1} = 'No see-also line
'; else lineLabel = sprintf('%2d:',strc(n).seeAlsoLine); lineLabel = strrep(lineLabel,' ',' '); s{end+1} = sprintf('
%s %s
', ... [dirname filesep strc(n).filename], ... strc(n).seeAlsoLine, ... lineLabel, ... strc(n).seeAlso); checkSeeAlsoFcn = 1; if checkSeeAlsoFcn for m = 1:length(strc(n).seeAlsoFcnList) if isempty(which(strc(n).seeAlsoFcnList{m}{1})) s{end+1} = sprintf('Function %s does not appear on the path
', ... strc(n).seeAlsoFcnList{m}{1}); end end end end end if copyrightDisplayMode if isempty(strc(n).copyright) s{end+1} = 'No copyright line'; else lineLabel = sprintf('%2d:',strc(n).copyrightLine); lineLabel = strrep(lineLabel,' ',' '); s{end+1} = sprintf('
%s %s
', ... [dirname filesep strc(n).filename], ... strc(n).copyrightLine, ... lineLabel, ... strc(n).copyright); dv = datevec(now); if strc(n).copyrightEndYear ~= dv(1) s{end+1} = 'Copyright year is not current
'; end end end end s{end+1} = '
'; s{end+1} = ''; sOut = [s{:}]; if nargout==0 web(['text://' sOut],'-noaddressbox'); else htmlOut = sOut; end