Home > mfiles > STBgenerateDoc.m

STBgenerateDoc

PURPOSE ^

STBgenerateDoc - generates html documentation.

SYNOPSIS ^

function STBgenerateDoc

DESCRIPTION ^

 STBgenerateDoc - generates html documentation.
    This is a wrapper for the m2html program with settings
    that work for the SaliencyToolbox. You must have m2html
    in the executable path, and you must change to the 
    SaliencyToolbox directory before excuting this function.

 For m2html see: http://www.artefact.tk/software/matlab/m2html/

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % STBgenerateDoc - generates html documentation.
0002 %    This is a wrapper for the m2html program with settings
0003 %    that work for the SaliencyToolbox. You must have m2html
0004 %    in the executable path, and you must change to the
0005 %    SaliencyToolbox directory before excuting this function.
0006 %
0007 % For m2html see: http://www.artefact.tk/software/matlab/m2html/
0008 
0009 % This file is part of the SaliencyToolbox - Copyright (C) 2006-2008
0010 % by Dirk B. Walther and the California Institute of Technology.
0011 % See the enclosed LICENSE.txt document for the license agreement.
0012 % More information about this project is available at:
0013 % http://www.saliencytoolbox.net
0014 
0015 function STBgenerateDoc
0016 
0017 declareGlobal;
0018 
0019 if (~ismember(basename(pwd),{'SaliencyToolbox','trunk'}))
0020   fprintf(['Please change to the SaliencyToolbox base directory and run ' ...
0021            mfilename ' again.\n']);
0022   return;
0023 end
0024 
0025 htmlDir = ['./doc' PD 'mdoc'];
0026 
0027 m2html('mfiles',{'./mfiles/','./mex/'},'htmldir',htmlDir,'recursive','on',...
0028        'globalHypertextLinks','on','global','on');

Generated on Fri 22-Aug-2008 00:09:19 by m2html © 2003