standardising headers of each file

yossibokorbleile · Oct 20, 2023 · 9ed6454 · 9ed6454
1 parent 93e9671
commit 9ed6454
Show file tree

Hide file tree

Showing 24 changed files with 27 additions and 1 deletion.
diff --git a/Doxyfile b/Doxyfile
@@ -62,7 +62,7 @@ PROJECT_BRIEF          = "C++ library with Python bindings to analyse the shape\
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = 
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is

diff --git a/include/2DShape.h b/include/2DShape.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 #ifndef _2DSHAPE_H_

diff --git a/include/Comp2D.h b/include/Comp2D.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 #ifndef _COMP2D_H_

diff --git a/include/Comp2DShapes.h b/include/Comp2DShapes.h
@@ -3,6 +3,7 @@
 * @author Patrice Koehl
 * @author Yossi Bokor Bleile
 * @date April 2023
+* @copyright BSD 3-Clause License.
 * @version 1
 */
 #ifndef _COMP2DSHAPES_H_

diff --git a/include/Comp2DShapesFocal.h b/include/Comp2DShapesFocal.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 #ifndef _COMP2DSHAPESFOCAL_H_
 #define _COMP2DSHAPESFOCAL_H_

diff --git a/include/Curvature/include/Curvature.h b/include/Curvature/include/Curvature.h
@@ -4,6 +4,7 @@
 * @author Patrice Koehl
 * @date October 2021
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/include/DataStruct/include/Polygon.h b/include/DataStruct/include/Polygon.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 /* ===========================================================================================

diff --git a/include/DataStruct/include/PolygonBuilder.h b/include/DataStruct/include/PolygonBuilder.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/include/DataStruct/include/Types.h b/include/DataStruct/include/Types.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/include/DataStruct/include/Vector.h b/include/DataStruct/include/Vector.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 #pragma once

diff --git a/include/DataStruct/include/Vector2D.h b/include/DataStruct/include/Vector2D.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 /*********************************************************************************

diff --git a/include/DataStruct/include/Vertex.h b/include/DataStruct/include/Vertex.h
@@ -4,6 +4,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/include/InOut/include/InOut.h b/include/InOut/include/InOut.h
@@ -5,6 +5,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 #ifndef _INOUT_H_

diff --git a/include/Metrics/include/Convex.h b/include/Metrics/include/Convex.h
@@ -5,6 +5,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/include/Metrics/include/Ellipse.h b/include/Metrics/include/Ellipse.h
@@ -5,6 +5,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 #ifndef _ELLIPSE_H_

diff --git a/include/Metrics/include/Frechet.h b/include/Metrics/include/Frechet.h
@@ -5,6 +5,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/include/OT1/include/VectorOps.h b/include/OT1/include/VectorOps.h
@@ -4,6 +4,7 @@
 * @author Patrice Koehl
 * @date 11/12/2018
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 #ifndef _VECTOROPS_H_

diff --git a/include/PH0/include/Component.h b/include/PH0/include/Component.h
@@ -5,6 +5,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/include/PH0/include/PH0.h b/include/PH0/include/PH0.h
@@ -5,6 +5,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 #ifndef _PH0_H

diff --git a/include/PH0/include/PersistenceDiagram.h b/include/PH0/include/PersistenceDiagram.h
@@ -5,6 +5,7 @@
 * @author Yossi Bokor Bleile
 * @date January 2022
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 #ifndef _PERSISTENCEDIAGRAM_H_

diff --git a/include/correa_bindings.h b/include/correa_bindings.h
@@ -1,10 +1,12 @@
 /*!
 * @file correa_bindgins.h
 * @brief create bindings for Correa.
+* @details Generate the Python bindings for Correa using nanobind. In particular the functions to comppare two polygons.
 * @author Patrice Koehl
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/src/2DShape.cpp b/src/2DShape.cpp
@@ -1,10 +1,12 @@
 /*!
 * @file	2DShape.cpp
 * @brief extract infromation about a polygon
+* @details Given a polygon stored in a file, calculate the following information about the polygon: length, area, sphericity, maximum volume inscribed ellipse, minimum volume inscribing ellipse, least square ellipse, Willmore energy, and the dimension 0 persistence diagram with essential pairing of the essential 0-cycle and essential 1-cycle.
 * @author Patrice Koehl
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/src/Comp2DShapes.cpp b/src/Comp2DShapes.cpp
@@ -5,6 +5,7 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
 */
 
 

diff --git a/src/Comp2DShapesFocal.cpp b/src/Comp2DShapesFocal.cpp
@@ -5,6 +5,8 @@
 * @author Yossi Bokor Bleile
 * @date April 2023
 * @version 1
+* @copyright BSD 3-Clause License.
+* @copyright BSD 3-Clause License.
 */