Skip to content

Commit

Permalink
Add a @brief for correct display in doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
akorgor committed Sep 13, 2024
1 parent 65ae48f commit 62a3d92
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 0 deletions.
2 changes: 2 additions & 0 deletions models/eprop_iaf.h
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,8 @@ EndUserDocs */
void register_eprop_iaf( const std::string& name );

/**
* @brief Class implementing a LIF neuron model for e-prop plasticity with additional biological features.
*
* Class implementing a current-based leaky integrate-and-fire neuron model with delta-shaped postsynaptic currents for
* e-prop plasticity according to Bellec et al. (2020) with additional biological features described in
* Korcsak-Gorzo, Stapmanns, and Espinoza Valverde et al. (in preparation).
Expand Down
2 changes: 2 additions & 0 deletions models/eprop_iaf_adapt.h
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,8 @@ EndUserDocs */
void register_eprop_iaf_adapt( const std::string& name );

/**
* @brief Class implementing an adaptive LIF neuron model for e-prop plasticity with additional biological features.
*
* Class implementing a current-based leaky integrate-and-fire neuron model with delta-shaped postsynaptic currents and
* threshold adaptation for e-prop plasticity according to Bellec et al. (2020) with additional biological features
* described in Korcsak-Gorzo, Stapmanns, and Espinoza Valverde et al. (in preparation).
Expand Down
2 changes: 2 additions & 0 deletions models/eprop_iaf_adapt_bsshslm_2020.h
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,8 @@ EndUserDocs */
void register_eprop_iaf_adapt_bsshslm_2020( const std::string& name );

/**
* @brief Class implementing an adaptive LIF neuron model for e-prop plasticity.
*
* Class implementing a current-based leaky integrate-and-fire neuron model with delta-shaped postsynaptic currents and
* threshold adaptation for e-prop plasticity according to Bellec et al. (2020).
*/
Expand Down
2 changes: 2 additions & 0 deletions models/eprop_iaf_bsshslm_2020.h
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,8 @@ EndUserDocs */
void register_eprop_iaf_bsshslm_2020( const std::string& name );

/**
* @brief Class implementing a LIF neuron model for e-prop plasticity.
*
* Class implementing a current-based leaky integrate-and-fire neuron model with delta-shaped postsynaptic currents for
* e-prop plasticity according to Bellec et al. (2020).
*/
Expand Down
2 changes: 2 additions & 0 deletions models/eprop_learning_signal_connection.h
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ EndUserDocs */
void register_eprop_learning_signal_connection( const std::string& name );

/**
* @brief Class implementing a feedback connection model for e-prop plasticity with additional biological features.
*
* Class implementing a synapse model transmitting secondary feedback learning signals for e-prop plasticity
* according to Bellec et al. (2020) with additional biological features described in
* Korcsak-Gorzo, Stapmanns, and Espinoza Valverde et al. (in preparation).
Expand Down
2 changes: 2 additions & 0 deletions models/eprop_learning_signal_connection_bsshslm_2020.h
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ EndUserDocs */
void register_eprop_learning_signal_connection_bsshslm_2020( const std::string& name );

/**
* @brief Class implementing a feedback connection model for e-prop plasticity.
*
* Class implementing a synapse model transmitting secondary feedback learning signals for e-prop plasticity
* according to Bellec et al. (2020).
*/
Expand Down
2 changes: 2 additions & 0 deletions models/eprop_readout.h
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,8 @@ EndUserDocs */
void register_eprop_readout( const std::string& name );

/**
* @brief Class implementing a readout neuron model for e-prop plasticity with additional biological features.
*
* Class implementing a current-based leaky integrate readout neuron model with delta-shaped postsynaptic currents for
* e-prop plasticity according to Bellec et al. (2020) with additional biological features described in
* Korcsak-Gorzo, Stapmanns, and Espinoza Valverde et al. (in preparation).
Expand Down
2 changes: 2 additions & 0 deletions models/eprop_readout_bsshslm_2020.h
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,8 @@ EndUserDocs */
void register_eprop_readout_bsshslm_2020( const std::string& name );

/**
* @brief Class implementing a readout neuron model for e-prop plasticity.
*
* Class implementing a current-based leaky integrate readout neuron model with delta-shaped postsynaptic currents for
* e-prop plasticity according to Bellec et al. (2020).
*/
Expand Down
4 changes: 4 additions & 0 deletions models/eprop_synapse.h
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ Examples using this model
EndUserDocs */

/**
* @brief Base class implementing common properties for e-prop synapses with additional biological features.
*
* Base class implementing common properties for the e-prop synapse model according to Bellec et al. (2020) with
* additional biological features described in Korcsak-Gorzo, Stapmanns, and Espinoza Valverde et al.
* (in preparation).
Expand Down Expand Up @@ -197,6 +199,8 @@ class EpropSynapseCommonProperties : public CommonSynapseProperties
void register_eprop_synapse( const std::string& name );

/**
* @brief Class implementing a synapse model for e-prop plasticity with additional biological features.
*
* Class implementing a synapse model for e-prop plasticity according to Bellec et al. (2020) with
* additional biological features described in Korcsak-Gorzo, Stapmanns, and Espinoza Valverde et al. (in preparation).
*
Expand Down
4 changes: 4 additions & 0 deletions models/eprop_synapse_bsshslm_2020.h
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ Examples using this model
EndUserDocs */

/**
* @brief Base class implementing common properties for e-prop synapses.
*
* Base class implementing common properties for the e-prop synapse model according to Bellec et al. (2020).
*
* This class in particular manages a pointer to weight-optimizer common properties to support
Expand Down Expand Up @@ -210,6 +212,8 @@ class EpropSynapseBSSHSLM2020CommonProperties : public CommonSynapseProperties
void register_eprop_synapse_bsshslm_2020( const std::string& name );

/**
* @brief Class implementing a synapse model for e-prop plasticity.
*
* Class implementing a synapse model for e-prop plasticity according to Bellec et al. (2020).
*
* @note Several aspects of this synapse are in place to reproduce the Tensorflow implementation of Bellec et al.
Expand Down

0 comments on commit 62a3d92

Please sign in to comment.