Home > freetb4matlab > help > get_first_help_sentence.m

get_first_help_sentence

PURPOSE ^

% Return the first sentence of a function help text.

SYNOPSIS ^

function [retval, status] = get_first_help_sentence (name, max_len = 80)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {[@var{retval}, @var{status}] =} get_first_help_sentence (@var{name}, @var{max_len})
% Return the first sentence of a function help text.
%
% The function reads the first sentence of the help text of the function
% @var{name}.  The first sentence is defined as the text after the function
% declaration until either the first period ('.') or the first appearance of
% two consecutive end-lines ('\n\n').  The text is truncated to a maximum length
% of @var{max_len}, which defaults to 80.
%
% The optional output argument @var{status} returns the status reported by
% @code{makeinfo}.  If only one output argument is requested, and @var{status}
% is non-zero, a warning is displayed.
%
% As an example, the first sentence of this help text is
%
% @example
% @group
% get_first_help_sentence ('get_first_help_sentence')
% @print{} ans = Return the first sentence of a function help text.
% @end group
% @end example
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003