Home > SaliencyToolbox > 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-2013
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 if isempty(which('m2html'))
0018   fprintf('Please install m2html and add it to the executable path.\n');
0019   fprintf('http://www.artefact.tk/software/matlab/m2html/\n');
0020   return;
0021 end
0022 
0023 currDir = pwd;
0024 [path,dirname] = fileparts(fileparts(which(mfilename)));
0025 
0026 cd(path);
0027 
0028 m2html('mfiles',dirname,...
0029        'htmldir',[dirname,filesep,'doc',filesep,'mdoc'],...
0030        'recursive','off');
0031 
0032 cd(currDir);
0033 
0034

Generated on Thu 18-Jul-2013 06:10:46 by m2html © 2005