mirror of https://github.com/CGAL/cgal
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:
parent
4658a68630
commit
f302c27fa2
|
|
@ -27,14 +27,7 @@ to the library, so you should be careful to follow our coding conventions
|
||||||
programs. In particular:
|
programs. In particular:
|
||||||
|
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
\item Include a comment that gives the name of the file relative to
|
\item Do \textbf{not} use the statements
|
||||||
the \texttt{CGALROOT} directory, such as:
|
|
||||||
\begin{verbatim}
|
|
||||||
//
|
|
||||||
// file : examples/Generator/random_polygon_ex.cpp
|
|
||||||
//
|
|
||||||
\end{verbatim}
|
|
||||||
\item Do \textbf{not} use the commands
|
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
using namespace CGAL;
|
using namespace CGAL;
|
||||||
using namespace std;
|
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
|
will be a proper (non-empty) subset of the programs included in the
|
||||||
distribution.
|
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}}
|
\section{Demo programs on the web\label{sec:demos_web_page}}
|
||||||
\ccIndexSubitem{demo programs}{on the web}
|
\ccIndexSubitem{demo programs}{on the web}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue