Skip to content

Make doxygen buildable again #2423

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

Merged
merged 1 commit into from
Apr 15, 2025
Merged

Make doxygen buildable again #2423

merged 1 commit into from
Apr 15, 2025

Conversation

lurch
Copy link
Contributor

@lurch lurch commented Apr 15, 2025

Unfortunately in #2411 @peterharperuk used a doxygen \par keyword which isn't supported by our doxygentoasciidoc repo, and this broke the building of both https://www.raspberrypi.com/documentation/pico-sdk/ and https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf

@mudge It fails with:

....
  File ".../lib/doxygentoasciidoc/nodes.py", line 223, in nodefor
    return {
KeyError: 'title'

Removing these "erroneous" 3 lines from pico_lwip/doc.h is probably easier than fixing up the rest of our doxygen pipeline 😉
And I don't think that this change has too much of an impact on the pico_lwip_http documentation?

(ping also @will-v-pi as he pointed out the problem to me)

Remove `\par` doxygen syntax which isn't supported by https://github.com/raspberrypi/doxygentoasciidoc
@lurch lurch requested a review from peterharperuk April 15, 2025 00:07
@lurch lurch added the documentation Improvements or additions to documentation label Apr 15, 2025
Copy link
Contributor

@peterharperuk peterharperuk left a comment

Choose a reason for hiding this comment

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

Odd, I remember testing this.

@lurch
Copy link
Contributor Author

lurch commented Apr 15, 2025

Odd, I remember testing this.

Yeah, the plain doxygen build itself works (i.e. make docs from within the CMake build directory), but it's the separate doxygentoasciidoc stage where it fails (see https://github.com/raspberrypi/documentation/blob/develop/CONTRIBUTING.md#build-the-pico-c-sdk-doxygen-documentation )

@mudge
Copy link
Contributor

mudge commented Apr 15, 2025

See also raspberrypi/doxygentoasciidoc#9 which would add support for \par in doxygentoasciidoc.

@kilograham kilograham merged commit 65a8907 into develop Apr 15, 2025
8 checks passed
@kilograham kilograham deleted the lurch-patch-1 branch April 15, 2025 15:28
@kilograham kilograham added this to the 2.1.2 milestone Apr 15, 2025
lurch added a commit that referenced this pull request Apr 23, 2025
kilograham pushed a commit that referenced this pull request Apr 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants