The public CGAL repository, see the README below
Go to file
albert-github 245aa559e3 Warnings Mesh_3 regarding non existing file (documentation)
cherry-picked from 72e2c7b27b

Currently we get a number of warnings when building the documentation for Mesh_3:
```
/home/cgal-testsuite/cgal_doc_build/CGAL-5.3.1-I-169/doc/Mesh_3/Mesh_3.txt:743: warning: unable to resolve reference to 'CGAL/Mesh_3/initialize_triangulation_from_labeled_image.h\' for \ref command
/home/cgal-testsuite/cgal_doc_build/CGAL-5.3.1-I-169/doc/Mesh_3/Mesh_3.txt:801: warning: unable to resolve reference to 'Mesh_3/random_labeled_image.h\' for \ref command
/home/cgal-testsuite/cgal_doc_build/CGAL-5.3.1-I-169/doc/Mesh_3/Mesh_3.txt:817: warning: unable to resolve reference to 'CGAL/Mesh_3/initialize_triangulation_from_gray_image.h\' for \ref command
```
Note the backslash at the end of the file name.

Most likely an attempt was made to escape the dot to not have it as part of the filename, though at least in doxygen 1.8.13 a closing dot was not seen as part of the filename.
Looking at the other escape character of doxygen: the commercial at sign, this was apparently working as escape in the filename as well, though in doxygen 1.8.15 this was not the case anymore either.
During one of the last changes also the backslash lost this possibility for this case and this is now consistent.

