rudimentary doxygen support

cdqp · Jun 18, 2024 · f70ad76 · f70ad76
1 parent 4deebc5
commit f70ad76
Show file tree

Hide file tree

Showing 13 changed files with 2,942 additions and 11 deletions.
diff --git a/Doxyfile b/Doxyfile
diff --git a/devices/center_of_mass.h b/devices/center_of_mass.h
@@ -4,7 +4,9 @@
 #include "anyloop.h"
 #include "thread_pool.h"
 
-/** aylp:center_of_mass
+/** \file center_of_mass.h
+ *
+ * aylp:center_of_mass
  *
  * types and units: `[T_MATRIX_UCHAR, U_ANY] -> [T_VECTOR, U_MINMAX]`
  *

diff --git a/devices/delay.h b/devices/delay.h
@@ -3,7 +3,9 @@
 
 #include "anyloop.h"
 
-/** aylp:delay
+/** \file delay.h
+ *
+ * aylp:delay
  *
  * types and units: `[T_ANY, U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`
  *

diff --git a/devices/file_sink.h b/devices/file_sink.h
@@ -4,7 +4,9 @@
 #include <stdio.h>
 #include "anyloop.h"
 
-/** aylp:file_sink
+/** \file file_sink.h
+ *
+ * aylp:file_sink
  *
  * types and units: `[T_ANY, U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`
  *

diff --git a/devices/logger.h b/devices/logger.h
@@ -3,7 +3,9 @@
 
 #include "anyloop.h"
 
-/** aylp:logger
+/** \file logger.h
+ *
+ * aylp:logger
  *
  * types and units: `[T_ANY, U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`
  *

diff --git a/devices/matmul.h b/devices/matmul.h
@@ -5,7 +5,9 @@
 #include <gsl/gsl_matrix.h>
 #include <gsl/gsl_vector.h>
 
-/** aylp:matmul
+/** \file matmul.h
+ *
+ * aylp:matmul
  *
  * types and units: `[T_VECTOR|T_MATRIX, U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`
  *

diff --git a/devices/pid.h b/devices/pid.h
@@ -4,7 +4,9 @@
 #include <time.h>
 #include "anyloop.h"
 
-/** aylp:pid
+/** \file pid.h
+ *
+ * aylp:pid
  *
  * types and units: `[T_VECTOR|T_MATRIX, U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`
  *

diff --git a/devices/poke.h b/devices/poke.h
@@ -5,7 +5,9 @@
 #include <gsl/gsl_matrix.h>
 #include <gsl/gsl_vector.h>
 
-/** aylp:poke
+/** \file poke.h
+ *
+ * aylp:poke
  *
  * types and units: `[T_VECTOR, U_MINMAX] -> [T_VECTOR, U_MINMAX]`
  *

diff --git a/devices/stop_after_count.h b/devices/stop_after_count.h
@@ -3,7 +3,9 @@
 
 #include "anyloop.h"
 
-/** aylp:stop_after_count
+/** \file stop_after_count.h
+ *
+ * aylp:stop_after_count
  *
  * types and units: `[T_ANY, U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`
  *

diff --git a/devices/test_source.h b/devices/test_source.h
@@ -3,7 +3,9 @@
 
 #include "anyloop.h"
 
-/** aylp:test_source
+/** \file test_source.h
+ *
+ * aylp:test_source
  *
  * types and units: `[T_ANY, U_ANY] -> [
  *   T_VECTOR|T_MATRIX|T_MATRIX_UCHAR,

diff --git a/devices/udp_sink.h b/devices/udp_sink.h
@@ -6,7 +6,9 @@
 #include <sys/uio.h>
 #include "anyloop.h"
 
-/** aylp:udp_sink
+/** \file udp_sink.h
+ *
+ * aylp:udp_sink
  *
  * types and units: `[T_ANY, U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`
  *

diff --git a/devices/vonkarman_stream.h b/devices/vonkarman_stream.h
@@ -5,7 +5,9 @@
 #include <gsl/gsl_matrix.h>
 #include <gsl/gsl_rng.h>
 
-/** aylp:vonkarman_stream
+/** \file vonkarman_stream.h
+ *
+ * aylp:vonkarman_stream
  *
  * types and units: `[T_ANY, U_ANY] -> [T_MATRIX, U_RAD]`
  *

diff --git a/libaylp/anyloop.h b/libaylp/anyloop.h
@@ -1,6 +1,8 @@
 #ifndef AYLP_ANYLOOP_H_
 #define AYLP_ANYLOOP_H_
 
+/// \file anyloop.h
+
 #define _GNU_SOURCE
 
 #include <stdint.h>
@@ -38,6 +40,7 @@ _Static_assert(sizeof(size_t) == 8, "we need size_t to be 64-bit for gsl");
 
 /** Flags pertaining to loop status. */
 typedef uint8_t aylp_status;
+/// \ref aylp_status
 enum {
 	/** Signals that we are done with the loop. */
 	AYLP_DONE	= 1 << 0,
@@ -51,6 +54,7 @@ enum {
  * "unaltered" when set as a device output.
  */
 typedef uint8_t aylp_type;
+/// \ref aylp_type
 enum {
 	/** Indicates that there is no data in the pipeline yet. */
 	AYLP_T_NONE		= 1 << 0,
@@ -78,6 +82,7 @@ enum {
  * "unaltered" when set as a device output.
  */
 typedef uint8_t aylp_units;
+/// \ref aylp_units
 enum {
 	/** Indicates that there is no data in the pipeline yet. */
 	AYLP_U_NONE	= 1 << 0,