diff --git a/.gitattributes b/.gitattributes index 763068181df..6a09eb25958 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1568,6 +1568,7 @@ Documentation/doc/Installation.txt -text Documentation/doc/Introduction.txt -text Documentation/doc/Preliminaries.txt -text Documentation/doc/main.txt -text +Documentation/doc/packages.txt -text Documentation/doxyassist.xml -text svneol=unset#application/xml Documentation/footer.html -text Documentation/header.html -text diff --git a/Documentation/Doxyfile b/Documentation/Doxyfile index 02362a19fdb..18e0c5cbf01 100644 --- a/Documentation/Doxyfile +++ b/Documentation/Doxyfile @@ -129,7 +129,7 @@ INLINE_INHERITED_MEMB = NO # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = NO +FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is @@ -212,7 +212,7 @@ ALIASES = "sc{1}=\1C++" \ "cpp11=*C++11*" \ "CC=*C++*" \ - "cgalexample{1}=
File \1 \include \1" \ + "cgalexample{1}=
File \ref \1 \include \1" \ "cgalbib{1}=\par \"BibTeX\" \cite \1" \ "license{1}=\par \"License\" \1" \ "models=\xrefitem modelss \"Models\" \"Models\"" \ @@ -224,14 +224,14 @@ ALIASES = "sc{1}=\1

\1

" +ALIASES += "PkgDescriptionBegin{2}=" ALIASES += "PkgPicture{1}=" ALIASES += "PkgAuthor{1}=

\1

