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.

Sign up for GitHub

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

Jump to bottom

Optimize Doxygen docs some #1228

Merged
merged 1 commit into from
Aug 12, 2022
Merged

Optimize Doxygen docs some #1228

merged 1 commit into from
Aug 12, 2022

Conversation

lmoureaux
Copy link
Contributor

This PR:

  • Turns Doxygen to use C++ mode as we're writing more and more C++ code as opposed to C.
  • Adds the files produced by Doxygen to .gitignore
  • Improves the documentation of the newly introduced renderer class

To run Doxygen, use doxygen doc/freeciv.doxygen.

@lmoureaux lmoureaux requested a review from jwrober August 10, 2022 00:31
@lmoureaux lmoureaux force-pushed the docs/doxygen-tweaks branch from 885bba9 to 4f3b424 Compare August 10, 2022 01:04
jwrober
jwrober approved these changes Aug 12, 2022
View reviewed changes
Copy link
Collaborator

@jwrober jwrober left a comment

Choose a reason for hiding this comment

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

After installing doxygen and running the command I was able to generate the html output and view it in a browser.

@lmoureaux lmoureaux force-pushed the docs/doxygen-tweaks branch from 4f3b424 to 6140a99 Compare August 12, 2022 20:29
@lmoureaux lmoureaux enabled auto-merge (rebase) August 12, 2022 20:29
@lmoureaux lmoureaux merged commit 8854672 into longturn:master Aug 12, 2022
@lmoureaux lmoureaux deleted the docs/doxygen-tweaks branch August 12, 2022 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jwrober jwrober jwrober approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lmoureaux @jwrober