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

Add Doxyfile #634

Merged
merged 9 commits into from
Apr 28, 2023
Merged

Add Doxyfile #634

merged 9 commits into from
Apr 28, 2023

Conversation

TobiasFella
Copy link
Member

@TobiasFella TobiasFella commented Mar 16, 2023

Next steps would be:

  • Adding a CI job to build the documentation
  • Hosting it somewhere

Where to host it?
I could put it on my server, or we can use github pages

It's almost completely the default template, since I don't really know anything about doxygen - seems to mostly work though

@CarlSchwan do you know anything useful about how doxygen should be configured (any maybe make it less ugly? 😄)

Current status can be viewed at quotient.tobiasfella.de

@TobiasFella
Copy link
Member Author

Some problems I noticed:

@sonarcloud
Copy link

sonarcloud bot commented Mar 16, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@KitsuneRal KitsuneRal added the documentation Issues with the library documentation label Mar 17, 2023
@TobiasFella
Copy link
Member Author

Some problems I noticed:

* on pages like https://quotient.tobiasfella.de/classRoom.html , it says `Definition at line 82 of file room.cpp` - which is very wrong, the class is defined in the header; the line it points to is the definition of the private class

* In https://quotient.tobiasfella.de/annotated.html, some classes are shown on the top-level of the tree, while others are below the `Quotient` namespace

Fixed by not building docs for .cpp files

Copy link
Member

@KitsuneRal KitsuneRal left a comment

Choose a reason for hiding this comment

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

I have no prior experience with Doxyfiles but my uneducated suggestions are below :) Also: THANKS!

Doxyfile Outdated Show resolved Hide resolved
Doxyfile Outdated Show resolved Hide resolved
Doxyfile Outdated Show resolved Hide resolved
Doxyfile Outdated Show resolved Hide resolved
Doxyfile Outdated Show resolved Hide resolved
@KitsuneRal
Copy link
Member

One more thing I forgot: I wonder if using the Clang parser would help with recognising [[deprecated]] declarations that don't have \deprecated counterparts in doc-comments.

@TobiasFella
Copy link
Member Author

I'm also proposing to use the theme currently deployed at https://quotient.tobiasfella.de/ (not in the merge request yet); opinions?

Copy link
Member

@KitsuneRal KitsuneRal left a comment

Choose a reason for hiding this comment

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

Thanks a lot! A nitpick about the shell override.

.github/workflows/static.yml Outdated Show resolved Hide resolved
@KitsuneRal KitsuneRal merged commit 038026b into dev Apr 28, 2023
@TobiasFella TobiasFella deleted the tobias/doxyfile branch July 13, 2023 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues with the library documentation
Projects
Status: Version 0.7 - Done
Development

Successfully merging this pull request may close these issues.

2 participants