CGAL / cgal

The public CGAL repository, see the README below
https://github.com/CGAL/cgal#readme
Other
4.67k stars 1.35k forks source link

Incorrect example in "Documentation/doc/Documentation/Developer_manual/create_and_use_a_cmakelist.txt" #8334

Open albert-github opened 3 days ago

albert-github commented 3 days ago

In the file "Documentation/doc/Documentation/Developer_manual/create_and_use_a_cmakelist.txt" we have the part:

\subsection subcmake CMakeLists.txt
\dontinclude Surface_mesh/CMakeLists.txt
\skip cmake_minimum_required
\until project

\skip #CGAL_Qt6 is needed for the drawing.
\until endif()

\skip #create the executable of the application
\until "draw_surface_mesh.cpp"

\skip if(CGAL_Qt6_FOUND)
\until target_link_libraries(draw_surface_mesh PUBLIC CGAL::CGAL_Qt6)
\skip endif
\until #end of the file

where the file "Surface_mesh/CMakeLists.txt" is "Surface_mesh/examples/Surface_mesh/CMakeLists.txt" and has content:

# Created by the script cgal_create_cmake_script
# This is the CMake script for compiling a CGAL application.

#/!\ /!\
#/!\ /!\
# Used in /CGAL/Documentation/doc/Documentation/Developer_manual/create_and_use_a_cmakelist.txt.
# Careful when modifying

cmake_minimum_required(VERSION 3.12...3.29)
project(Surface_mesh_Examples)

#CGAL_Qt6 is needed for the drawing.
find_package(CGAL REQUIRED OPTIONAL_COMPONENTS Qt6)

create_single_source_cgal_program("sm_points.cpp")
create_single_source_cgal_program("sm_derivation.cpp")
create_single_source_cgal_program("sm_join.cpp")
create_single_source_cgal_program("sm_aabbtree.cpp")
create_single_source_cgal_program("sm_bgl.cpp")
create_single_source_cgal_program("sm_circulators.cpp")
create_single_source_cgal_program("sm_do_intersect.cpp")
create_single_source_cgal_program("sm_iterators.cpp")
create_single_source_cgal_program("sm_kruskal.cpp")
create_single_source_cgal_program("sm_memory.cpp")
create_single_source_cgal_program("sm_properties.cpp")
create_single_source_cgal_program("check_orientation.cpp")

#create the executable of the application
create_single_source_cgal_program("draw_surface_mesh.cpp")
if(CGAL_Qt6_FOUND)

  #link it with the required CGAL libraries
  target_link_libraries(draw_surface_mesh PUBLIC CGAL::CGAL_Basic_viewer)

endif()

#end of the file

Regarding the \skip and \until not all the patterns are present anymore and some patterns that look like to be present (like endif()) but are patterns that are quite general and it looks like that some have vanished.

(note this problem was found based on working on https://github.com/doxygen/doxygen/issues/10977 the second mentioned bug)

albert-github commented 3 days ago

See also the warnings in: https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/CGAL-6.0-Ic-281/logs_master/Documentation.log

albert-github commented 1 day ago

Some investigations:

5.3.2 image

5.4.4 image

albert-github commented 1 day ago

I've just pushed a proposed patch, pull request #8342