Skip to content

Mesh_3: Fix Documentation Glitches#9283

Open
afabri wants to merge 27 commits intoCGAL:mainfrom
afabri:Mesh_3-glitches-GF
Open

Mesh_3: Fix Documentation Glitches#9283
afabri wants to merge 27 commits intoCGAL:mainfrom
afabri:Mesh_3-glitches-GF

Conversation

@afabri
Copy link
Member

@afabri afabri commented Jan 16, 2026

Summary of Changes

Template parameters must be in CamelCase
Fix template parameters in the package description

Todo

  • Add the Insight Tool Kit, referedto here, to the 3rd party software page
  • Fix some todos in the code
  • Remove the first two template parameters and rewrite the documentation of the third one here.
  • Announce the removal of deprecated feature in the CHANGES.md for 6.2

Release Management

  • Affected package(s): Mesh_3
  • Link to compiled documentation (obligatory for small feature) wrong link name to be changed
  • License and copyright ownership: unchanged

@afabri afabri requested a review from janetournois January 16, 2026 12:08
@afabri
Copy link
Member Author

afabri commented Jan 16, 2026

When did we deprecate this? Maybe we can remove it in this PR.

@afabri
Copy link
Member Author

afabri commented Jan 16, 2026

When did we deprecate this? Maybe we can remove it in this PR.

Deprecated 8 years ago in this commit

@afabri
Copy link
Member Author

afabri commented Jan 16, 2026

Is it correct that here we refer to the Surface_mesher package @janetournois

@janetournois
Copy link
Member

Is it correct that here we refer to the Surface_mesher package @janetournois

I don't think so. What part of the page do you refer to?

@afabri
Copy link
Member Author

afabri commented Jan 16, 2026

Is it correct that here we refer to the Surface_mesher package @janetournois

I don't think so. What part of the page do you refer to?

I refer to the sentence "This parameter stands for a model of the concept ImplicitFunction described in the surface mesh generation package"

@janetournois
Copy link
Member

Is it correct that here we refer to the Surface_mesher package @janetournois

I don't think so. What part of the page do you refer to?

I refer to the sentence "This parameter stands for a model of the concept ImplicitFunction described in the surface mesh generation package"

then yes, it is about Surface_mesher. Maybe it should be moved/copied to Mesh_3 now, since the Surface_mesher package got deprecated

@afabri

This comment was marked as outdated.

@github-actions
Copy link

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/9283/v0/Manual/index.html

@github-actions

This comment was marked as outdated.

@afabri

This comment was marked as outdated.

@github-actions
Copy link

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/9283/v0/Manual/index.html

@sloriot
Copy link
Member

sloriot commented Feb 3, 2026

Successfully tested in CGAL-6.2-Ic-101


template <typename Function,
typename Bounding_object,
typename BoundingObject,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this one camel-case and Construct_surface_patch_index not?

* and returns a scalar value. That object must be model of `CopyConstructible`
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
* \tparam Bounding_object either a bounding sphere (of type `Sphere_3`), a bounding box (type `Bbox_3`),
* \tparam BoundingObject either a bounding sphere (of type `Sphere_3`), a bounding box (type `Bbox_3`),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* \tparam BoundingObject either a bounding sphere (of type `Sphere_3`), a bounding box (type `Bbox_3`),
* \tparam BoundingObject either a bounding `Sphere_3`, a bounding `Bbox_3`,

@github-actions github-actions bot removed the Tested label Feb 6, 2026
@github-actions
Copy link

github-actions bot commented Feb 6, 2026

This pull-request was previously marked with the label Tested, but has been modified with new commits. That label has been removed.

@afabri
Copy link
Member Author

afabri commented Feb 6, 2026

/force-build:v0

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/9283/v0/Manual/index.html

@afabri
Copy link
Member Author

afabri commented Feb 6, 2026

I just noticed that Labeled_mesh_domain_3 is documented in doc and in include

@afabri
Copy link
Member Author

afabri commented Feb 6, 2026

/force-build:v0

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/9283/v0/Manual/index.html

@afabri afabri force-pushed the Mesh_3-glitches-GF branch from ecf54b1 to a2bef76 Compare February 6, 2026 18:09
@afabri
Copy link
Member Author

afabri commented Feb 6, 2026

/force-build:v0

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/9283/v0/Manual/index.html

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.

6 participants