Auryn simulator

Simulator for spiking neural networks with synaptic plasticity

User Tools

Site Tools


manual:doxygen

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
manual:doxygen [2015/10/01 05:40] zenkemanual:doxygen [2017/04/24 19:16] (current) – Changes links to fzenke.net zenke
Line 1: Line 1:
 ====== Doxygen documentation ====== ====== Doxygen documentation ======
  
-The doxygen generated pages might be useful for exploring the code an when you want to work with Auryn other than just trying out some of the examples (you find an online version of it [[http://www.fzenke.net/auryn/doxygen/current/annotated.html|here]]).+The doxygen generated pages might be useful for exploring the code an when you want to work with Auryn other than just trying out some of the examples (you find an online version of it [[http://fzenke.net/auryn/doxygen/current/annotated.html|here]]).
  
 To build the ''doxygen'' documentation ensure you have doxygen installed. Under debian like distributions that means to install To build the ''doxygen'' documentation ensure you have doxygen installed. Under debian like distributions that means to install
Line 11: Line 11:
 <code> <code>
 cd auryn/src cd auryn/src
 +doxygen
 +</code>
 +
 +Starting from version v0.8 you need to run:
 +and then to generate the html documentation under ''doc/html'' run
 +<code>
 +cd auryn/doc
 doxygen doxygen
 </code> </code>
  
 This will generate the doxygen documentation an place it in the ''auryn/doc'' directory.  This will generate the doxygen documentation an place it in the ''auryn/doc'' directory. 
manual/doxygen.txt · Last modified: 2017/04/24 19:16 by zenke