songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Layout juggling, configuration refinement

This commit is contained in:
Philipp Möller 2012-08-23 14:00:05 +00:00
parent 34c53c9524
commit 34b71f7920
10 changed files with 52 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/Doxyfile
View File

@ -219,9 +219,10 @@ ALIASES = "sc{1}=<span style=\"font-variant: small-caps;\">\1</sp
"advancedbegin=" \
"advancedend="
ALIASES += "advanced=\xrefitem advanceds \"Advanced\" \"Advanced\""
ALIASES += "refines=\xrefitem refiness \"Refines\" \"Refines\""
ALIASES += "requires=\xrefitem requiress \"Requires\" \"Requires\""
ALIASES += "models=\xrefitem modelss \"Models\" \"Models\""
ALIASES += "models=\xrefitem modelss \"Is Model Of\" \"Is Model Of\""
ALIASES += "generalizes=\xrefitem generalizess \"Generalizes\" \"Generalizes\""
ALIASES += "hasModel=\xrefitem asModelss \"Has Models\" \"Has Models\""
ALIASES += "debug=\xrefitem debugs \"Debug\" \"Debug\""
@ -536,7 +537,7 @@ SORT_GROUP_NAMES = NO
# Note: This option applies only to the class list, not to the
# alphabetical list.
SORT_BY_SCOPE_NAME = NO
SORT_BY_SCOPE_NAME = YES
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
# do proper type resolution of all parameters of a function it will reject a
@ -721,7 +722,7 @@ EXCLUDE_SYMLINKS = NO
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = */Unsupported/*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
@ -836,7 +837,7 @@ USE_HTAGS = NO
# will generate a verbatim copy of the header file for each class for
# which an include is specified. Set to NO to disable this.
VERBATIM_HEADERS = YES
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index

11
Documentation/DoxygenLayout.xml
View File

@ -1,16 +1,17 @@
<doxygenlayout version="1.0">
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title=""/>
<tab type="user" url="@ref packages" title="Packages"/>
<tab type="pages" visible="yes" title="" intro=""/>
<tab type="mainpage" visible="yes" title="CGAL"/>
<tab type="user" url="@ref general_intro" title="General Introduction"/>
<tab type="user" url="@ref packages" title="Package Overview"/>
<tab type="pages" visible="no" title="" intro=""/>
<tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespaces" visible="no" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classes" visible="yes" title="Class Index">
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>

11
Documentation/DoxygenLayoutPackage.xml
View File

@ -1,14 +1,12 @@
<doxygenlayout version="1.0">
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title=""/>
<tab type="user" url="../../CGAL.CGAL/html/index.html" title="CGAL"/>
<tab type="user" url="../../CGAL.CGAL/html/packages.html" title="Package Overview"/>
<tab type="mainpage" visible="yes" title="User Manual"/>
<!-- <tab type="user" url="@ref packagemodule" title="Reference"/> -->
<tab type="modules" visible="yes" title="" intro=""/>
<tab type="modules" visible="yes" title="Reference Manual" intro=" "/>
<tab type="pages" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
@ -20,7 +18,6 @@
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
<tab type="user" url="../../CGAL.CGAL/html/packages.html" title="Packages"/>
</navindex>
<!-- Layout definition for a class page -->

29
Documentation/doc/main.txt
View File

@ -6,10 +6,10 @@
\attention See something? Fix it.
CGAL
%CGAL
====
The goal of the CGAL Open Source Project is to provide easy access to
The goal of the %CGAL Open Source Project is to provide easy access to
efficient and reliable geometric algorithms in the form of a C++
library. CGAL is used in various areas needing geometric computation,
such as: computer graphics, scientific visualization, computer aided
@ -18,7 +18,7 @@ biology, medical imaging, robotics and motion planning, mesh
generation, numerical methods... More on the projects using CGAL web
page.
The Computational Geometry Algorithms Library (CGAL), offers data
The Computational Geometry Algorithms Library (%CGAL), offers data
structures and algorithms like triangulations (2D constrained
triangulations and Delaunay triangulations in 2D and 3D, periodic
triangulations in 3D), Voronoi diagrams (for 2D and 3D points, 2D
@ -40,29 +40,28 @@ structures.
All these data structures and algorithms operate on geometric objects
like points and segments, and perform geometric tests on them. These
objects and predicates are regrouped in CGAL Kernels.
objects and predicates are regrouped in %CGAL Kernels.
Finally, the Support Library offers geometric object generators and
spatial sorting functions, as well as a matrix search framework and a
solver for linear and quadratic programs. It further offers interfaces
to third party software such as the GUI libraries Qt, Geomview, and
the Boost Graph Library. License
the Boost Graph Library.
CGAL is distributed under a dual-license scheme. CGAL can be used
together with Open Source software free of charge. Using CGAL in other
contexts can be done by obtaining a commercial license from
GeometryFactory. For more details see the License page.
%CGAL is distributed under a dual-license scheme. %CGAL can be used
together with Open Source software free of charge. Using %CGAL in
other contexts can be done by obtaining a commercial license from
[GeometryFactory](http://www.geometryfactory.com). For more details
see the \ref licenseIssues License page.
*/
General Introduction
====================
/*!
\page general_intro General Introducion
- \subpage introduction
- \subpage preliminaries
- \subpage installation
Developers Manual
=================
- \subpage dev_manual
*/

