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

Update doxygen docs in developer guide #13

Merged
merged 2 commits into from
Sep 2, 2019

Conversation

olemke
Copy link
Member

@olemke olemke commented Aug 30, 2019

  • Update examples to reflect our new default JavaDoc style.
  • Update information on placement of function docs.
  • Since we're trying to be editor agnostic, the Emacs specific Doxymacs documentation has moved to its own subsection instead of having it interleaved with the Doxygen examples.

This is a performance hog and slows down documentation generation by
a lot (as in: too much).
* Update examples to reflect our new default JavaDoc style.

* Update information on placement of function docs.

* Since we're trying to be editor agnostic, the Emacs specific Doxymacs
  documentation has moved to its own subsection instead of having it
  interleaved with the Doxygen examples.
@olemke olemke requested a review from simonpf August 30, 2019 08:17
@olemke olemke added the documentation Addition or update of the documentation label Aug 30, 2019
@olemke olemke merged commit f82cbf9 into atmtools:master Sep 2, 2019
@olemke olemke deleted the update-doxygen-style branch September 2, 2019 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Addition or update of the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant