buildDocOptiGTest

PURPOSE ^

% optiGTest toolbox

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

% optiGTest toolbox
 L. LAURENT --  16/05/2018 -- luc.laurent@lecnam.net

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 %% optiGTest toolbox
0002 % L. LAURENT --  16/05/2018 -- luc.laurent@lecnam.net
0003 
0004 % sources available here:
0005 % https://bitbucket.org/luclaurent/optigtest/
0006 % https://github.com/luclaurent/optigtest/
0007 
0008 % optiGTest - set of testing functions    A toolbox to easy manipulate functions.
0009 % Copyright (C) 2018  Luc LAURENT <luc.laurent@lecnam.net>
0010 %
0011 % This program is free software: you can redistribute it and/or modify
0012 % it under the terms of the GNU General Public License as published by
0013 % the Free Software Foundation, either version 3 of the License, or
0014 % (at your option) any later version.
0015 %
0016 % This program is distributed in the hope that it will be useful,
0017 % but WITHOUT ANY WARRANTY; without even the implied warranty of
0018 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0019 % GNU General Public License for more details.
0020 %
0021 % You should have received a copy of the GNU General Public License
0022 % along with this program.  If not, see <http://www.gnu.org/licenses/>.
0023 
0024 %% Build documentation (using m2html library)
0025 % L. LAURENT -- 20/05/2018 -- luc.laurent@lecnam.net
0026 
0027 %add path m2html
0028 addpath('various/m2html');
0029 
0030 %load paths
0031 dirPath={'@optiGTest','Constrained','MultiObj','unConstrained','various'};
0032 
0033 %% Build documentation
0034 
0035 %add configuration to bash (for finding 'dot' script of graphviz)
0036 setenv('BASH_ENV','~/.bash_profile');
0037 setenv('DYLD_LIBRARY_PATH','/usr/local/bin/');
0038 setenv('PATH','/usr/local/bin/');
0039 
0040 
0041 %directory to be analysed
0042 analyseDir='optiGTest';
0043 %ignoring directory
0044 %ignDir={'};
0045 
0046 %list of files
0047 listFiles=listFilesoptiGTest(dirPath);
0048 %add path to all files
0049 listFiles=cellfun(@(x) sprintf('%s/%s',analyseDir,x),listFiles,'UniformOutput',false);
0050 
0051 cd ..
0052 warning('off')
0053 %execute generation of the doc (Graphviz is optional)
0054 m2html('mfiles',listFiles,...
0055     'htmldir',[analyseDir '/various/doc'],...
0056     'recursive','on',...
0057     'global','on',...
0058     'globalHypertextLinks','on',...
0059     'index','menu',...
0060     'template','frame',...
0061     'index','menu',...
0062     'download','off',...
0063     'graph','on')
0064 warning('on')
0065 cd(analyseDir)
0066 %%%%%%

Generated on Tue 28-May-2019 16:00:34 by m2html © 2005