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

Documentation fails to build (it freezes, no crash) #11320

Closed
TommyPec opened this issue Jan 4, 2025 · 5 comments
Closed

Documentation fails to build (it freezes, no crash) #11320

TommyPec opened this issue Jan 4, 2025 · 5 comments
Labels

Comments

@TommyPec
Copy link

TommyPec commented Jan 4, 2025

Describe the bug
Building ns-3 documentation stops at Generating docs for compound DropTailQueue< Packet >...

Screenshots
Not applicable

To Reproduce
Open the attached archive. Then issue the following commands:

./ns3 configure --enable-examples --enable-tests 
./ns3 build
./doc/doxygen.warnings.report.sh -v

You need to have installed (at least)

  • g++ (>= 10) or clang (>= 11)
  • cmake (>= 3.13)
  • Python 3 (>= 3.8)
  • One between make, ninja, or Xcode

Expected behavior
Either complete the documentation, or issue an error...

Version
Doxygen 1.13.1, tested on macOS with Doxygen installed via homebrew (doxygen: stable 1.13.1 (bottled), HEAD)

Stack trace
No stack trace, sorry.

Additional context
I'm sorry but I wasn't able to narrow down the problem to a smaller example. However, the attached ns-3 is "minimal", meaning that I took out any module that was not strictly necessary to highlight the problem.

ns-3-minimal.tgz

@albert-github
Copy link
Collaborator

I could reproduce the problem with the current master (1.14.0 (83118ee)) as well (on Windows and Cygwin) though I could not get as stack trace.
It is not necessary to do the complete build just doxygen doc/doxygen.conf on the ns-3-minimal directory already shows the problem.

@doxygen
Copy link
Owner

doxygen commented Jan 5, 2025

Looks like the problem was introduced by this commit. The continue statement at line 846 of docparser.cpp was overlooked while refactoring (good reason to avoid the continue statement).

Even smaller reproduction scenario main.dox:

/** @mainpage
<ul><li>>\p X</li></ul>
*/

@doxygen
Copy link
Owner

doxygen commented Jan 5, 2025

@TommyPec Please verify if the referenced commit fixes the problem for you. Do not close the issue, this will be done automatically when the next official release becomes available.

@TommyPec
Copy link
Author

TommyPec commented Jan 5, 2025

I can confirm that the bug is fixed with this commit.

Thanks for the quick resolution. Hopefully there will be a 1.13.2

@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 Jan 5, 2025
@doxygen
Copy link
Owner

doxygen commented Jan 9, 2025

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.13.2.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@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 Jan 9, 2025
@doxygen doxygen closed this as completed Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants