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

Reference manual #69

Merged
merged 5 commits into from
Oct 16, 2016
Merged

Reference manual #69

merged 5 commits into from
Oct 16, 2016

Conversation

stuart-knock
Copy link
Member

#7 A few more steps toward the doxygen generated reference-manual.

Add file level documentation for the header files.
Support latex style equations via MathJax.
Use end-of-line comments to document variable definitions.

#30 Adds Felix as author.

  + Adds a latex equation array for the differential equation
    defining the dendritic ramp.
  + Set the Doxyfile setting USE_MATHJAX = YES, this avoids
    the need for additional prerequisites on the build machine
    and MathJax support in modern browsers is good.
@pausz
Copy link
Contributor

pausz commented Oct 16, 2016

This pull request improves code documentation (and reference manual).
Equations are properly rendered
screenshot from 2016-10-17 10-41-49

and the use of end-of-line comments are correctly pulled by doxygen
screenshot from 2016-10-17 10-42-29

@pausz pausz merged commit 5394a5c into BrainDynamicsUSYD:master Oct 16, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants