Feature #113
Extract documentation from MATLAB files
| Status: | Closed | Start date: | 2011-03-24 | |
|---|---|---|---|---|
| Priority: | High | Due date: | ||
| Assignee: |  Chris Cannam | % Done: | 100% | |
| Category: | - | |||
| Target version: | - |
Description
We now have automatic extraction for Doxygen and Javadoc comments (see #20). But MATLAB also has conventions for inline documentation -- see this Mathworks documentation. A lot of code would benefit from automatically extracting this: for example, the Beat Tracking Evaluation project code.
History
#1
Updated by Chris Cannam over 13 years ago
According to the previous link, MATLAB comments allow LaTeX within $$.$$, so see also http://www.fauskes.net/nb/htmleqII/
#2
Updated by Chris Cannam over 13 years ago
A Perl program to do the extraction can be found here
Changelog suggests it last had a major update in 2000, file is dated 2001, yet it still runs without errors and produces sensible results. Hurrah for Perl, hurrah for the script's author Hartmut Pohlheim, hurrah for MATLAB and simple text formats.
I don't think we can use the output unmodified, because it uses frames extensively, but it looks promising at least.
#3
Updated by Chris Cannam over 13 years ago
See also Helpers for Doxygen
#4
Updated by Chris Cannam over 13 years ago
- Status changed from New to Closed
- % Done changed from 0 to 100
Hartmut Pohlheim's script is now included (with his permission) and updated to make frames optional in the output. The result is merged and live on the site now. Let's give it a bit more testing and file any remaining problems as separate bug reports.