meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Next revision Both sides next revision
common:matlab_documentation_generator [2009/02/24 13:57]
laakkone created
common:matlab_documentation_generator [2009/02/24 15:31]
127.0.0.1 external edit
Line 15: Line 15:
 The m2html tool assumes you have already Matlab-style comments The m2html tool assumes you have already Matlab-style comments
 and documentation in your m-files. Remember the H1 line etc. and documentation in your m-files. Remember the H1 line etc.
-If the Matlab command ​<tt>help somefunction</​tt> ​shows a nice+If the Matlab command ​''​help somefunction'' ​shows a nice
 help text, you should be fine. help text, you should be fine.
  
 The tool is implemented in Matlab, so start Matlab and The tool is implemented in Matlab, so start Matlab and
 add the directory to your path. add the directory to your path.
 +
  ​addpath somewhere/​m2html  ​addpath somewhere/​m2html
  
 Go to a directory that is one level <​b>​above</​b>​ the directory where Go to a directory that is one level <​b>​above</​b>​ the directory where
 you have your m-files. you have your m-files.
 +
  cd work/​gmmbayes/​src/​matlab  cd work/​gmmbayes/​src/​matlab
  
 Now is a good moment to read the brief manual: Now is a good moment to read the brief manual:
 +
  help m2html  help m2html
  
-Let's generate documentation for <tt>work/​gmmbayes/​src/​matlab/​base2</​tt> ​directory:+Let's generate documentation for ''​work/​gmmbayes/​src/​matlab/​base2'' ​directory: 
  ​m2html('​mfiles',​ '​base2',​ '​htmlDir',​ '​doc','​graph',​ '​on'​)  ​m2html('​mfiles',​ '​base2',​ '​htmlDir',​ '​doc','​graph',​ '​on'​)
  
-That will create some files and a directory under <tt>work/​gmmbayes/​src/​matlab/​doc</tt>, including +That will create some files and a directory under ''​work/​gmmbayes/​src/​matlab/​doc''​, including 
-<tt>index.html</tt>. Open that in your web browser.+''​index.html''​. Open that in your web browser.
 An example output of m2html may be found at http://​work.pq.iki.fi/​s/​base2/​ An example output of m2html may be found at http://​work.pq.iki.fi/​s/​base2/​