[WIP] refactoring of comment blocks

models/multimeter.h

@@ -40,6 +40,7 @@
 
 namespace nest
 {
+
 /** @BeginDocumentation
 Name: multimeter - Device to record analog data from neurons.
 
@@ -86,6 +87,12 @@ extract it from the device using GetStatus.
    you record from are frozen and others are not, data will only be collected
    from the unfrozen nodes. Most likely, this will lead to confusing results,
    so you should not use multimeter with frozen nodes.
+ 
+ @note If you want to pick up values at every time stamp,
+   you must set the interval to the simulation resolution.
+ @ingroup Devices
+ @see UniversalDataLogger
+
 
 Parameters:
      The following parameters can be set in the status dictionary:
@@ -125,37 +132,6 @@ Author: Hans Ekkehard Plesser, Barna Zajzon (added offset support March 2017)
 
 SeeAlso: Device, RecordingDevice
 */
-
-
-/**
- * General analog data recorder.
- *
- * This class is based on RecordingDevice and adds common
- * functionality for devices sampling analog values at
- * given time intervals. The user specifies which data
- * are to be sampled at what interval.
- *
- * Sampling works in the way the the sampled node must store
- * the relevant data for the most recent completed time slice
- * and that the sampling device then sends a Request for data
- * with a given time stamp.
- *
- * Data is recorded at time steps T for which
- *   start < T - origin <= stop
- * and
- *   ( T - offset ) mod interval == 0.
- *
- * The recording interval defaults to 1ms; this entails that
- * the simulation resolution cannot be set to larger values than
- * 1ms unless the analog recording device interval is set to at
- * least that resolution.
- *
- * @note If you want to pick up values at every time stamp,
- *       you must set the interval to the simulation resolution.
- * *
- * @ingroup Devices
- * @see UniversalDataLogger
- */
 class Multimeter : public DeviceNode
 {
 

models/music_cont_in_proxy.h

@@ -44,6 +44,9 @@
 // Includes from sli:
 #include "arraydatum.h"
 
+namespace nest
+{
+
 /** @BeginDocumentation
 
 Name: music_cont_in_proxy - A device which receives continuous data from MUSIC.
@@ -82,14 +85,6 @@ Availability: Only when compiled with MUSIC
 
 SeeAlso: music_event_out_proxy, music_event_in_proxy, music_message_in_proxy
 */
-
-namespace nest
-{
-/**
- * Emit spikes at times received from another application via a
- * MUSIC port. The timestamps of the events also contain offsets,
- * which makes it also useful for precise spikes.
- */
 class music_cont_in_proxy : public DeviceNode
 {
 

models/music_cont_out_proxy.h

@@ -45,6 +45,9 @@
 // Includes from sli:
 #include "arraydatum.h"
 
+namespace nest
+{
+
 /** @BeginDocumentation
 
 Name: music_cont_out_proxy - A device which sends continuous data from NEST to
@@ -91,10 +94,6 @@ Availability: Only when compiled with MPI and MUSIC
 SeeAlso: music_cont_in_proxy, music_event_out_proxy, music_event_in_proxy,
 music_message_in_proxy
 */
-
-namespace nest
-{
-
 class music_cont_out_proxy : public DeviceNode
 {
 

models/music_event_in_proxy.h

@@ -37,6 +37,9 @@
 #include "event.h"
 #include "nest_types.h"
 
+namespace nest
+{
+
 /** @BeginDocumentation
 
 Name: music_event_in_proxy - A device which receives spikes from MUSIC.
@@ -82,14 +85,6 @@ Availability: Only when compiled with MUSIC
 SeeAlso: SetAcceptableLatency, music_event_out_proxy, music_cont_in_proxy,
 music_message_in_proxy
 */
-
-namespace nest
-{
-/**
- * Emit spikes at times received from another application via a
- * MUSIC port. The timestamps of the events also contain offsets,
- * which makes it also useful for precise spikes.
- */
 class music_event_in_proxy : public DeviceNode
 {
 

models/music_event_out_proxy.h

@@ -40,8 +40,10 @@
 #include "exceptions.h"
 #include "nest_types.h"
 
-/** @BeginDocumentation
+namespace nest
+{
 
+/** @BeginDocumentation
 Name: music_event_out_proxy - Device to forward spikes to remote applications
                               using MUSIC.
 
@@ -79,9 +81,6 @@ Availability: Only when compiled with MUSIC
 
 SeeAlso: music_event_in_proxy, music_cont_in_proxy, music_message_in_proxy
 */
-
-namespace nest
-{
 class music_event_out_proxy : public DeviceNode
 {
 

models/music_message_in_proxy.h

@@ -46,8 +46,9 @@
 #include "arraydatum.h"
 #include "dictutils.h"
 
+namespace nest
+{
 /** @BeginDocumentation
-
 Name: music_message_in_proxy - A device which receives message strings from
                               MUSIC.
 
@@ -92,9 +93,6 @@ Availability: Only when compiled with MUSIC
 
 SeeAlso: music_event_out_proxy, music_event_in_proxy, music_cont_in_proxy
 */
-
-namespace nest
-{
 class MsgHandler : public MUSIC::MessageHandler
 {
   ArrayDatum messages;                 //!< The buffer for incoming message

models/noise_generator.h

@@ -108,11 +108,6 @@ SeeAlso: Device
 
 Author: Ported to NEST2 API 08/2007 by Jochen Eppler, updated 07/2008 by HEP
 */
-
-/**
- * Gaussian white noise generator.
- * Provide Gaussian "white" noise input current
- */
 class noise_generator : public DeviceNode
 {