diff --git a/Doxyfile b/Doxyfile index ae2d759..2b1fdfd 100644 --- 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 index 3964765..97f3b02 100644 --- 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 index 6abfb3f..f04c2ab 100644 --- 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 index 4fc26f3..18ae195 100644 --- 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 index 9b27b69..003fcd3 100644 --- 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 index 32f35c9..740ca7d 100644 --- 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 index c82c760..e242c99 100644 --- 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 index 4f95cc1..fac26b3 100644 --- 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 index 77a970f..a920079 100644 --- 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 index 2ea5d67..7338437 100644 --- 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 index 89b69fb..d7e9e9b 100644 --- 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 index 295ebca..f2e062f 100644 --- 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 index 5d7995f..1bb44c6 100644 --- 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 index efa6e39..8168c42 100644 --- 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 index 26ddaa9..e3f06ba 100644 --- 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 index 5817a71..5ad77cb 100644 --- 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 index 4a0ffd5..1d4e704 100644 --- 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 index 143881b..a7305c2 100644 --- 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 index 9625344..26f66aa 100644 --- 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 index b6be419..75e39ee 100644 --- 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 index 100fe11..9bf24e9 100644 --- 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 index baaed8b..b89d950 100644 --- 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 index 9d5c997..4205075 100644 --- 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 index 6a3d101..10583e3 100644 --- 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. */