cgal/Manual_tools/example/Example_ref/Kernel_Less_xy_2.tex

74 lines
1.8 KiB
TeX

% +------------------------------------------------------------------------+
% | Reference manual page: Kernel::Less_xy_2.tex
% +------------------------------------------------------------------------+
% | 19.07.2000 Lutz Kettner
% | Package: Example
% |
\RCSdef{\RCSKernel::LessxyRev}{$Id$}
\RCSdefDate{\RCSKernel::LessxyDate}{$Date$}
% |
%%RefPage: end of header, begin of main body
% +------------------------------------------------------------------------+
\begin{ccRefFunctionObjectConcept}{Kernel::Less_xy_2}
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[concept]{} %% add further index entries
\ccDefinition
The function object concept \ccRefName\ does this and that.
\ccGeneralizes
ThisConcept \\
ThatConcept
\ccTypes
\ccNestedType{TYPE}{some nested types}
\ccCreation
\ccCreationVariable{a} %% choose variable name
\ccConstructor{Kernel::Less_xy_2();}{default constructor.}
\ccOperations
\ccMethod{void foo();}{some member functions}
\ccHasModels
\ccc{Some_class},
\ccc{Some_other_class}.
\ccSeeAlso
\ccc{Some_other_concept},
\ccc{some_other_function}.
\ccExample
A short example program.
Instead of a short program fragment, a full running program can be
included using the
\verb|\ccIncludeExampleCode{Example/Kernel::Less_xy_2_prog.C}|
macro. The program example would be part of the source code distribution and
also part of the automatic test suite.
\begin{ccExampleCode}
void your_example_code() {
}
\end{ccExampleCode}
%% \ccIncludeExampleCode{Example/Kernel::Less_xy_2_prog.C}
\end{ccRefFunctionObjectConcept}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
% EOF
% +------------------------------------------------------------------------+