OOM2TeX

Create documentation for object-oriented Matlab class hierarchies in LaTeX, producing PDF or HTML.
572 Downloads
Updated 30 Oct 2008

View License

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".

Cite As

Cengiz Gunay (2024). OOM2TeX (https://www.mathworks.com/matlabcentral/fileexchange/21950-oom2tex), MATLAB Central File Exchange. Retrieved .

MATLAB Release Compatibility
Created with R2007b
Compatible with any release
Platform Compatibility
Windows macOS Linux
Categories
Find more on Adding custom doc in Help Center and MATLAB Answers

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!
Version Published Release Notes
1.0.0.0