Function Summary Panel
The function summary or prototype panel is similar to the Syntax Summary panel, but it is used to describe or provide a summary of a function or method prototype in a programming language.
Prototype
The String Comparison Function
stdio.h int strcmp(char str1[], char str2[]);
The function takes two strings and compares them lexicographically to determine their relative ordering or whether they are identical.
|
The syntaxsummary environment is defined below:
panels module
\begin{fnctsummary}[module='stdio.h' header='Prototype']{title}
\begin{prototype}
...
\end{prototype}
\begin{descp}
...
\end{descp}
\end{fnctsummary}
Used to highlight and describe function and method prototypes in a programming language.
The environment requires two sub environments.
- syntax
- specifies the definition of the prototype that is being summarized. It uses the same format as the langsyntax environment;
- descp
- contains the description of the prototype.
Argument:
- title
-
The title of the syntax summary.
Keys:
- module
-
The name of the module or package in which the function/method is defined.
- header
-
The panel header label typically displayed as a black tab with white text. The default is 'Syntax'.
Plugin: FunctionSummaryPanel
The Function Prototype panel shown above is produced from the following syntax Prototype
\begin{fnctsummary}[module=stdio.h]{The String Comparison Function}
\begin{prototype}
int strcmp(char str1[], char str2[]);
\end{prototype}
\begin{descp}
The function takes two strings and compares them lexicographically to determine
their relative ordering or whether they are identical.
\end{descp}
\end{fnctsummary}