DoxyGen filter for MatLab
See www.doxygen.org and doxyf.sourceforge.net
These are Linux executables. Cygwin and Windows are also supported. There are two other filters included.
* mtoc
mtoc supports class structures.
There is a fiddly bit with member functions that are in the same
directory as their containing class. You have to use some meta-commands to
get these to work.
In the class file, Model.m, declare the extra functions, say convolve() in
as a function.
% @fn type convolve(type obj, type arg1, type arg2, type functor)
Then in the convolve.m file before the function is defined:
% @fn type Model::convolve(type obj, type arg1, type arg2, type functor)
%
% The convolve function takes two arrays and a function pointer.
function result = convolve(obj, x, y, fn)
result = fn(x, y);
end
Note: I haven't been very careful with the line-numbering. And in the class
file Model.m, the use of the function definitions will throw the
line-numbering out. So if you do use the line-numbering, put the dummy
declarations at the end.
* mtoc
mtoc supports class structures.
There is a fiddly bit with member functions that are in the same
directory as their containing class. You have to use some meta-commands to
get these to work.
In the class file, Model.m, declare the extra functions, say convolve() in
as a function.
% @fn type convolve(type obj, type arg1, type arg2, type functor)
Then in the convolve.m file before the function is defined:
% @fn type Model::convolve(type obj, type arg1, type arg2, type functor)
%
% The convolve function takes two arrays and a function pointer.
function result = convolve(obj, x, y, fn)
result = fn(x, y);
end
Note: I haven't been very careful with the line-numbering. And in the class
file Model.m, the use of the function definitions will throw the
line-numbering out. So if you do use the line-numbering, put the dummy
declarations at the end.
* mtoc
mtoc supports class structures.
There is a fiddly bit with member functions that are in the same
directory as their containing class. You have to use some meta-commands to
get these to work.
In the class file, Model.m, declare the extra functions, say convolve() in
as a function.
% @fn type convolve(type obj, type arg1, type arg2, type functor)
Then in the convolve.m file before the function is defined:
% @fn type Model::convolve(type obj, type arg1, type arg2, type functor)
%
% The convolve function takes two arrays and a function pointer.
function result = convolve(obj, x, y, fn)
result = fn(x, y);
end
Note: I haven't been very careful with the line-numbering. And in the class
file Model.m, the use of the function definitions will throw the
line-numbering out. So if you do use the line-numbering, put the dummy
declarations at the end.
Citar como
Walter Eaves (2025). DoxyGen filter for MatLab (https://www.mathworks.com/matlabcentral/fileexchange/27624-doxygen-filter-for-matlab), MATLAB Central File Exchange. Recuperado .
Compatibilidad con la versión de MATLAB
Compatibilidad con las plataformas
Windows macOS LinuxCategorías
Etiquetas
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!Descubra Live Editor
Cree scripts con código, salida y texto formateado en un documento ejecutable.
Versión | Publicado | Notas de la versión | |
---|---|---|---|
1.0.0.0 |