add skeleton for K-visibility package

sloriot · Aug 16, 2023 · 9896492 · 9896492
1 parent b534d12
commit 9896492
Show file tree

Hide file tree

Showing 12 changed files with 74 additions and 0 deletions.
diff --git a/Documentation/doc/Documentation/packages.txt b/Documentation/doc/Documentation/packages.txt
@@ -40,6 +40,7 @@
 \package_listing{Polyline_simplification_2}
 \package_listing{Visibility_2}
 \package_listing{Set_movable_separability_2}
+\package_listing{K_visibility}
 
 
 \cgalPackageSection{PartPolyhedra,Cell Complexes and Polyhedra}

diff --git a/K_visibility/doc/K_visibility/Doxyfile.in b/K_visibility/doc/K_visibility/Doxyfile.in
@@ -0,0 +1,4 @@
+@INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS}
+
+PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - K-visibility"
+
diff --git a/K_visibility/doc/K_visibility/K_visibility.txt b/K_visibility/doc/K_visibility/K_visibility.txt
@@ -0,0 +1,27 @@
+namespace CGAL {
+/*!
+
+\mainpage User Manual
+\anchor Chapter_K_Visibility
+
+\cgalAutoToc
+\author AUTHOR1, AUTHOR2, and AUTHOR3
+
+This chapter describes the ...
+
+\section secmydefinitions Definitions
+
+Section on definitions here ...
+
+\section secmyexamples Examples
+
+\subsection myFirstExample First Example
+
+The following example shows ...
+
+\cgalFigureBegin{figPck,bench.png}
+Left: ...
+\cgalFigureEnd
+
+*/
+} /* namespace CGAL */
diff --git a/K_visibility/doc/K_visibility/PackageDescription.txt b/K_visibility/doc/K_visibility/PackageDescription.txt
@@ -0,0 +1,30 @@
+/// \defgroup PkgKvisibilityRef K-visibility Reference
+
+/*!
+\addtogroup PkgKvisibilityRef
+\todo check generated documentation
+
+\cgalPkgDescriptionBegin{K-visibility,PkgKvisibility}
+\cgalPkgPicture{pkg-small.png}
+
+\cgalPkgSummaryBegin
+\cgalPkgAuthors{PACKAGE AUTHOR}
+\cgalPkgDesc{The package provides ... }
+\cgalPkgManuals{Chapter_K_Visibility,PkgKvisibility}
+\cgalPkgSummaryEnd
+
+\cgalPkgShortInfoBegin
+\cgalPkgSince{6.1}
+\cgalPkgBib{cgal:x-x}
+\cgalPkgLicense{\ref licensesGPL "GPL"}
+\cgalPkgShortInfoEnd
+
+\cgalPkgDescriptionEnd
+
+\cgalClassifedRefPages
+
+\cgalCRPSection{Functions}
+- `CGAL::watch_tower_1_5()`
+
+
+*/
diff --git a/K_visibility/doc/K_visibility/dependencies b/K_visibility/doc/K_visibility/dependencies
@@ -0,0 +1,6 @@
+Manual
+Kernel_23
+STL_Extension
+Algebraic_foundations
+Circulator
+Stream_support
diff --git a/K_visibility/doc/K_visibility/examples.txt b/K_visibility/doc/K_visibility/examples.txt
diff --git a/K_visibility/doc/K_visibility/fig/pkg-small.png b/K_visibility/doc/K_visibility/fig/pkg-small.png
diff --git a/K_visibility/package_info/K_visibility/copyright b/K_visibility/package_info/K_visibility/copyright
@@ -0,0 +1,2 @@
+TODO
+
diff --git a/K_visibility/package_info/K_visibility/description.txt b/K_visibility/package_info/K_visibility/description.txt
@@ -0,0 +1 @@
+TODO
diff --git a/K_visibility/package_info/K_visibility/license.txt b/K_visibility/package_info/K_visibility/license.txt
@@ -0,0 +1 @@
+TODO
diff --git a/K_visibility/package_info/K_visibility/long_description.txt b/K_visibility/package_info/K_visibility/long_description.txt
@@ -0,0 +1 @@
+TODO
diff --git a/K_visibility/package_info/K_visibility/maintainer b/K_visibility/package_info/K_visibility/maintainer
@@ -0,0 +1 @@
+TODO