Julius Pfrommer лет назад: 10
Родитель
Сommit
d6535c92f6
3 измененных файлов с 24 добавлено и 2 удалено
  1. 1 1
      doc/Doxyfile.in
  2. 6 0
      doc/mainpage.dox
  3. 17 1
      src/ua_services.h

+ 1 - 1
doc/Doxyfile.in

@@ -774,7 +774,7 @@ INPUT_ENCODING         = UTF-8
 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
 # *.qsf, *.as and *.js.
 
-FILE_PATTERNS          = *.h
+FILE_PATTERNS          = *.h *.dox
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.

+ 6 - 0
doc/mainpage.dox

@@ -0,0 +1,6 @@
+/**
+\mainpage Open62541 Developer Documentation
+
+This file should contain some high-level description and pointers for further reading.
+
+*/

+ 17 - 1
src/ua_services.h

@@ -1,3 +1,9 @@
+/**
+ * @file ua_services.h
+ *
+ * @brief Defines the method signatures for all the standard defined services.
+ */
+
 #ifndef UA_SERVICES_H_
 #define UA_SERVICES_H_
 
@@ -5,6 +11,14 @@
 #include "ua_application.h"
 #include "ua_transport_binary_secure.h"
 
+/**
+ * @defgroup services Services
+ *
+ * @brief This module describes all the services used to communicate in in OPC UA.
+ *
+ * @{
+ */
+
 /**
  * @name Discovery Service Set
  *
@@ -112,7 +126,7 @@ UA_Int32 Service_CloseSession(SL_Channel *channel, const UA_CloseSessionRequest
  */ 
 UA_Int32 Service_Browse(SL_Channel *channel, const UA_BrowseRequest *request, UA_BrowseResponse *response);
 // Service_BrowseNext
-// Service_TranslateBrowsePathsRoNodeIds
+// Service_TranslateBrowsePathsToNodeIds
 // Service_RegisterNodes
 // Service_UnregisterNodes
 /** @} */
@@ -209,4 +223,6 @@ UA_Int32 Service_CreateMonitoredItems(SL_Channel *channel, const UA_CreateMonito
 // Service_DeleteSubscription
 /** @} */
 
+/** @} */ // end of group
+
 #endif