How to avoid these hyperlinks

[afabri]

Issue Details

In the PR #6849 for Isosurfacing we get hyperlinks for Point_3 and Vector_3. Do we have to prevent this using % or can we consider this as a doxygen bug? and should file an issue? Or is that only a problem with the version of doxygen we use in the CI ? Any idea @albert-github ?

Source Code

See here

[albert-github]

On the mentioned page (https://cgal.github.io/6849/v5/Isosurfacing_3/classCGAL_1_1Isosurfacing_1_1Gradient__function__3.html) I see a number of occurrences of Point_3 and of Vector_3 which ones are you referring to?

When looking in the source code, I think, Isosurfacing_3/include/CGAL/Isosurfacing_3/Gradient_function_3.h) at line 56-57 we see once a % (Point_3) and once without (Vector_3) so this looks indeed a bit inconsistent. When we want to link to the "using" on this page the version without % is OK when we don't want this the % is necessary.

[MaelRL]

@albert-github There is indeed an inconsistency and it should be "%Vector_3". However, the main issue is that if you remove percentage signs, these will not link to the using ... in the class, but to other classes with the same name.

For example, the Vector_3 (no %) in

template <typename Partition>
class Gradient_function_3
{
public:
  using Vector_3 = typename Geom_traits::Vector_3;

  /**
   * \brief constructs a field of gradients using a gradient function and a partition.
   *
   * \tparam Function must provide the following function signature:
   *                  `Vector_3 operator()(const %Point_3&) const`                                     <--------------- here
   *
   * \param fn the function providing gradients
   * \param partition the space partitioning data structure
   */
  template <typename Function>
  Gradient_function_3(const Function& fn,
                      const Partition& partition)
    : m_fn{fn},
      m_partition{partition}
  { }
};

goes to https://doc.cgal.org/latest/Kernel_23/classCGAL_1_1Vector__3.html instead of the public typedef.

[albert-github]

At the moment it is hard to tel what is the best solution as

• the original pages (https://cgal.github.io/6849/v5/Isosurfacing_3/classCGAL_1_1Isosurfacing_1_1Gradient__function__3.html) O I cannot reach (probably to old and thus removed) so a new documentation build of this PR might be a good idea
• the overnight build of the documentation on https://cgal.geometryfactory.com/ I can temporay not reach...

[albert-github]

I wanted to have a look at the possibilities to answer the question posed in this issue, but I didn't succeed in getting the branch from GitHub (probably due to the lack of knowledge about git / GitHub on my side). Any suggestions how I can get (a branch with this) code.

[sloriot]

I wanted to have a look at the possibilities to answer the question posed in this issue, but I didn't succeed in getting the branch from GitHub (probably due to the lack of knowledge about git / GitHub on my side). Any suggestions how I can get (a branch with this) code.

You can add a remote (git remote add Julycode [email protected]:JulyCode/cgal.git or git remote add Julycode https://github.com/JulyCode/cgal.git if you are a https guy) or you can directly download the branch as a zip file here

[albert-github]

FYI I've been looking into the issue as noted in https://github.com/CGAL/cgal/issues/8397#issuecomment-2538701254 and created a small example. I didn't see the solution yet, but I also send it to Dimitri and he confirmed that there are discrepancies between handling the different links that should be corrected.

[Pranjal150306]

"Hello everyone, I am Pranjal Mishra , a second-year Computer Science student. I am proficient in C++ and am very interested in contributing to CGAL, with the goal of applying for GSoC 2026.

I see this Doc bug is unassigned, and it seems like a great issue for me to start with to learn the contribution workflow.

May I be assigned to this and take a look at fixing it?"