Home > functions > internal > dsGenerateDocumentation.m

dsGenerateDocumentation

PURPOSE ^

GENERATEDOCUMENTATION - Build DynaSim function documentation

SYNOPSIS ^

function generateDocumentation

DESCRIPTION ^

GENERATEDOCUMENTATION - Build DynaSim function documentation

  This is a simple call to `m2html()` to make it easy for anyone with DynaSim
  on their path to build the offline documentation.

  HOWEVER, there is a caveat:
     This is a custom version of m2html, in that I replaced all deprecated
     'error(nargin(...' uses, which were giving warnings that slowed down the
     program, into modern 'narginchk' uses, so this is NOT identical to the
     downloadable m2html.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function generateDocumentation
0002 %GENERATEDOCUMENTATION - Build DynaSim function documentation
0003 %
0004 %  This is a simple call to `m2html()` to make it easy for anyone with DynaSim
0005 %  on their path to build the offline documentation.
0006 %
0007 %  HOWEVER, there is a caveat:
0008 %     This is a custom version of m2html, in that I replaced all deprecated
0009 %     'error(nargin(...' uses, which were giving warnings that slowed down the
0010 %     program, into modern 'narginchk' uses, so this is NOT identical to the
0011 %     downloadable m2html.
0012 
0013 cwd = pwd; % store current working dir
0014 
0015 % fprintf('Temporarily changing directory to dynasim root for offline documentation generation.\n\n')
0016 cd(dsGetConfig('ds_root_path'));
0017 
0018 m2html('mfiles',{'functions'},...
0019        'htmldir','docs/offline_function_reference',...
0020        'recursive','on',...
0021        'global','on',...
0022        'template','frame',...
0023        'index','menu',...
0024        'graph','on',...
0025        'ignoredDir','dependencies');
0026 
0027 % fprintf('\nChanging directory back to original working directory.\n')
0028 cd(cwd);

Generated on Tue 12-Dec-2017 11:32:10 by m2html © 2005