Added brief for all files introduced in backend refactoring: #121

DavidIkov · DavidIkov · commit 56114124a476 · 2026-01-27T22:31:03.000+03:00
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/altai/altai_dispatcher.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/altai/altai_dispatcher.h
@@ -1,5 +1,6 @@
 /**
  * @file altai_dispatcher.h
+ * @brief Specification of population interface for altai neuron population.
  * @kaspersky_support Postnikov D.
  * @date 08.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/altai/altai_impl.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/altai/altai_impl.h
@@ -1,5 +1,6 @@
 /**
  * @file altai_impl.h
+ * @brief Implementation of altai neuron population.
  * @kaspersky_support Vartenkov A.
  * @date 08.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/blifat/blifat_dispatcher.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/blifat/blifat_dispatcher.h
@@ -1,5 +1,6 @@
 /**
  * @file blifat_dispatcher.h
+ * @brief Specification of population interface for blifat neuron population.
  * @kaspersky_support Postnikov D.
  * @date 12.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/blifat/blifat_impl.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/blifat/blifat_impl.h
@@ -1,5 +1,6 @@
 /**
  * @file blifat_impl.h
+ * @brief Implementation of blifat neuron population.
  * @kaspersky_support Artiom N.
  * @date 12.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/blifat/blifat_stdp.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/blifat/blifat_stdp.h
@@ -1,5 +1,6 @@
 /**
  * @file blifat_stdp.h
+ * @brief Implementation of stdp in blifat neuron.
  * @kaspersky_support Artiom N.
  * @date 12.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/population_dispatcher.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/population_dispatcher.h
@@ -1,5 +1,6 @@
 /**
  * @file population_dispatcher.h
+ * @brief Combined interface of all supported populations.
  * @kaspersky_support Postnikov D.
  * @date 02.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/training/stdp.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/populations/training/stdp.h
@@ -1,5 +1,6 @@
 /**
  * @file stdp.h
+ * @brief Shared stdp related functions.
  * @kaspersky_support Artiom N.
  * @date 08.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/delta/delta_dispatcher.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/delta/delta_dispatcher.h
@@ -1,5 +1,6 @@
 /**
  * @file delta_dispatcher.h
+ * @brief Specification of projection interface for delta synapse projection.
  * @kaspersky_support Postnikov D.
  * @date 10.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/delta/delta_impl.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/delta/delta_impl.h
@@ -1,5 +1,6 @@
 /**
  * @file delta_impl.h
+ * @brief Implementation of delta synapse projection.
  * @kaspersky_support Vartenkov A.
  * @date 10.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/message_queue.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/message_queue.h
@@ -1,5 +1,6 @@
 /**
  * @file message_queue.h
+ * @brief Definition of message queue.
  * @kaspersky_support Postnikov D.
  * @date 18.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/training/stdp/additive_stdp.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/training/stdp/additive_stdp.h
@@ -1,5 +1,6 @@
 /**
  * @file additive_stdp.h
+ * @brief STDP specification for additive stdp.
  * @kaspersky_support Artiom N.
  * @date 18.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/training/stdp/stdp_dispatcher.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/training/stdp/stdp_dispatcher.h
@@ -1,5 +1,6 @@
 /**
  * @file stdp_dispatcher.h
+ * @brief Combined interface of all supported stdp specifications.
  * @kaspersky_support Postnikov D.
  * @date 21.01.2026
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/training/stdp/synaptic_resource_stdp.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/impl/projections/training/stdp/synaptic_resource_stdp.h
@@ -1,5 +1,6 @@
 /**
  * @file synaptic_resource_stdp.h
+ * @brief STDP specification for synaptic resource stdp.
  * @kaspersky_support Postnikov D.
  * @date 18.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/populations.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/populations.h
@@ -1,5 +1,6 @@
 /**
  * @file populations.h
+ * @brief Interface for working with populations.
  * @kaspersky_support Postnikov D.
  * @date 26.11.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/populations_old.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/populations_old.h
@@ -1,5 +1,6 @@
 /**
  * @file populations_old.h
+ * @brief Legacy interface for working with populations for backend.
  * @kaspersky_support Postnikov D.
  * @date 26.01.2026
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/projections.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/projections.h
@@ -1,5 +1,6 @@
 /**
  * @file projections.h
+ * @brief Interface for working with projections.
  * @kaspersky_support Postnikov D.
  * @date 10.12.2025
  * @license Apache 2.0
diff --git a/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/projections_old.h b/knp/backends/cpu/cpu-library/include/knp/backends/cpu-library/projections_old.h
@@ -1,5 +1,6 @@
 /**
  * @file projections_old.h
+ * @brief Legacy interface for working with projections for backend.
  * @kaspersky_support Postnikov D.
  * @date 26.01.2026
  * @license Apache 2.0
