c2m2.github.io

Documentation site repo for Temple University's NeuroVISOR Project

How to update the documentation using Doxygen

Prerequisites

Download and install Doxygen. Download and install GraphViz.

Steps to produce documentation

1. Clone this repo onto your local machine. 2. Open Doxywizard -> File -> Open -> c2m2.github.io/Doxyfile 3. Navigate to the "Wizard" tab. 4. Make sure that the working directory is set to "c2m2.github.io":

5. Clone the C2M2 virtual-reality project 6. Set Doxygen's source code directory to "virtual-reality\Assets\Scripts\C2M2":

7. Set Doxygen's destination directory to c2m2.github.io:

8. Find where GraphViz installed, then navigate to the "Expert" tab. 9. Navigate to Expert -> Dot and make sure that DOT_PATH is set to "Graphviz2.38\bin". The number might change depending on your version of GraphViz:

10. Navigate to the "Run" tab. Click "Run Doxygen" and let it run. 11. If no fatal errors occur, commit and push the changes to this repo.