makehtmldoc

Creates HTML documentation from a set of M-Files.

您现在正在关注此提交

makehtmldoc(FILENAME) creates an html help file for each M-File matching FILENAME. This help file contains the header of the M-File (the first block of contiguous comment lines), with cross-links between each M-File matching FILENAME.

If no input argument specified, works with all the M-files of the current directory (ie, makehtmldoc('*.m')).

makehtmldoc(FILENAME, 'Property1', 'Property2'...) where 'Property.' may be:

'code' adds a link to the source code (except for the file 'Contents.m');
'upper' makes a link only for words in upper case.
'quiet' does not display informations during the processing.
'color', string any HTML color code for the upper and lower panels. Default = '#e7ebf7'.
'title', string title of the web window. Default = '\f'.
'firstline', string text at the top of the page. Default = 'Contents'.
'lastline', string text at the bottom of the page. Default = ''.

Note: In the string of the last three properties, '\f' will be replaced by the name of the current M-file. Web links may be used, e.g. string = '\f (<a href="MyToolbox.html">MyToolbox</a>)'

makehtmldoc works essentially as Matlab's DOC function, except that the
links are only established between the set of files matching FILENAME. So the resulting set of HTML pages only have link between themselves, and will not have broken links when consulted from an external web site.

Examples:

makehtmldoc('*.m','code') produces a set of *.html help files for all the *.m files of the current directory, with a link to the corresponding source code.

makehtmldoc('*.m','title','\f (MyToolbox)','lastline','(c) 2006');

makehtmldoc('*.m', ...
'color', '#ffff00', ...
'title', 'Help for \f', ...
'firstline', '<a href="Contents.html">Back</a>', ...
'lastline', '<a href="www.mytoolbox.com">MyToolBox</a>', ...
'upper', 'code');

See an example at of html documentation done using makehtmldoc:

http://www.fast.u-psud.fr/ezyfit/html/ezyfit_func_cat.html

引用格式

Frederic Moisy (2026). makehtmldoc (https://ww2.mathworks.cn/matlabcentral/fileexchange/9032-makehtmldoc), MATLAB Central File Exchange. 检索时间: .

类别

Help CenterMATLAB Answers 中查找有关 Share and Distribute Software 的更多信息

一般信息

MATLAB 版本兼容性

  • 兼容任何版本

平台兼容性

  • Windows
  • macOS
  • Linux
版本 已发布 发行说明 Action
1.0.0.0

- new version (v1.22)
- now sumbitted in the section "developement environement"