From 34b71f7920c7b33c3177846d7e5069eb39ffeb60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20M=C3=B6ller?= Date: Thu, 23 Aug 2012 14:00:05 +0000 Subject: [PATCH] Layout juggling, configuration refinement --- Documentation/Doxyfile | 9 +++--- Documentation/DoxygenLayout.xml | 11 +++---- Documentation/DoxygenLayoutPackage.xml | 11 +++---- Documentation/doc/main.txt | 29 +++++++++---------- Documentation/doc/packages.txt | 4 +-- Documentation/doxyassist.xml | 4 +-- Documentation/stylesheet.css | 2 +- Kernel_23/doc/Kernel_23/CGAL/Line_2.h | 11 ++++--- .../doc/Kernel_23/CGAL/global_functions.h | 20 ++++++++----- .../doc/Kernel_23/PackageDescription.txt | 2 +- 10 files changed, 52 insertions(+), 51 deletions(-) diff --git a/Documentation/Doxyfile b/Documentation/Doxyfile index 3261740c290..86d65e099e8 100644 --- a/Documentation/Doxyfile +++ b/Documentation/Doxyfile @@ -219,9 +219,10 @@ ALIASES = "sc{1}=\1 - - - + + + + - + - + diff --git a/Documentation/DoxygenLayoutPackage.xml b/Documentation/DoxygenLayoutPackage.xml index 7e79b8a3a28..1f85837e134 100644 --- a/Documentation/DoxygenLayoutPackage.xml +++ b/Documentation/DoxygenLayoutPackage.xml @@ -1,14 +1,12 @@ - + + + - + - - - - @@ -20,7 +18,6 @@ - diff --git a/Documentation/doc/main.txt b/Documentation/doc/main.txt index c2d30d344e2..79e91df3e82 100644 --- a/Documentation/doc/main.txt +++ b/Documentation/doc/main.txt @@ -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 */ diff --git a/Documentation/doc/packages.txt b/Documentation/doc/packages.txt index 61bff0ea98e..0030cdd6e79 100644 --- a/Documentation/doc/packages.txt +++ b/Documentation/doc/packages.txt @@ -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} diff --git a/Documentation/doxyassist.xml b/Documentation/doxyassist.xml index 727f517a8d6..d7b13b82391 100644 --- a/Documentation/doxyassist.xml +++ b/Documentation/doxyassist.xml @@ -688,9 +688,9 @@ namespace for the XML file to be processed properly. --> - + subprojects end - + CGAL diff --git a/Documentation/stylesheet.css b/Documentation/stylesheet.css index 0fa6d4887d9..d4ff1446b30 100644 --- a/Documentation/stylesheet.css +++ b/Documentation/stylesheet.css @@ -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; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Line_2.h b/Kernel_23/doc/Kernel_23/CGAL/Line_2.h index 428b6019c14..175e4991836 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Line_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Line_2.h @@ -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`. -
[cccbegin] 
-
+\code
 Point_2< Cartesian > p(1.0,1.0), q(4.0,7.0); 
-
+\endcode To define a line \f$ l\f$ we write: -
 
-
+\code
 Line_2< Cartesian > l(p,q); 
-
+\endcode \sa `Kernel::Line_2` diff --git a/Kernel_23/doc/Kernel_23/CGAL/global_functions.h b/Kernel_23/doc/Kernel_23/CGAL/global_functions.h index f9cc7db5c7e..a5816e93216 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/global_functions.h +++ b/Kernel_23/doc/Kernel_23/CGAL/global_functions.h @@ -815,11 +815,6 @@ Depending on which \cgal kernel is used, different versions of this global function are available. This is described below. -With the basic 2D and 3D Kernel (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 &l1, const Line_2 &h1, const Line_2 &h2); +/// @} + /*! \name With the 2D Circular Kernel @@ -2051,8 +2056,7 @@ Point_3 operator-(const Point_3 &p, const Vector_3 &v); /// @{ /*! -returns the point obtained by translating `p` by -vector `v`. +returns the point obtained by translating `p` by vector `v`. */ Point_2 operator+(const Point_2 &p, const Vector_2 &v); @@ -2066,7 +2070,7 @@ const Vector_3 &v); /// @} -/// \addtogroup operatormult operator +/// \addtogroup operatormult operator\* /// \ingroup PkgKernel23 /// \sa `CGAL::operator+` /// \sa `CGAL::operator-` diff --git a/Kernel_23/doc/Kernel_23/PackageDescription.txt b/Kernel_23/doc/Kernel_23/PackageDescription.txt index 47320497016..38df3283a20 100644 --- a/Kernel_23/doc/Kernel_23/PackageDescription.txt +++ b/Kernel_23/doc/Kernel_23/PackageDescription.txt @@ -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 */