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

Point Set Processing: Remove documentation of deprecated functions #8017

Merged
merged 4 commits into from
Feb 13, 2024

Conversation

afabri
Copy link
Member

@afabri afabri commented Feb 6, 2024

Summary of Changes

As these functions are deprecated since CGAL 5.3 we remove them from the documentation.

I am also wondering why we have no CGAL::IO::read_XYZ() here, especially as we have an overload for Point_set_3 here.

Release Management

  • Affected package(s): Point_set_processing_3
  • License and copyright ownership:

@MaelRL
Copy link
Member

MaelRL commented Feb 6, 2024

I am also wondering why we have no CGAL::IO::read_XYZ() here, especially as we have an overload for Point_set_3 here.

The problem is:

} // namespace IO

/// \endcond

It needs to be:

/// \endcond

} // namespace IO

There: https://github.com/CGAL/cgal/blob/master/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h#L248

@afabri
Copy link
Member Author

afabri commented Feb 6, 2024

@MaelRL Why is the function read_point_set() (in the Point_set_3 chapter) not called read_points() (in the PSP package)?

@albert-github
Copy link
Contributor

The overnight documentation build gave:

/home/cgal-testsuite/cgal_doc_build/CGAL-6.0-Ic-167/include/CGAL/IO/read_xyz_points.h:408: warning: Found non-existing group 'PkgPointSetProcessing3IODeprecated' for the command '@ingroup', ignoring command
/home/cgal-testsuite/cgal_doc_build/CGAL-6.0-Ic-167/include/CGAL/IO/write_off_points.h:302: warning: Found non-existing group 'PkgPointSetProcessing3IODeprecated' for the command '@ingroup', ignoring command

some left over?

@afabri
Copy link
Member Author

afabri commented Feb 8, 2024

Successfully tested in 6.0-Ic-168

@sloriot
Copy link
Member

sloriot commented Feb 13, 2024

Successfully tested in CGAL-6.0-Ic-169

@lrineau lrineau assigned lrineau and unassigned afabri Feb 13, 2024
@lrineau lrineau added the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Feb 13, 2024
@lrineau lrineau merged commit 42f932d into CGAL:master Feb 13, 2024
9 checks passed
@lrineau lrineau removed the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Feb 13, 2024
@lrineau lrineau deleted the Point_set_3-remove_deprecated-GF branch February 13, 2024 10:26
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.

5 participants