[doc] Add short sentence to each file in src.

Author: Murilo Marinho

src/eigen3_std_conversions.cpp

@@ -22,6 +22,10 @@
 #
 # ################################################################*/
 
+/**
+ * @file eigen3_std_conversions.cpp
+ * @brief Conversion functions between Eigen, STL containers, and DQ.
+ */
 #include<sas_core/eigen3_std_conversions.hpp>
 
 namespace sas

src/examples/sas_clock_example.cpp

@@ -22,6 +22,11 @@
 #
 # ################################################################*/
 
+/**
+ * @file sas_clock_example.cpp
+ * @brief Example showing how to use sas::Clock to time loops.
+ */
+
 #include <iostream>
 
 #include <sas_core/sas_clock.hpp>

src/examples/sas_clock_sched_fifo_example.cpp

@@ -22,6 +22,11 @@
 #
 # ################################################################*/
 
+/**
+ * @file sas_clock_sched_fifo_example.cpp
+ * @brief Example demonstrating Clock with realtime SCHED_FIFO.
+ */
+
 #include <iostream>
 
 #include <sas_core/sas_clock.hpp>

src/examples/sas_core_example.cpp

@@ -22,6 +22,11 @@
 #
 # ################################################################*/
 
+/**
+ * @file sas_core_example.cpp
+ * @brief Example testing core utilities.
+ */
+
 #include <eigen3/Eigen/Dense>
 #include <sas_core/sas_core.hpp>
 

src/examples/sas_robot_driver_example.cpp

@@ -21,6 +21,11 @@
 #   Author: Murilo M. Marinho, email: murilomarinho@ieee.org
 #
 # ################################################################*/
+
+/**
+ * @file sas_robot_driver_example.cpp
+ * @brief Example implementation of a RobotDriver.
+ */
 #include <sas_core/examples/sas_robot_driver_example.hpp>
 #include <iostream>
 

src/examples/sas_robot_driver_example_main.cpp

@@ -21,6 +21,11 @@
 #   Author: Murilo M. Marinho, email: murilomarinho@ieee.org
 #
 # ################################################################*/
+
+/**
+ * @file sas_robot_driver_example_main.cpp
+ * @brief C++ example showcasing a sample RobotDriver subclass.
+ */
 #include <sas_core/examples/sas_robot_driver_example.hpp>
 #include <iostream>
 

src/sas_clock.cpp

@@ -22,6 +22,11 @@
 #
 # ################################################################*/
 
+/**
+ * @file sas_clock.cpp
+ * @brief Timing utilities for control loops.
+ */
+
 #include <thread>
 
 #include "sas_core/sas_clock.hpp"

src/sas_core.cpp

@@ -21,6 +21,11 @@
 #   Author: Murilo M. Marinho, email: murilomarinho@ieee.org
 #
 # ################################################################*/
+
+/**
+ * @file sas_core.cpp
+ * @brief Implementation of core functions.
+ */
 #include <sas_core/sas_core.hpp>
 #include <mutex>
 

src/sas_core_py.cpp

@@ -22,6 +22,11 @@
 #
 # ################################################################*/
 
+/**
+ * @file sas_core_py.cpp
+ * @brief Python bindings for core classes.
+ */
+
 #include "sas_core_py.hpp"
 #include <sas_core/sas_clock.hpp>
 #include <sas_core/sas_shutdown_signaler.hpp>

src/sas_core_py.hpp

@@ -23,6 +23,11 @@
 #
 # ################################################################*/
 
+/**
+ * @file sas_core_py.hpp
+ * @brief Functions to separately initialise more complex Python bindings.
+ */
+
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
 #include <pybind11/eigen.h>