4
Documentation/doc/packages.txt
View File

@ -1,6 +1,6 @@
/*!
\page packages Packages
\page packages Package Overview
\tableofcontents
@ -66,7 +66,7 @@
\section PartTriangulationsAndDelaunayTriangulations Triangulations and Delaunay Triangulations
\package_listing{Triangulation_2}
\package_listing{TDS_2}
\package_listing{Triangulation_2/TDS_2}
\package_listing{Triangulation_3}
\package_listing{TriangulationDS_3}
\package_listing{Periodic_3_triangulation_3}

4
Documentation/doxyassist.xml
View File

@ -688,9 +688,9 @@ namespace for the XML file to be processed properly. -->
</list>
</doxygen>
</project>
<!-- subprojects end -->
subprojects end
</project>
<!-- The main CGAL project containing the package list and complete reference documentation -->
<project>
<namespace>CGAL</namespace>

2
Documentation/stylesheet.css
View File

@ -971,7 +971,7 @@ dl.note
border-color: #D0C000;
}
dl.warning, dl.attention
dl.warning, dl.attention, dl.advanceds
{
margin-left:-7px;
padding-left: 3px;

11
Kernel_23/doc/Kernel_23/CGAL/Line_2.h
View File

@ -1,3 +1,4 @@
namespace CGAL {
/*!
\ingroup PkgKernel23
@ -24,17 +25,15 @@ plane \f$ \E^2\f$. Their
dimension and the fact that they are Cartesian is expressed by
the suffix `_2` and the representation type `Cartesian`.
<PRE>[cccbegin]
\code
Point_2< Cartesian<double> > p(1.0,1.0), q(4.0,7.0);
</PRE>
\endcode
To define a line \f$ l\f$ we write:
<PRE>
\code
Line_2< Cartesian<double> > l(p,q);
</PRE>
\endcode
\sa `Kernel::Line_2`

20
Kernel_23/doc/Kernel_23/CGAL/global_functions.h
View File

@ -815,11 +815,6 @@ Depending on which \cgal kernel is used,
different versions of this global function are available. This is
described below.
<b>With the basic 2D and 3D Kernel</b> (see Chapter \ref chapterkernel23)
\anchor figcompare_x
\image html compare1.gif
\sa `CGAL::compare_xy`
\sa `CGAL::compare_xyz`
\sa `CGAL::compare_x_at_y`
@ -829,6 +824,14 @@ described below.
\sa `CGAL::compare_z`
*/
/// @{
/*!
\name With the basic 2D and 3D Kernel
\anchor figcompare_x
\image html compare1.gif
*/
/// @{
/*!
compares the \f$ x\f$-coordinates of \f$ p\f$ and \f$ q\f$.
*/
@ -868,6 +871,8 @@ Comparison_result compare_x(const Line_2<Kernel> &l1,
const Line_2<Kernel> &h1,
const Line_2<Kernel> &h2);
/// @}
/*!
\name With the 2D Circular Kernel
@ -2051,8 +2056,7 @@ Point_3<Kernel> operator-(const Point_3<Kernel> &p, const Vector_3<Kernel> &v);
/// @{
/*!
returns the point obtained by translating `p` by
vector `v`.
returns the point obtained by translating `p` by vector `v`.
*/
Point_2<Kernel> operator+(const Point_2<Kernel> &p,
const Vector_2<Kernel> &v);
@ -2066,7 +2070,7 @@ const Vector_3<Kernel> &v);
/// @}
/// \addtogroup operatormult operator
/// \addtogroup operatormult operator\*
/// \ingroup PkgKernel23
/// \sa `CGAL::operator+`
/// \sa `CGAL::operator-`

2
Kernel_23/doc/Kernel_23/PackageDescription.txt
View File

@ -24,7 +24,7 @@
\PkgDesc{This package contains kernels each containing objects of constant size, such as point, vector, direction, line, ray, segment, circle as well as predicates and constructions for these objects. The kernels mainly differ in the way they handle robustness issues.}
\PkgSince{0.9}
\cgalbib{ cgal:bfghhkps-lgk23-12 }
\license{ Label \ref licensesLGPL "LGPL" }
\license{ \ref licensesLGPL "LGPL" }
\PkgDescriptionEnd
*/