Institut de Robòtica i Informàtica Industrial

MakeDoc

PURPOSE ^

Generates the documentation for this toolbox.

SYNOPSIS ^

function MakeDoc

DESCRIPTION ^

   Generates the documentation for this toolbox.

   Generates the html documentation for this toolbox.
   We assume m2html is available in the path.
      (Execute addpath <path to m2html>)

   The documentation can be browsed with a web browser opening
       Doc/index.html

   This function only works in Linux.

CROSS-REFERENCE INFORMATION ^

This function calls:
This function is called by:

SOURCE CODE ^

0001 function MakeDoc
0002 %   Generates the documentation for this toolbox.
0003 %
0004 %   Generates the html documentation for this toolbox.
0005 %   We assume m2html is available in the path.
0006 %      (Execute addpath <path to m2html>)
0007 %
0008 %   The documentation can be browsed with a web browser opening
0009 %       Doc/index.html
0010 %
0011 %   This function only works in Linux.
0012 
0013 if exist('m2html','file')==2
0014   % Remove the previous documentation if any
0015   eval('!rm -rf Doc');
0016   % generate the new documentation
0017   m2html('mfiles','.','htmldir','Doc','recursive','on','global','on','template','IRI','index','menu','graph','on','todo','on');
0018   %m2html('mfiles','.','htmldir','Doc','recursive','on','global','on','template','frame','index','menu','graph','on','todo','on');
0019   %
0020   eval('!sed -i ''s/\.\.\///g'' Doc/*.html');
0021 else
0022   error('m2html is not in the path');
0023 end


Institut de Robòtica i Informàtica Industrial

Generated on Wed 05-Aug-2009 15:05:21 by m2html © 2003