infoskeleton(prototype,
index_str, see_also)
¶Generate TeXinfo skeleton documentation of prototype.
Optionally index_str and see_also can be specified.
Usage of this function is typically,
infoskeleton('[V,Q] = eig( A )','linear algebra','eigs, chol, qr, det')
See also: info.
The following code
infoskeleton( ' [x,y,z]=infoskeleton(func , z , z9 , jj, fjh, x) ')
Produces the following output
## -*- texinfo -*- ## @deftypefn{Function File} {@var{[x,y,z]} = } infoskeleton ( func, z, z9, jj, fjh, x ) ## @cindex ## The function infoskeleton calculates where @var{func} is , @var{z} is , @var{z9} is , @var{jj} is , @var{fjh} is , @var{x} is . ## @example ## ## @end example ## @seealso{} ## @end deftypefn
The following code
infoskeleton('[V,Q] = eig( A )','linear algebra','eigs, chol, qr, det')
Produces the following output
## -*- texinfo -*- ## @deftypefn{Function File} {@var{[V,Q]} = } eig ( ## @cindex linear algebra ## The function eig calculates where @var{## @example ## ## @end example ## @seealso{eigs, chol, qr, det} ## @end deftypefn
The following code
infoskeleton( 'function [x,y,z] = indian_languages ( x) ')
Produces the following output
## -*- texinfo -*- ## @deftypefn{Function File} {@var{[x,y,z]} = } indian_languages ( ## @cindex ## The function indian_languages calculates where @var{## @example ## ## @end example ## @seealso{} ## @end deftypefn
Package: miscellaneous