headcomments

Display Nelson function header comments.

Syntax

• headcomments(function_name)
• ce = headcomments(function_name)

Input argument

• function_name - a string: function name or a .m filename.

Output argument

• ce - a cell of strings

Description

head_comments displays the function header comments.

Comments are read from the associated .m file.

Nelson predefined functions have no header comments.

Example

comments = headcomments('cellstr'); md = markdown(comments);inserthtml(md)

See also

doc, markdown, inserthtml, which.

History

Author

Allan CORNET