From ccf90bb2fedbe6dbe1ee317aa7b04cb43024758a Mon Sep 17 00:00:00 2001 From: Iordan Iordanov Date: Fri, 16 Nov 2018 23:29:19 +0100 Subject: [PATCH] Changed documentation to follow new convention for naming scheme of pagkage anchors; added new image file to Doxyfile.in --- .../Doxyfile.in | 3 ++- .../PackageDescription.txt | 20 +++++++++---------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/Doxyfile.in b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/Doxyfile.in index 7a1d3ee65ca..b7edd8e9ac9 100644 --- a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/Doxyfile.in +++ b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/Doxyfile.in @@ -14,7 +14,8 @@ HTML_EXTRA_FILES = ${CGAL_PACKAGE_DOC_DIR}/fig/octagon_identification.svg \ ${CGAL_PACKAGE_DOC_DIR}/fig/ds_cgal.svg \ ${CGAL_PACKAGE_DOC_DIR}/fig/dummy-points.png \ ${CGAL_PACKAGE_DOC_DIR}/fig/non-triangulation.svg \ - ${CGAL_PACKAGE_DOC_DIR}/fig/histogram-dummy-points.png + ${CGAL_PACKAGE_DOC_DIR}/fig/histogram-dummy-points.png \ + ${CGAL_PACKAGE_DOC_DIR}/fig/new-triangulation-350px.png HTML_EXTRA_STYLESHEET = ${CGAL_PACKAGE_DOC_DIR}/css/customstyle.css diff --git a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt index bdfc514f77f..adb20ec075f 100644 --- a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt +++ b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt @@ -1,25 +1,25 @@ -/// \defgroup PkgPeriodic4HyperbolicTriangulation2 2D Periodic Hyperbolic Triangulations Reference +/// \defgroup PkgPeriodic4HyperbolicTriangulation2Ref 2D Periodic Hyperbolic Triangulations Reference /// \defgroup PkgPeriodic4HyperbolicTriangulation2Concepts Concepts -/// \ingroup PkgPeriodic4HyperbolicTriangulation2 +/// \ingroup PkgPeriodic4HyperbolicTriangulation2Ref /// \defgroup PkgPeriodic4HyperbolicTriangulation2MainClasses Main Classes -/// \ingroup PkgPeriodic4HyperbolicTriangulation2 +/// \ingroup PkgPeriodic4HyperbolicTriangulation2Ref /// \defgroup PkgPeriodic4HyperbolicTriangulation2TraitsClasses Traits Classes -/// \ingroup PkgPeriodic4HyperbolicTriangulation2 +/// \ingroup PkgPeriodic4HyperbolicTriangulation2Ref /// \defgroup PkgPeriodic4HyperbolicTriangulation2VertexFaceClasses Vertex and Face Base Classes -/// \ingroup PkgPeriodic4HyperbolicTriangulation2 +/// \ingroup PkgPeriodic4HyperbolicTriangulation2Ref /// \defgroup PkgPeriodic4HyperbolicTriangulation2HyperbolicTranslationsClasses Hyperbolic Translations Classes -/// \ingroup PkgPeriodic4HyperbolicTriangulation2 +/// \ingroup PkgPeriodic4HyperbolicTriangulation2Ref /*! -\addtogroup PkgPeriodic4HyperbolicTriangulation2 +\addtogroup PkgPeriodic4HyperbolicTriangulation2Ref -\cgalPkgDescriptionBegin{2D Periodic Hyperbolic Triangulations,PkgPeriodic4HyperbolicTriangulation2Summary} +\cgalPkgDescriptionBegin{2D Periodic Hyperbolic Triangulations,PkgPeriodic4HyperbolicTriangulation2} \cgalPkgPicture{Periodic_4_hyperbolic_triangulation_2/fig/new-triangulation-120px.png} \cgalPkgSummaryBegin @@ -28,12 +28,12 @@ hyperbolic Bolza surface. Triangulations are built incrementally and can be modified by insertion or removal of vertices. Point location facilities are also offered. The package provides Delaunay triangulations and offers primitives to build the dual Voronoi diagrams.} -\cgalPkgManuals{Chapter_2D_Periodic_Hyperbolic_Triangulations,PkgPeriodic4HyperbolicTriangulation2} +\cgalPkgManuals{Chapter_2D_Periodic_Hyperbolic_Triangulations,PkgPeriodic4HyperbolicTriangulation2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.14} -\cgalPkgDependsOn{\ref PkgHyperbolicTriangulation2Summary} +\cgalPkgDependsOn{\ref PkgHyperbolicTriangulation2} \cgalPkgBib{cgal:i-p4ht2-17} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Periodic Hyperbolic Delaunay Triangulation,Periodic_4_hyperbolic_Delaunay_triangulation_2.zip}