Be the first to rate this file! 10 downloads (last 30 days) File Size: 5.21 KB File ID: #21950

OOM2TeX

by Cengiz Gunay

 

30 Oct 2008

Code covered by the BSD License  

Create documentation for object-oriented Matlab class hierarchies in LaTeX, producing PDF or HTML.

Download Now | Watch this File

File Information
Description

OOM2TeX is a Perl program that extracts comments from files in Matlab's object-oriented class directories and creates a LaTeX document which can be translated to PDF, HTML, etc.

Recognizes keywords such as description, author, parameters, example in the Matlab comment block and formats the LaTeX file accordingly. See the screenshot for an example. Cross references are made based on full class and method names automatically. The references show up as page numbers and also hyperlinks in PDF and HTML files. HTML output requires the LaTeX2HTML tool. A function index is created that can be inserted to your document which is composed of method names and lists of pages from which they were referenced. Again, they will be hyperlinks in PDF and HTML pages.

It scans class directories hierarchically and creates class listings, and method descriptions in each section. It supports scanning an additional directory for regular matlab functions. These will appear in a section titled "Utility Functions".

MATLAB release MATLAB 7.5 (R2007b)
Other requirements Perl, latex, pdflatex, optional: latex2html
Zip File Content  
Other Files oom2tex/,
oom2tex/oom2tex.pl,
oom2tex/README
Tags for This File  
Everyone's Tags
Tags I've Applied
Add New Tags Please login to tag files.
Please login to add a comment or rating.
Tag Activity for this File
Tag Applied By Date/Time
latex Cengiz Gunay 01 Nov 2008 02:44:43
documentation Cengiz Gunay 01 Nov 2008 02:44:43
objectoriented Cengiz Gunay 01 Nov 2008 02:44:43
oo Cengiz Gunay 01 Nov 2008 02:44:43
 

MATLAB Central Terms of Use

NOTICE: Any content you submit to MATLAB Central, including personal information, is not subject to the protections which may be afforded information collected under other sections of The MathWorks, Inc. Web site. You are entirely responsible for all content that you upload, post, e-mail, transmit or otherwise make available via MATLAB Central. The MathWorks does not control the content posted by visitors to MATLAB Central and, does not guarantee the accuracy, integrity, or quality of such content. Under no circumstances will The MathWorks be liable in any way for any content not authored by The MathWorks, or any loss or damage of any kind incurred as a result of the use of any content posted, e-mailed, transmitted or otherwise made available via MATLAB Central. Read the complete Terms prior to use.

Contact us at files@mathworks.com