cgal/Manual_tools/example/Example_ref/For_all.tex

59 lines
1.4 KiB
TeX

% +------------------------------------------------------------------------+
% | Reference manual page: For_all.tex
% +------------------------------------------------------------------------+
% | 03.09.1999 Lutz Kettner
% | Package: Example
% |
\RCSdef{\RCSForallRev}{$Id$}
\RCSdefDate{\RCSForallDate}{$Date$}
% |
%%RefPage: end of header, begin of main body
% +------------------------------------------------------------------------+
\begin{ccRefMacro}{For_all} %% add template arg's if necessary
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[macro]{} %% add further index entries
\ccDefinition
The macro \ccRefName\ does this and that.
\ccInclude{DIR/For_all.h}
\ccc{For_all}
\ccIsModel
\ccc{Concept}
\ccSeeAlso
\ccc{Some_other_macro},
\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/For_all_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/For_all_prog.C}
\end{ccRefMacro}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
% EOF
% +------------------------------------------------------------------------+