head_comments

Arguments

name

a character string, the function name.

%paths

a character string vector, paths where to look for the associated sci-file.

Description

head_comments(name) displays the function header comments (like the Matlab help). The comments are read from the associated sci-file. If name is a function which is in a library the sci-file path is those given by the library path (see lib). If name is a function which is not in a library, a file with name name.sci is searched in the directories given by the variable %paths.

Warning: most of the Scilab predefined functions have no header comments.

Examples

head_comments sinc

See also

• help — on-line help command
• lib — library definition