added missing documentation for syanpse miniapp

Author: Till Schumann

README.md

@@ -31,6 +31,6 @@ Moreover the hello directory provides informations to create a new miniapp
 
 This directory provides an example of how could be design a miniapp (C++)
 
-## neuromapp/synapse
+## neuromapp/nest/synapse
 
 This directory contains a miniapp that simulates synapse models from NEST.

doc/tuto.dox

@@ -76,10 +76,12 @@ Table
  <TD  align="center">  Print helper   </TD>
  <TD  align="center">  Print helper   </TD>
  <TD  align="center">  Print helper   </TD>
+ <TD  align="center">  Print helper   </TD>
  </TR>
  <TR>
  <TH> —data  </TH>
  <TD  align="center">  -  </TD>
+ <TD  align="center">  -  </TD>
  <TD  align="center">  input file   </TD>
  <TD  align="center">  input file   </TD>
  <TD  align="center">  input file   </TD>
@@ -89,6 +91,7 @@ Table
  <TR>
  <TH> —name  </TH>
  <TD  align="center">  world </TD>
+ <TD  align="center">  -   </TD>
  <TD  align="center">  storage key   </TD>
  <TD  align="center">  storage key   </TD>
  <TD  align="center">  storage key   </TD>
@@ -98,6 +101,7 @@ Table
  <TH> —numthread  </TH>
  <TD  align="center">  number OMP thread  </TD>
  <TD  align="center">  -   </TD>
+ <TD  align="center">  -   </TD>
  <TD  align="center">  number OMP thread   </TD>
  <TD  align="center">  -   </TD>
  <TD  align="center">  number OMP thread   </TD>
@@ -157,6 +161,52 @@ The queueing miniapp has additional options to study the queueing
  </TR>
 </TABLE>
 
+The synapse miniapp has additional options to study the spike processing
+
+<TABLE BORDER="1">
+<CAPTION> Additional option of the miniapp synapse  </CAPTION>
+ <TR>
+ <TH> —models  </TH>
+ <TD  align="center">  list of available synapse models </TD>
+ </TR>
+ <TR>
+ <TH> —model  </TH>
+ <TD  align="center">  select a synapse model   </TD>
+ </TR>
+ <TR>
+ <TH> —delay  </TH>
+ <TD  align="center">  synapse model property   </TD>
+ </TR>
+ <TR>
+ <TH> —weight   </TH>
+ <TD  align="center">  synapse model property   </TD>
+ </TR>
+ <TR>
+ <TH> —U  </TH>
+ <TD  align="center">  synapse model property   </TD>
+ </TR>
+ <TR>
+ <TH> —u  </TH>
+ <TD  align="center">  synapse model property   </TD>
+ </TR>
+ <TR>
+ <TH> —tau_rec  </TH>
+ <TD  align="center">  synapse model property   </TD>
+ </TR>
+ <TR>
+ <TH> —tau_fac  </TH>
+ <TD  align="center">  synapse model property   </TD>
+ </TR>
+ <TR>
+ <TH> —dt  </TH>
+ <TD  align="center">  timestep of simulation    </TD>
+ </TR>
+  <TR>
+ <TH> —iterations  </TH>
+ <TD  align="center">  number of iterations   </TD>
+ </TR>
+</TABLE>
+
 
 \section tu3 Miniapps performance metrics
 

neuromapp/nest/synapse/synapse.h

@@ -26,6 +26,7 @@
 #ifndef MAPP_SYNAPSE_EXECUTE_
 #define MAPP_SYNAPSE_EXECUTE_
 
+//! Namespace for all the nest miniapps
 namespace nest
 {
 	/** \fn nestconnection_execute(int argc, char *const argv[])

neuromapp/utils/storage/storage.hpp

@@ -37,7 +37,7 @@
 #include <iostream>
 #include <stdexcept>
 
-//! namespace spcific for the storage implementation only
+//! namespace specific for the storage implementation only
 namespace impl {
 
     template <typename T>
@@ -135,4 +135,4 @@ class storage {
 
 #include "storage.ipp"
 
-#endif
+#endif