The current change (removing the backslashes) doesn't look like to alter the behavior for the 1.8.13 and master version in respect to CGAL.
2021-12-27 08:38:49 +01:00
.github Add BUILD_TESTING, for CTest 2021-09-29 18:03:51 +02:00
AABB_tree Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Advancing_front_surface_reconstruction IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Algebraic_foundations Replace more sc text 2021-05-21 15:45:50 +02:00
Algebraic_kernel_d Replace more sc text 2021-05-21 15:45:50 +02:00
Algebraic_kernel_for_circles update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Algebraic_kernel_for_spheres update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Alpha_shapes_2 Merge pull request #5805 from MaelRL/AS23-GT_concept_doc-GT 2021-06-29 15:30:20 +02:00
Alpha_shapes_3 Merge pull request #5805 from MaelRL/AS23-GT_concept_doc-GT 2021-06-29 15:30:20 +02:00
Apollonius_graph_2 Merge remote-tracking branch 'cgal/5.2.x-branch' 2021-06-25 10:05:19 +02:00
Arithmetic_kernel update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Arrangement_on_surface_2 fix warnings about arithmetic operations on enum 2021-11-29 17:59:12 +01:00
BGL Merge pull request #6145 from sloriot/BGL-collapse_edges_with_cst 2021-11-25 17:27:37 +01:00
Barycentric_coordinates_2 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Boolean_set_operations_2 Merge remote-tracking branch 'cgal/5.2.x-branch' 2021-07-19 07:43:32 +02:00
Bounding_volumes move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Box_intersection_d Merge pull request #5692 from maxGimeno/CGAL_cpp11_atomic_and_threads-maxGimeno 2021-05-19 17:23:53 +02:00
CGAL_Core Merge remote-tracking branch 'cgal/5.2.x-branch' into HEAD 2021-11-29 16:03:16 +01:00
CGAL_ImageIO Merge branch '5.1.x-branch' into 5.2.x-branch 2021-06-16 15:30:29 +02:00
CGAL_ipelets Merge pull request #5622 from maxGimeno/CMake-Update_versions_in_scripts-maxGimeno 2021-04-17 10:58:14 +02:00
Cartesian_kernel Merge pull request #5617 from afabri/Nef_3-translation-GF 2021-05-18 18:14:17 +02:00
Circular_kernel_2 move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Circular_kernel_3 Merge branch 'master' into Triangulation_on_sphere_2-GF 2021-04-17 11:22:30 +02:00
Circulator Merge pull request #5622 from maxGimeno/CMake-Update_versions_in_scripts-maxGimeno 2021-04-17 10:58:14 +02:00
Classification Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Combinatorial_map Fix capitalisation of macro name. 2021-04-28 21:03:45 +01:00
Cone_spanners_2 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Convex_decomposition_3 Fix dereference after null check in Reflex_vertex_searcher.h 2021-04-28 09:59:25 +01:00
Convex_hull_2 move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Convex_hull_3 Merge remote-tracking branch 'sloriot/CGAL-restore_rounding_mode' 2021-09-09 11:09:16 +02:00
Convex_hull_d move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Distance_2 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Distance_3 Do not use RT functions in FT functions as it causes a slowdown 2021-05-25 10:46:29 +02:00
Documentation/doc Merge remote-tracking branch 'cgal/5.2.x-branch' into HEAD 2021-09-10 17:50:58 +02:00
Envelope_2 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Envelope_3 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Filtered_kernel Merge pull request #5971 from sloriot/CGAL-restore_rounding_mode 2021-09-20 17:33:40 +02:00
Generalized_map Merge pull request #5622 from maxGimeno/CMake-Update_versions_in_scripts-maxGimeno 2021-04-17 10:58:14 +02:00
Generator Merge pull request #5671 from maxGimeno/CGAL_IO-Add_missing-deprecated_functions-maxGimeno 2021-05-18 18:13:38 +02:00
Geomview Replace more sc text 2021-05-21 15:45:50 +02:00
GraphicsView fix warnings about arithmetic operations on enum 2021-11-29 17:59:12 +01:00
HalfedgeDS IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Hash_map Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Heat_method_3 move function to avoid link error + add missing halfedge function 2021-12-14 18:07:55 +01:00
Homogeneous_kernel fix warnings about arithmetic operations on enum 2021-11-29 17:59:12 +01:00
Hyperbolic_triangulation_2 IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Inscribed_areas update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Installation This branch now targets 5.3.2. 2021-12-14 16:04:23 +01:00
Interpolation Merge pull request #6066 from sloriot/Interpolation-warning 2021-10-29 16:50:06 +02:00
Intersections_2 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Intersections_3 Merge pull request #5680 from afabri/Intersections-fix_RT-GF 2021-05-27 19:12:35 +02:00
Interval_skip_list Merge pull request #5622 from maxGimeno/CMake-Update_versions_in_scripts-maxGimeno 2021-04-17 10:58:14 +02:00
Interval_support update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Jet_fitting_3 Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Kernel_23 Add unit test 2021-05-24 10:08:17 +02:00
Kernel_d move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
LEDA
Linear_cell_complex Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
MacOSX
Maintenance Merge pull request #5984 from MaelRL/FK-Complete_static_filter_profiler_-GF 2021-09-20 17:02:24 +02:00
Matrix_search update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Mesh_2 Merge pull request #5679 from lrineau/Mesh_2-fix_write_VTU_in_ASCII-GF 2021-05-18 17:32:16 +02:00
Mesh_3 Warnings Mesh_3 regarding non existing file (documentation) 2021-12-27 08:38:49 +01:00
Mesher_level fix mismatch between two definitions of Mesher_level_conflict_status 2021-08-25 19:32:13 +02:00
Minkowski_sum_2 Replace more sc text 2021-05-21 15:45:50 +02:00
Minkowski_sum_3 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Miscellany/doc/Miscellany
Modifier update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Modular_arithmetic Replace more sc text 2021-05-21 15:45:50 +02:00
Nef_2 Merge remote-tracking branch 'sloriot/CGAL-restore_rounding_mode' 2021-09-09 11:09:16 +02:00
Nef_3 Merge pull request #6154 from afabri/Nef_3-fix_comparison-GF 2021-12-03 15:25:55 +01:00
Nef_S2 Merge pull request #5699 from GilesBathgate/Nef_3-snc_decorator_deduplication-GilesBathgate 2021-06-25 09:47:59 +02:00
NewKernel_d fix warnings cherry-picked from master targetting 5.4 2021-11-29 18:02:31 +01:00
Number_types Merge pull request #6049 from danston/Number_types-rename_eigen_test-danston 2021-10-29 16:50:11 +02:00
OpenNL
Optimal_bounding_box IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Optimal_transportation_reconstruction_2 Merge pull request #5622 from maxGimeno/CMake-Update_versions_in_scripts-maxGimeno 2021-04-17 10:58:14 +02:00
Optimisation_basic
Orthtree Fix history of Orthtree 2021-04-27 10:03:29 +02:00
Partition_2 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Periodic_2_triangulation_2 move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Periodic_3_mesh_3 fix warnings cherry-picked from master targetting 5.4 2021-11-29 18:02:31 +01:00
Periodic_3_triangulation_3 Merge remote-tracking branch 'cgal/master' into CGAL-Clang_tidy_new_pass-maxGimeno 2021-05-21 14:04:07 +02:00
Periodic_4_hyperbolic_triangulation_2 remove CGAL/result_of.h and move its content to config.h 2021-05-07 12:51:07 +02:00
Point_set_2 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Point_set_3 Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Point_set_processing_3 fix warnings cherry-picked from master targetting 5.4 2021-11-29 18:02:31 +01:00
Poisson_surface_reconstruction_3 Merge pull request #6076 from danston/Documentation-fix_tuto_reconstruction-danston 2021-10-29 16:49:57 +02:00
Polygon move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Polygon_mesh_processing Merge pull request #6047 from MaelRL/PM-Fix_pmaps_reference_types_5.3-GF 2021-10-29 17:39:22 +02:00
Polygonal_surface_reconstruction Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Polyhedron Squash-merge PR #5701 into 5.2.x 2021-11-30 12:14:53 +01:00
Polyline_simplification_2 Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Polynomial Replace more sc text 2021-05-21 15:45:50 +02:00
Polytope_distance_d move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Principal_component_analysis Merge pull request #5622 from maxGimeno/CMake-Update_versions_in_scripts-maxGimeno 2021-04-17 10:58:14 +02:00
Principal_component_analysis_LGPL
Profiling_tools Merge pull request #5692 from maxGimeno/CGAL_cpp11_atomic_and_threads-maxGimeno 2021-05-19 17:23:53 +02:00
Property_map expose typedefs 2021-12-13 09:40:40 +01:00
QP_solver Merge pull request #5649 from sloriot/CGAL-no_boost_shared_ptr 2021-05-18 18:14:12 +02:00
Random_numbers update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Ridges_3 Merge pull request #5649 from sloriot/CGAL-no_boost_shared_ptr 2021-05-18 18:14:12 +02:00
STL_Extension same change for CCC 2021-11-04 16:27:05 +01:00
Scale_space_reconstruction_3 IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Scripts Merge branch '5.2.x-branch' into 5.3.x-branch 2021-11-30 10:26:40 +01:00
SearchStructures update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Segment_Delaunay_graph_2 move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Segment_Delaunay_graph_Linf_2 move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Set_movable_separability_2 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Shape_detection Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Skin_surface_3 Merge remote-tracking branch 'sloriot/CGAL-restore_rounding_mode' 2021-09-09 11:09:16 +02:00
Snap_rounding_2 Squash-merge PR #5701 into 5.2.x 2021-11-30 12:14:53 +01:00
Solver_interface Correction of hyperlinks 2021-06-04 13:52:14 +02:00
Spatial_searching Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Spatial_sorting Merge branch 'master' into Triangulation_on_sphere_2-GF 2021-04-17 11:22:30 +02:00
Straight_skeleton_2 Merge remote-tracking branch 'sloriot/CGAL-restore_rounding_mode' 2021-09-09 11:09:16 +02:00
Stream_lines_2 replace internal use of boost::shared_ptr by std::shared_ptr 2021-04-28 10:55:26 +02:00
Stream_support Fix a bad merge from PR "Re-organize I/O #4255" 2021-10-27 12:03:36 +02:00
Subdivision_method_3 update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
Surface_mesh Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Surface_mesh_approximation IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Surface_mesh_deformation Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Surface_mesh_parameterization Merge pull request #6177 from MaelRL/SMP-Silence_warning-GF 2021-12-20 18:05:44 +01:00
Surface_mesh_segmentation IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Surface_mesh_shortest_path IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Surface_mesh_simplification Merge pull request #6047 from MaelRL/PM-Fix_pmaps_reference_types_5.3-GF 2021-10-29 17:39:22 +02:00
Surface_mesh_skeletonization IO namespace for files in IO directories 2021-05-04 14:36:06 +02:00
Surface_mesh_topology fix warnings about arithmetic operations on enum 2021-11-29 17:59:12 +01:00
Surface_mesher Merge pull request #5631 from GilesBathgate/STL_ext-fix_uncaught_exceptions_cleanup-GilesBathgate 2021-05-18 18:14:14 +02:00
Surface_sweep_2 Merge remote-tracking branch 'cgal/5.2.x-branch' into HEAD 2021-09-10 17:46:56 +02:00
TDS_2 Merge remote-tracking branch 'cgal/5.2.x-branch' into HEAD 2021-08-12 10:23:57 +02:00
TDS_3 Merge remote-tracking branch 'cgal/5.2.x-branch' into HEAD 2021-08-12 10:23:57 +02:00
Testsuite Update all testsuite scripts, using master versions 2021-11-30 10:23:20 +01:00
Tetrahedral_remeshing Merge pull request #6047 from MaelRL/PM-Fix_pmaps_reference_types_5.3-GF 2021-10-29 17:39:22 +02:00
Three Incorrect documentation for enum in Three package 2021-06-04 14:01:47 +02:00
Triangulation move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Triangulation_2 Merge branch 'PM-Fix_pmaps_reference_types-GF' into PM-Fix_pmaps_reference_types_5.3-GF 2021-10-12 09:29:23 +02:00
Triangulation_3 fix warnings about arithmetic operations on enum 2021-11-29 17:59:12 +01:00
Triangulation_on_sphere_2 Merge pull request #5827 from MaelRL/ToS2-VD2_AP-GF 2021-07-27 15:52:33 +02:00
Union_find move documented IO functions in IO namespace 2021-05-05 13:15:37 +02:00
Visibility_2 replace internal use of boost::shared_ptr by std::shared_ptr 2021-04-28 10:55:26 +02:00
Voronoi_diagram_2 Merge pull request #6118 from lrineau/Voronoi_diagram_2-fix_cpp20_warning-GF 2021-11-18 12:23:31 +01:00
.clang-tidy clang-tidy on tests 2021-02-18 15:15:12 +01:00
.gitattributes
.gitignore
CGALConfig.cmake
CGALConfigVersion.cmake
CMakeLists.txt update max version of cmake and announce the new minimal in CHANGE.md 2021-04-15 15:08:54 +02:00
INSTALL.md
LICENSE.md
README.md Remove the link to Travis 2021-03-26 11:11:48 +01:00
ccpp.yml
cmake_uninstall.cmake.in
copyright remove travis and wininst 2021-02-11 10:37:08 +01:00

README.md

CGAL

The Computational Geometry Algorithms Library (CGAL) is a C++ library that aims to provide easy access to efficient and reliable algorithms in computational geometry.

CGAL Releases

The primary vector of distribution of CGAL are source tarballs, released twice a year, announced on the web site of CGAL.

Getting Started with CGAL

Since version 5.0, CGAL is a header-only library, meaning that it is no longer needed to build CGAL libraries before it can be used.

Head over to the CGAL manual for usage guides and tutorials that will get you started smoothly.

License

See the file LICENSE.md.

CGAL Git Repository Layout

The Git repository of CGAL has a different layout from release tarballs. It contains a CMakeLists.txt file that serves as anchor for configuring and building programs, and a set of subfolders, so called packages. Most packages implement a data structure or an algorithm for CGAL (e.g., Convex_hull_2, or Triangulation_3); however some packages serve special needs:

  • Installation - meta-files and CMake-support
  • Maintenance - infrastructural support
  • Core, CGALimageIO, Qt_widget, GraphicsView - component libraries
  • Scripts - scripts to simplify developer's and user's work
  • Testsuite - infrastructure for testsuite
  • Documentation - infrastructure for CGAL's manual
  • STL_Extension - extensions to the standard template library

More Information