Remove outdated recommendation about "// file : " in example programs.

Add a note about too long lines in examples that appear in the manual.
This commit is contained in:
Sylvain Pion 2009-09-09 13:50:16 +00:00
parent 4658a68630
commit f302c27fa2
1 changed files with 5 additions and 8 deletions

View File

@ -27,14 +27,7 @@ to the library, so you should be careful to follow our coding conventions
programs. In particular:
\begin{itemize}
\item Include a comment that gives the name of the file relative to
the \texttt{CGALROOT} directory, such as:
\begin{verbatim}
//
// file : examples/Generator/random_polygon_ex.cpp
//
\end{verbatim}
\item Do \textbf{not} use the commands
\item Do \textbf{not} use the statements
\begin{verbatim}
using namespace CGAL;
using namespace std;
@ -130,6 +123,10 @@ is not necessarily true. Ideally the programs included in the documentation
will be a proper (non-empty) subset of the programs included in the
distribution.
Please make sure that your example programs do not have too lengthy lines
as they are copied verbatim in the manual, which can trigger overflows
in the PDF manual.
\section{Demo programs on the web\label{sec:demos_web_page}}
\ccIndexSubitem{demo programs}{on the web}