OOM2TeX

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

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