general/htdoc.m

Go to the documentation of this file.

function htdoc(topic)
% function htdoc(topic)
% opens mtoc++ documentation in a browser
%
% Opens documentation generated by mtoc++ and doxygen in a browser. The
% directory where the HTML documentation is installed must be geiven by the
% 'DOXYGEN_DIR' environment variable. This can be set with
% @code
%   setenv('DOXYGEN_DIR', '/path/to/doxygen/docu');
% @endcode
% in the 'startup.m' file, e.g.
%
% Parameters:
%  topic:     a string or an object describing for which the documentation
%             site shall be opened.

doxy_dir = getenv('DOXYGEN_DIR');
if isempty(doxy_dir) || ~exist(fullfile(doxy_dir, 'index.html'), 'file')
  error('Environment variable DOXYGEN_DIR needs to be set to a valid documentation directory!');
end

if ~ischar(topic)
  classname = class(topic);
else
  toks = get_tokens(topic);
  classname = get_max_token(toks);
end

[st, headertag] = system(['sed -ne ''s/^.*<\([^>]*\)>File List.*$/\1/p'' ', fullfile(getenv('DOXYGEN_DIR'), 'files.html')]);
headertag = ['<', headertag(1:end-1), '>'];

[st, res]=system(['grep -l ''', headertag, classname, ' '' ', fullfile(getenv('DOXYGEN_DIR'), '*'), ' | head -1' ]);
if isempty(res)
  funcname = regexprep(which(classname), '\\.m$', '');
  funcname = strrep(funcname, [rbmatlabhome, filesep], '');
  [st, res]=system(['grep -l ''', headertag, funcname, ' '' ', fullfile(getenv('DOXYGEN_DIR'), '*'), ' | head -1' ]);
end
if isempty(res)
  web(fullfile(getenv('DOXYGEN_DIR'), 'index.html'), '-browser');
  disp(['Could not find any entry for object ', classname, '.']);
end


web(res, '-browser');

function toks = get_tokens(topic)
  % function toks = get_tokens(topic)
  % extracts possible tokens to search for in the documentation directory
  toks = textscan(topic, '%s', 'Delimiter', './');
  toks = toks{1};

function mtok = get_max_token(toks)
  % function mtok = get_max_token(toks)
  % returns the token of maximum possible length.

  mtok_temp = toks{1};
  for i= length(toks):-1:2
    mtok = [mtok_temp, sprintf('.%s', toks{2:i})];
    if ~isempty(which(mtok))
      return;
    end
  end
  mtok      = toks{1};