\image html \1 \"\" \author \1" ALIASES += "PkgAuthors{1}=\authors \1" ALIASES += "PkgDesc{1}=\par \"Description\" \1" ALIASES += "PkgSince{1}=\since \cgal \1" -ALIASES += "PkgUserManual{1}=\ref \1 \"User Manual\"" ALIASES += "PkgDescriptionEnd=
" +ALIASES += "footnote{1}=\note \1" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding @@ -314,7 +314,7 @@ SIP_SUPPORT = NO # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. -IDL_PROPERTY_SUPPORT = YES +IDL_PROPERTY_SUPPORT = NO # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first @@ -735,7 +735,8 @@ EXCLUDE_SYMBOLS = # and *.h) to filter out the source-files in the directories. If left # blank all files are included. -EXAMPLE_PATTERNS = *.cpp +EXAMPLE_PATTERNS = *.cpp \ + *.h # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude @@ -1579,7 +1580,7 @@ MSCGEN_PATH = # inheritance and usage relations if the target is undocumented # or is not a class. -HIDE_UNDOC_RELATIONS = YES +HIDE_UNDOC_RELATIONS = NO # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization diff --git a/Documentation/DoxygenLayout.xml b/Documentation/DoxygenLayout.xml index 1cdf435f32b..c53a94fdda7 100644 --- a/Documentation/DoxygenLayout.xml +++ b/Documentation/DoxygenLayout.xml @@ -3,7 +3,7 @@ - + diff --git a/Documentation/doc/main.txt b/Documentation/doc/main.txt index 4ea68a4f951..156e735c898 100644 --- a/Documentation/doc/main.txt +++ b/Documentation/doc/main.txt @@ -4,19 +4,10 @@ \attention PRELIMINARY -\attention See something? Fix it. +\attention See something? Fix it. \ref installation -\code{.sh} -cd /path/to/cgal -svn switch ^/branches/features/doxy-port-pmoeller -cd Documentation/doc -doxygen Doxyfile -firefox html/index.html -# fix, build, repeat -\endcode - 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, @@ -62,55 +53,3 @@ contexts can be done by obtaining a commercial license from GeometryFactory. For more details see the License page. */ - -/*! - -\page packages Packages - -\tableofcontents - -\section general_introduction I General Introduction - -1. \ref introduction -2. \ref preliminaries -3. \ref installation - -\section PartAlgebraicFoundations II Arithmetic and Algebra - -\section PartCombinatorialAlgorithms III Combinatorial Algorithms - -\section PartKernels IV Geometry Kernels - -\section PartConvexHullAlgorithms V Convex Hull Algorithms - -\section PartPolygons VI Polygons - -\section PartPolyhedra VII Cell Complexes and Polyhedra - -\section PartArrangements VIII Arrangements - -\section PartTriangulationsAndDelaunayTriangulations IX Triangulations and Delaunay Triangulations - -\section PartVoronoiDiagrams X Voronoi Diagrams - -\section PartMeshing XI Mesh Generation - -\package_listing{Mesh_2} -\package_listing{Mesh_3} - -\section PartGeometryProcessing XII Geometry Processing - -\section PartSearchStructures XIII Spatial Searching and Sorting - -\section PartGeometricOptimization XIV Geometric Optimization - -\section PartInterpolation XV Interpolation - -\section PartKineticDataStructures XVI Kinetic Data Structures - -\section PartSupportLibrary XVII Support Library - -\section PartVisualization XVIII Visualization - -*/ - diff --git a/Documentation/doc/packages.txt b/Documentation/doc/packages.txt new file mode 100644 index 00000000000..f265c794115 --- /dev/null +++ b/Documentation/doc/packages.txt @@ -0,0 +1,148 @@ +/*! + +\page packages Packages + +\tableofcontents + +\section general_introduction I General Introduction + +1. \ref introduction +2. \ref preliminaries +3. \ref installation + +\section PartAlgebraicFoundations II Arithmetic and Algebra + +\package_listing{Algebraic_foundations} +\package_listing{NumberTypeSupport} +\package_listing{Modular_arithmetic} +\package_listing{Polynomial} +\package_listing{Algebraic_kernel_d} + + +\section PartCombinatorialAlgorithms III Combinatorial Algorithms + +\package_listing{Matrix_search} +\package_listing{QP_solver} + +\section PartKernels IV Geometry Kernels + +\package_listing{Kernel_23} +\package_listing{Kernel_d} +\package_listing{Circular_kernel_2} +\package_listing{Circular_kernel_3} + +\section PartConvexHullAlgorithms V Convex Hull Algorithms + +\package_listing{Convex_hull_2} +\package_listing{Convex_hull_3} +\package_listing{Convex_hull_d} + + +\section PartPolygons VI Polygons + +\package_listing{Polygon} +\package_listing{Boolean_set_operations_2} +\package_listing{Nef_2} +\package_listing{Nef_S2} +\package_listing{Partition_2} +\package_listing{Straight_skeleton_2} +\package_listing{Minkowski_sum_2} + + +\section PartPolyhedra VII Cell Complexes and Polyhedra + +\package_listing{Polyhedron} +\package_listing{HalfedgeDS} +\package_listing{Combinatorial_map} +\package_listing{Linear_cell_complex} +\package_listing{Nef_3} +\package_listing{Convex_decomposition_3} +\package_listing{Minkowski_sum_3} + + +\section PartArrangements VIII Arrangements + +\package_listing{Arrangement_on_surface_2} +\package_listing{Sweep_line_2} +\package_listing{Snap_rounding_2} + +\package_listing{Envelope_2} +\package_listing{Envelope_3} + +\section PartTriangulationsAndDelaunayTriangulations IX Triangulations and Delaunay Triangulations + +\package_listing{Triangulation_2} +\package_listing{TDS_2} +\package_listing{Triangulation_3} +\package_listing{TriangulationDS_3} +\package_listing{Periodic_3_triangulation_3} +\package_listing{Alpha_shapes_2} +\package_listing{Alpha_shapes_3} + +\section PartVoronoiDiagrams X Voronoi Diagrams + +\package_listing{Segment_Delaunay_graph_2} +\package_listing{Apollonius_graph_2} +\package_listing{Voronoi_diagram_2} + +\section PartMeshing XI Mesh Generation + +\package_listing{Mesh_2} +\package_listing{Surface_mesher} +\package_listing{Surface_reconstruction_points_3} +\package_listing{Skin_surface_3} +\package_listing{Mesh_3} + +\section PartGeometryProcessing XII Geometry Processing + +\package_listing{Subdivision_method_3} +\package_listing{Surface_mesh_simplification} +\package_listing{Surface_mesh_parameterization} +\package_listing{Stream_lines_2} +\package_listing{Ridges_3} +\package_listing{Jet_fitting_3} +\package_listing{Point_set_processing_3} + +\section PartSearchStructures XIII Spatial Searching and Sorting + +\package_listing{Point_set_2} +\package_listing{Interval_skip_list} +\package_listing{Spatial_searching} +\package_listing{SearchStructures} +\package_listing{Box_intersection_d} +\package_listing{AABB_tree} +\package_listing{Spatial_sorting} + +\section PartGeometricOptimization XIV Geometric Optimization + +\package_listing{Bounding_volumes} +\package_listing{Inscribed_areas} +\package_listing{Polytope_distance_d} +\package_listing{Principal_component_analysis} + +\section PartInterpolation XV Interpolation + +\package_listing{Interpolation} + +\section PartKineticDataStructures XVI Kinetic Data Structures + +\package_listing{Kinetic_data_structures} +\package_listing{Kinetic_framework} + +\section PartSupportLibrary XVII Support Library + +\package_listing{STL_Extension} +\package_listing{BGL} +\package_listing{Property_map} +\package_listing{Circulator} +\package_listing{Generator} +\package_listing{Miscellany} +\package_listing{IOstream} + +\section PartVisualization XVIII Visualization + +\package_listing{Geomview} +\package_listing{GraphicsView} +\package_listing{CGAL_ipelets} + +*/ diff --git a/Documentation/doxyassist.xml b/Documentation/doxyassist.xml index 49c2f1493fb..c3b26f9582c 100644 --- a/Documentation/doxyassist.xml +++ b/Documentation/doxyassist.xml @@ -29,15 +29,42 @@ ./tags/Manual.tag + ../Convex_hull_2/examples *.txt=./txt_filter.sh + + ../STL_Extension/doc/STL_Extension/fig + ../Mesh_2/doc/Mesh_2/fig + ../Mesh_3/doc/Mesh_3/fig + ../HalfedgeDS/doc/HalfedgeDS/fig + ../Convex_hull_2/doc/Convex_hull_2/fig + ../Convex_hull_3/doc/Convex_hull_3/fig + ../Convex_hull_d/doc/Convex_hull_d/fig + ../Straight_skeleton_2/doc/Straight_skeleton_2/fig + ../Partition_2/doc/Partition_2/fig + ../Convex_decomposition_3/doc/Convex_decomposition_3/fig + ../Point_set_2/doc/Point_set_2/fig + ../Interval_skip_list/doc/Interval_skip_list/fig + ../Envelope_2/doc/Envelope_2/fig + ../Envelope_3/doc/Envelope_3/fig + ../Minkowski_sum_2/doc/Minkowski_sum_2/fig + ../Minkowski_sum_3/doc/Minkowski_sum_3/fig + ../Box_intersection_d/doc/Box_intersection_d/fig + + - ./tags/Mesh_2.tag=../../CGAL.CGAL.Mesh-2/html - ./tags/Mesh_3.tag=../../CGAL.CGAL.Mesh-3/html - ./tags/STL_Extension.tag=../../CGAL.CGAL.STL-Extension/html + ./tags/STL_Extension.tag=../../CGAL.CGAL.STL_Extension/html + ./tags/Mesh_2.tag=../../CGAL.CGAL.Mesh_2/html + ./tags/Mesh_3.tag=../../CGAL.CGAL.Mesh_3/html + ./tags/HalfedgeDS.tag=../../CGAL.CGAL.HalfedgeDS/html + ./tags/Convex_hull_2.tag=../../CGAL.CGAL.Convex_hull_2/html + ./tags/Convex_hull_3.tag=../../CGAL.CGAL.Convex_hull_3/html + ./tags/Convex_hull_d.tag=../../CGAL.CGAL.Convex_hull_d/html + ./tags/Straight_skeleton_2.tag=../../CGAL.CGAL.Straight_skeleton_2/html + ./tags/Partition_2.tag=../../CGAL.CGAL.Partition_2/html true false @@ -61,7 +88,7 @@ - STL Extension + STL_Extension CGAL ../STL_Extension/doc @@ -76,7 +103,7 @@ - Mesh 2 + Mesh_2 false ../Mesh_2/doc @@ -91,7 +118,7 @@ - Mesh 3 + Mesh_3 false ../Mesh_3/doc @@ -210,7 +237,202 @@ + + Convex_decomposition_3 + false + ../Convex_decomposition_3/include + ../Convex_decomposition_3/doc/Convex_decomposition_3 + + ../Convex_decomposition_3/include + ./tags/Convex_decomposition_3.tag + ../Convex_decomposition_3/examples + ../Convex_decomposition_3/doc/Convex_decomposition_3/fig + + false + false + true + + + + + Point_set_2 + false + ../Point_set_2/doc/Point_set_2 + + ../Point_set_2/doc/Point_set_2/ + ./tags/Point_set_2.tag + ../Point_set_2/examples + ../Point_set_2/doc/Point_set_2/fig + + false + + + + + Interval_skip_list + false + ../Interval_skip_list/doc/Interval_skip_list + + ../Interval_skip_list/doc/Interval_skip_list/ + ./tags/Interval_skip_list.tag + ../Interval_skip_list/examples + ../Interval_skip_list/doc/Interval_skip_list/fig + + false + + + + + Envelope_2 + false + ../Envelope_2/doc/Envelope_2 + + ../Envelope_2/doc/Envelope_2/ + ./tags/Envelope_2.tag + ../Envelope_2/examples + ../Envelope_2/doc/Envelope_2/fig + + false + + + + + Envelope_3 + false + ../Envelope_3/doc/Envelope_3 + + ../Envelope_3/doc/Envelope_3/ + ./tags/Envelope_3.tag + ../Envelope_3/examples + ../Envelope_3/doc/Envelope_3/fig + + false + + + + + Minkowski_sum_2 + false + ../Minkowski_sum_2/doc/Minkowski_sum_2 + + ../Minkowski_sum_2/doc/Minkowski_sum_2/ + ./tags/Minkowski_sum_2.tag + ../Minkowski_sum_2/examples + ../Minkowski_sum_2/doc/Minkowski_sum_2/fig + + ./tags/Polygon.tag=../../CGAL.CGAL.Polygon/html + + false + + + + + Minkowski_sum_3 + false + ../Minkowski_sum_3/doc/Minkowski_sum_3 + + ../Minkowski_sum_3/doc/Minkowski_sum_3/ + ./tags/Minkowski_sum_3.tag + ../Minkowski_sum_3/examples + ../Minkowski_sum_3/doc/Minkowski_sum_3/fig + + + false + + + + + Generator + false + ../Generator/doc/Generator + + ../Generator/doc/Generator/ + ./tags/Generator.tag + ../Generator/examples + ../Generator/doc/Generator/fig + + + false + + + + + Geomview + false + ../Geomview/doc/Geomview + + ../Geomview/doc/Geomview/ + ./tags/Geomview.tag + ../Geomview/demo + + + false + + + + + Spatial_searching + false + ../Spatial_searching/doc/Spatial_searching + + ../Spatial_searching/doc/Spatial_searching/ + ./tags/Spatial_searching.tag + ../Spatial_searching/examples + + + false + + + + + Box_intersection_d + false + ../Box_intersection_d/doc/Box_intersection_d + + ../Box_intersection_d/doc/Box_intersection_d/ + ./tags/Box_intersection_d.tag + ../Box_intersection_d/examples + ../Box_intersection_d/doc/Box_intersection_d/fig + + + false + + + + + GraphicsView + false + ../GraphicsView/doc/GraphicsView + + ../GraphicsView/doc/GraphicsView/ + ../GraphicsView/doc/GraphicsView/ + ./tags/GraphicsView.tag + ../GraphicsView/examples + ../GraphicsView/doc/GraphicsView/fig + + + false + + + + + Miscellany + false + ../Miscellany/doc/Miscellany + + ../Miscellany/doc/Miscellany/ + ../Miscellany/doc/Miscellany/ + ./tags/Miscellany.tag + ../Miscellany/examples + ../Miscellany/doc/Miscellany/fig + + + false + + + + diff --git a/Documentation/txt_filter.sh b/Documentation/txt_filter.sh index 3dc1a0b0857..af914c46077 100755 --- a/Documentation/txt_filter.sh +++ b/Documentation/txt_filter.sh @@ -4,7 +4,7 @@ while read -r line do pkg=$(echo ${line} | sed -n '/\\package_listing{[^}]*}/p' | sed 's/\\package_listing{\([^}]*\)}/\1/') if [ -n "${pkg}" ]; then - cat "../${pkg}/doc/${pkg}/PackageDescription.txt" | sed -n '/PkgDescriptionBegin/,/PkgDescriptionEnd/p' + cat "../${pkg}/doc/${pkg}/PackageDescription.txt" | sed -n '/PkgDescriptionBegin/,/PkgDescriptionEnd/p' | sed "s/\(\\PkgDescriptionBegin{[^}]*\)}/\1,${pkg}}/" else echo -E "${line}" fi diff --git a/Mesh_2/doc/Mesh_2/Mesh_2.txt b/Mesh_2/doc/Mesh_2/Mesh_2.txt index 0b148ad4034..d09f8cc0301 100644 --- a/Mesh_2/doc/Mesh_2/Mesh_2.txt +++ b/Mesh_2/doc/Mesh_2/Mesh_2.txt @@ -1,4 +1,3 @@ - namespace CGAL { /*! diff --git a/Mesh_2/doc/Mesh_2/PackageDescription.txt b/Mesh_2/doc/Mesh_2/PackageDescription.txt index 041900a31a1..b9a88c347d9 100644 --- a/Mesh_2/doc/Mesh_2/PackageDescription.txt +++ b/Mesh_2/doc/Mesh_2/PackageDescription.txt @@ -6,15 +6,12 @@ \addtogroup PkgMesh2 \todo check generated documentation \PkgDescriptionBegin{2D Conforming Triangulations and Meshes} -\PkgPicture{delaunaymesh-small.png} +\PkgPicture{Mesh_2/fig/delaunaymesh-small.png} \PkgAuthor{Laurent Rineau} \PkgDesc{This package implements a Delaunay refinement algorithm to construct conforming triangulations and 2D meshes. Conforming Delaunay triangulations are obtained from constrained Delaunay triangulations by refining constrained edges until they are Delaunay edges. Conforming Gabriel triangulations are obtained by further refining constrained edges until they become Gabriel edges. The package provides also a 2D mesh generator that refines triangles and constrained edges until user defined size and shape criteria on triangles are satisfied. The package can handle intersecting input constraints and set no restriction on the angle formed by two constraints sharing an endpoint.} \PkgSince{3.1} \cgalbib{ cgal:r-ctm2-12 } -\license{ \ref licensesGPL GPL } -\PkgUserManual{user_chapter_2D_Meshes} +\license{ \ref licensesGPL } \PkgDescriptionEnd - - */ diff --git a/STL_Extension/doc/STL_Extension/PackageDescription.txt b/STL_Extension/doc/STL_Extension/PackageDescription.txt index 4806d02ac92..5ef7455b9a7 100644 --- a/STL_Extension/doc/STL_Extension/PackageDescription.txt +++ b/STL_Extension/doc/STL_Extension/PackageDescription.txt @@ -15,7 +15,7 @@ \cgalbib{ cgal:hkpw-se-12 } -\license{ \ref licensesLGPL LGPL } +\license{ \ref licensesLGPL } \par Resources: \ref stl_ext_user "User Manual"