M2TEX

Extracts comments from m-files to create Contents.m and TeX-file.

Description

M2TEX loops over all m-files in a directory and extracts the comments section from them.

The short one-line description is used to create a Contents.m, that can be displayed with MATLAB's help function.

A LaTeX file is created with a table containing short descriptions and sections with m-file titles containing the complete help comments.

>> ls

. SecDraw.m plt ternplot.m
.. brushlinktool pp.m teximage.m
Contents.m dirplot_demo.m ref.tex
Contents.m~ espTk2 ref.tex~
Dirplot.m hatch.m ternlabel.m

>> m2tex

ans =

Dirplot.m ** DIRPLOT Polar directivity plot.
SecDraw.m ** SECDRAW Draw section of a circle
dirplot_demo.m ** dirplot_demo Demonstrates usage of DIRPLOT.M to generate polar directivity plots.
hatch.m ** HATCH Hatches a two-dimensional domain.
pp.m ** pp
ternlabel.m ** TERNLABEL label ternary phase diagram
ternplot.m ** TERNPLOT plot ternary phase diagram
teximage.m ** TEXIMAGE display a LaTeX string as a bitmap image

Known problems:
- Probably not all special characters are handles correctly
- Wrong Formatting usually results in warnings "use of uninitialized chunk ..."
- Maximum number of m-files per directory is 99. If you have more, run the perl script directly from the command line.

• MATLAB release: MATLAB 6.5 (R13)
• Other requirements: perl (included in newer Matlab versions) LaTeX to compile the output file LaTeX package longtable, if the

[James J. Cai]

 

[Jessica Kaufman]