- added GOOSE publisher API documentation to doxygen file

mbourhis · Sep 8, 2023 · 5012b3e · 5012b3e
1 parent ec09724
commit 5012b3e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/Doxyfile.in b/src/Doxyfile.in
@@ -792,6 +792,7 @@ INPUT                  = "iec61850/inc/iec61850_client.h" \
                          "iec61850/inc/iec61850_cdc.h" \
                          "goose/goose_subscriber.h" \
                          "goose/goose_receiver.h" \
+                         "goose/goose_publisher.h" \
                          "sampled_values/sv_subscriber.h" \
                          "sampled_values/sv_publisher.h" \
                          "mms/inc/mms_types.h" \

diff --git a/src/goose/goose_publisher.h b/src/goose/goose_publisher.h
@@ -32,6 +32,11 @@
 extern "C" {
 #endif
 
+/**
+ * \defgroup goosepub_api_group IEC 61850 GOOSE publisher API
+ */
+/**@{*/
+
 #ifndef GOOSE_SV_COMM_PARAMETERS
 #define GOOSE_SV_COMM_PARAMETERS
 
@@ -210,4 +215,6 @@ GoosePublisher_reset(GoosePublisher self);
 }
 #endif
 
+/**@}*/
+
 #endif /* GOOSE_PUBLISHER_H_ */