¿Cuál es la forma en que Mathworks genera documentación HTML de Matlab?
Estoy trabajando en código Matlab compartido y nos gustaría compartir una documentación generada como documentos HTML con capacidad de búsqueda dentro de nuestra red local.
Conozco los siguientes métodos para generar una documentación:
- Escriba un convertidor a archivos tipo C++. Esto se hace en Uso de Doxygen con Matlab (última actualización en 2011) y mtoc++ (última actualización en 2013). Luego, Doxygen analiza los archivos tipo C++.
- Utilice el dominio sphinxcontrib-matlab de Python para generar una documentación HTML.
- Utilice m2html , que también es una solución de terceros.
- En estas preguntas y respuestas se enumeran más opciones: Uno , Dos y Tres .
Mathworks no admite todas las posibilidades. Todas las posibilidades necesitan que yo mencione, es decir, los parámetros de una función. No analizan el código en el sentido, Doxygen lo hace, es decir, para Java:
//! an object representation of the advertisement package sent by the beacon
private AdvertisementPackage advertisementPackage;
Escuché sobre la función publicar() de Matlab , pero nunca la vi utilizada en el sentido antes mencionado.
Pregunta: ¿Cuál es la forma en que Mathworks genera documentación HTML de Matlab? ¿Se puede analizar el código en sí? ¿Puedo utilizar ya la información proporcionada al analizador de entrada de Matlab? Por favor mencione su preferencia personal en los comentarios.
Ejemplo:
%% Input parser
p = inputParser;
addRequired(p, 'x', @isnumeric);
validationFcn = @(x) (isnumeric(x) && isscalar(x));
addRequired(p, 'fftSize', validationFcn);
addRequired(p, 'fftShift', validationFcn);
validationFcn = @(x) (isa(x, 'function_handle'));
addRequired(p, 'analysisWindowHandle', validationFcn);
parse(p, x, fftSize, fftShift, analysisWindowHandle);
Creo que esta es la forma oficialmente aprobada de Mathworks de escribir documentación: http://www.mathworks.co.uk/help/matlab/matlab_prog/display-custom-documentation.html
Básicamente, escriba el HTML y agregue un montón de archivos para que se pueda buscar y mostrar en la documentación de MATLAB.
Existe una manera fácil de usar publicar con una función y sus entradas correspondientes. mira a publish('test',struct('codeToEvaluate','test(inputs);','showCode',false,
))
.