Skip to content

Incorrect link from summary links for namespaces #8232

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

Conversation

albert-github
Copy link
Collaborator

When running a link checker on the CGAL BGL package we get the warning:

List of broken links and other issues:
file:///.../doc_output/BGL/namespaceCGAL.html
 Lines: 164, 172, 1143, 1153
  Code: 200 (no message)
 To do: Some of the links to this resource point to broken URI fragments
        (such as index.html#fragment).
The following fragments need to be fixed:
        namespaces                      Line: 164

This is due to the fact that on the mentioned page no "section" namespaces is but in the summary links (top right) there is still "Namespaces".
Before writing the summary link it should be checked whether or not there are really namespaces shown (se also NamespaceSDict::writeDeclaration).

When running a link checker on the CGAL BGL package we get the warning:
```
List of broken links and other issues:
file:///.../doc_output/BGL/namespaceCGAL.html
 Lines: 164, 172, 1143, 1153
  Code: 200 (no message)
 To do: Some of the links to this resource point to broken URI fragments
        (such as index.html#fragment).
The following fragments need to be fixed:
        namespaces                      Line: 164
```
This is due to the fact that on the mentioned page no "section" namespaces is but in the summary links (top right) there is still "Namespaces".
Before writing the summary link it should be checked whether or not there are really namespaces shown (se also `NamespaceSDict::writeDeclaration`).
@albert-github albert-github added bug HTML HTML / XHTML output labels Dec 7, 2020
@doxygen
Copy link
Owner

doxygen commented May 25, 2021

@albert-github I've implemented this a bit differently; namespaces.declVisible() should already tell if the summary link can be written or not. Please check if this solves the original problem as I don't know how to reproduce it.

@albert-github
Copy link
Collaborator Author

albert-github commented May 25, 2021

It is quite a tedious process to find these kind of problems, it is done with the w3C link checker. I'll give it tomorrow a go.

@albert-github
Copy link
Collaborator Author

I reran the creation of the documentation of the CGAL package (I also ran the version without the corrections).

  1. In the BGL package the mentioned broken links are gone (I only checked the BGL package, but seen the changes with the other packages I think for them theses broken links are gone as well).
  2. In a number of packages the file namespacestd.html surfaces in a number of cases this file doesn't contain any information just an "identification / header" (like Cone_spanners_2) in other cases (like (Geomview) it contains a line for each STL class with the mentioning "STL class"
  3. In the statements like using namespace std; the std is now hyperlinked to namespacestd.html (like e.g. Bounding_volumes/Min_sphere_of_spheres_d_2benchmark_8cpp-example.html).

In the project the BUILTIN_STL_SUPPORT = YES so that the STL links are show should be OK.

@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label May 26, 2021
@albert-github albert-github deleted the feature/bug_namespaces_summary branch May 26, 2021 10:24
@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug HTML HTML / XHTML output
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants