Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a convenience IO header #7929

Merged
merged 3 commits into from
Dec 18, 2023
Merged

Conversation

MaelRL
Copy link
Member

@MaelRL MaelRL commented Dec 12, 2023

Summary of Changes

There is:

CGAL/boost/graph/IO/polygon_mesh_io.h
CGAL/PMP/IO/polygon_mesh_io.h
CGAL/IO/polygon_soup_io.h

The first one is a bit awkward to remember, so this PR adds a convenience header at CGAL/IO/polygon_mesh_io.h.

Release Management

  • Affected package(s): BGL
  • Issue(s) solved (if any): -
  • Feature/Small Feature (if any):
  • Link to compiled documentation (obligatory for small feature) wrong link name to be changed
  • License and copyright ownership:

Co-authored-by: Sebastien Loriot <[email protected]>
@lrineau
Copy link
Member

lrineau commented Dec 12, 2023

CGAL/boost/graph/IO/polygon_mesh_io.h is still the documented header in the following doc pages:

BGL/group__PkgBGLIOFct.html
BGL/index.html
Polygon_mesh_processing/index.html
Shape_detection/index.html
Straight_skeleton_2/index.html
Surface_mesh_simplification/index.html

Dont' you want to change that as well, in addition to the changes in examples?

@MaelRL
Copy link
Member Author

MaelRL commented Dec 12, 2023

That was not my intention, but indeed that leaves an undocumented header in examples.

@MaelRL MaelRL added TODO and removed CGAL I/O labels Dec 12, 2023
@sloriot
Copy link
Member

sloriot commented Dec 18, 2023

Successfully tested in CGAL-6.0-Ic-129

@sloriot sloriot merged commit cadc6ed into CGAL:master Dec 18, 2023
9 checks passed
@sloriot sloriot self-assigned this Dec 18, 2023
@lrineau lrineau deleted the CGAL-better_IO_header_names-GF branch December 19, 2023 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants