Create documenation for custom toolbox
1 回表示 (過去 30 日間)
古いコメントを表示
I'm writing a toolbox right now with own functions and want to create a documenation in html for it.
My Matlab version is 2018b.
I'm writing the function description into the head of my m-file.
Example:
%% BINTOMAT Converts .BIN /.HEAD CATR Data into .mat file.
% |binToMat()| opens a File-Selector GUI to select .BIN /.HEAD files.
% Created .mat-file will placed into the same path.
%
% |binToMat('path\to\files')| opens a File-Selector GUI at the given path to
% select .BIN /.HEAD files. Created .mat-file will be placed into the
% same path.
%
% |binToMat('path\to\files','ALL')| creates the .mat-file directly without
% opening a GUI.
%
%% Notes:
% ...
%
%% Examples:
% ...
%
% See also ASYSOL_CSV_TO_EXCEL_CIRCULAR_CO_CX, ASYSOL_TO_EXCEL_LINEAR_CO_CX
As you can see I use markup style to have a nice output.
I tried 3 methos to create a documenation from it:
1 . publish(m-file) and view output html-file.
![](https://www.mathworks.com/matlabcentral/answers/uploaded_files/637180/image.jpeg)
2. save m-file as mtx-file and use matlab.internal.liveeditor.openAndConvert(mtx-file, 'output.html'). View output html-file.
![](https://www.mathworks.com/matlabcentral/answers/uploaded_files/637185/image.jpeg)
3. save m-file as mtx-file and use doc functionname
![](https://www.mathworks.com/matlabcentral/answers/uploaded_files/637190/image.jpeg)
The created output styles of 1. and 2. are different. (I prefere 2.. Is there a way of creating a mtx-file programmaticaly (matlab.internal.richeditor.openAndSave doesnt work in my matlab version))
Do I miss a method to create a documentation?
Is there a way to create the third output from a m-file programmaticaly?
0 件のコメント
回答 (0 件)
参考
カテゴリ
Help Center および File Exchange で Workspace Variables and MAT-Files についてさらに検索
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!