The template argument was documented.

This commit is contained in:
Radu Ursu 2002-06-20 08:27:03 +00:00
parent 68df61b9b1
commit 528e9d8cbb
12 changed files with 52 additions and 48 deletions

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_circle}
\begin{ccRefClass}{Qt_widget_get_circle<T>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ circle in this way: one
@ -19,13 +19,14 @@ mouse button is pressed for the second time, the distance
between those 2 representing the radius of the new circle.
\ccInclude{CGAL/IO/Qt_widget_get_circle.h}
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_circle} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class T>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class T >}\\
\ccc{class Qt_widget_get_circle;}
\end{tabbing}
If T is one of the \cgal\ kernels you don't need additional types. If

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_line}
\begin{ccRefClass}{Qt_widget_get_line<T>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ line in this way: one
@ -21,11 +21,11 @@ mouse button is pressed for the second time.
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_line} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class T>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class T >}\\
\ccc{class Qt_widget_get_line;}
\end{tabbing}
If T is one of the \cgal\ kernels you don't need additional types. If

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_point}
\begin{ccRefClass}{Qt_widget_get_point<T>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ point, every time
the left mouse button is clicked.
@ -18,11 +18,11 @@ the left mouse button is clicked.
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_point} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class T>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class T >}\\
\ccc{class Qt_widget_get_point;}
\end{tabbing}
If T is one of the \cgal\ kernels you don't need additional types. If

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_polygon}
\begin{ccRefClass}{Qt_widget_get_polygon<Polygon>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ polygon. A new
@ -20,11 +20,11 @@ The polygon is returned on a right click.
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_polygon} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class Polygon>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class Polygon >}\\
\ccc{class Qt_widget_get_polygon;}
\end{tabbing}
Polygon should be a \cgal\ Polygon.

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_segment}
\begin{ccRefClass}{Qt_widget_get_segment<T>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ segment in this
@ -18,13 +18,14 @@ of the segment will be considered at the coordinates where the left
mouse button is pressed for the second time.
\ccInclude{CGAL/IO/Qt_widget_get_segment.h}
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_segment} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class T>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class T >}\\
\ccc{class Qt_widget_get_segment;}
\end{tabbing}
If T is one of the \cgal\ kernels you don't need additional types. If

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_simple_polygon}
\begin{ccRefClass}{Qt_widget_get_simple_polygon<Polygon>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ simple polygon.
@ -22,11 +22,11 @@ your last entered point in the polygon.
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_simple_polygon} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class Polygon>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class Polygon >}\\
\ccc{class Qt_widget_get_simple_polygon;}
\end{tabbing}
Polygon should be a \cgal\ Polygon.

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_circle}
\begin{ccRefClass}{Qt_widget_get_circle<T>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ circle in this way: one
@ -19,13 +19,14 @@ mouse button is pressed for the second time, the distance
between those 2 representing the radius of the new circle.
\ccInclude{CGAL/IO/Qt_widget_get_circle.h}
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_circle} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class T>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class T >}\\
\ccc{class Qt_widget_get_circle;}
\end{tabbing}
If T is one of the \cgal\ kernels you don't need additional types. If

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_line}
\begin{ccRefClass}{Qt_widget_get_line<T>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ line in this way: one
@ -21,11 +21,11 @@ mouse button is pressed for the second time.
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_line} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class T>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class T >}\\
\ccc{class Qt_widget_get_line;}
\end{tabbing}
If T is one of the \cgal\ kernels you don't need additional types. If

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_point}
\begin{ccRefClass}{Qt_widget_get_point<T>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ point, every time
the left mouse button is clicked.
@ -18,11 +18,11 @@ the left mouse button is clicked.
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_point} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class T>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class T >}\\
\ccc{class Qt_widget_get_point;}
\end{tabbing}
If T is one of the \cgal\ kernels you don't need additional types. If

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_polygon}
\begin{ccRefClass}{Qt_widget_get_polygon<Polygon>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ polygon. A new
@ -20,11 +20,11 @@ The polygon is returned on a right click.
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_polygon} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class Polygon>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class Polygon >}\\
\ccc{class Qt_widget_get_polygon;}
\end{tabbing}
Polygon should be a \cgal\ Polygon.

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_segment}
\begin{ccRefClass}{Qt_widget_get_segment<T>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ segment in this
@ -18,13 +18,14 @@ of the segment will be considered at the coordinates where the left
mouse button is pressed for the second time.
\ccInclude{CGAL/IO/Qt_widget_get_segment.h}
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_segment} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class T>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class T >}\\
\ccc{class Qt_widget_get_segment;}
\end{tabbing}
If T is one of the \cgal\ kernels you don't need additional types. If

View File

@ -9,7 +9,7 @@
% +------------------------------------------------------------------------+
% +-----------------------------------------------------+
\begin{ccRefClass}{Qt_widget_get_simple_polygon}
\begin{ccRefClass}{Qt_widget_get_simple_polygon<Polygon>}
\ccDefinition
An object of type \ccRefName\ creates a \cgal\ simple polygon.
@ -22,11 +22,11 @@ your last entered point in the polygon.
\ccParameters
The full template declaration of \ccClassTemplateName\ states one parameter:
The full template declaration of \ccc{Qt_widget_get_simple_polygon} states one parameter:
\begin{tabbing}
\ccc{template <} \=\ccc{class Polygon>}\\
\ccc{class \ccClassTemplateName;}
\ccc{template <} \=\ccc{class Polygon >}\\
\ccc{class Qt_widget_get_simple_polygon;}
\end{tabbing}
Polygon should be a \cgal\ Polygon.