Quellcode durchsuchen

Cosmetic cleanup; Remove C++-style comments in the public API

Julius Pfrommer vor 6 Jahren
Ursprung
Commit
f0385d93ba
2 geänderte Dateien mit 13 neuen und 16 gelöschten Zeilen
  1. 7 9
      include/ua_plugin_history_data_service.h
  2. 6 7
      include/ua_plugin_pubsub.h

+ 7 - 9
include/ua_plugin_history_data_service.h

@@ -32,8 +32,7 @@ struct UA_HistoryDataService {
      * sessionId and sessionContext identify the session which set this value.
      * nodeId is the node id for which data was set.
      * historizing is the nodes boolean flag for historizing
-     * value is the new value.
-     */
+     * value is the new value. */
     void
     (*setValue)(UA_Server *server,
                 void *hdsContext,
@@ -43,9 +42,9 @@ struct UA_HistoryDataService {
                 UA_Boolean historizing,
                 const UA_DataValue *value);
 
-    /* This function is called if a history read is requested
-     * with isRawReadModified set to false.
-     * Setting it to NULL will result in a response with statuscode UA_STATUSCODE_BADHISTORYOPERATIONUNSUPPORTED.
+    /* This function is called if a history read is requested with
+     * isRawReadModified set to false. Setting it to NULL will result in a
+     * response with statuscode UA_STATUSCODE_BADHISTORYOPERATIONUNSUPPORTED.
      *
      * server is the server this node lives in.
      * hdsContext is the context of the UA_HistoryDataService. UA_HistoryDataService.context
@@ -60,8 +59,7 @@ struct UA_HistoryDataService {
      *          Do not access historyData after that.
      * historyData is a proper typed pointer array pointing in the UA_HistoryReadResult extension object.
      *             use this to provide result data to the client.
-     *             Index in the array is the same as in nodesToRead and the UA_HistoryReadResult array.
-     */
+     *             Index in the array is the same as in nodesToRead and the UA_HistoryReadResult array. */
     void
     (*readRaw)(UA_Server *server,
                void *hdsContext,
@@ -76,8 +74,8 @@ struct UA_HistoryDataService {
                UA_HistoryReadResponse *response,
                UA_HistoryData * const * const historyData);
 
-    // Add more function pointer here.
-    // For example for read_event, read_modified, read_processed, read_at_time
+    /* Add more function pointer here.
+     * For example for read_event, read_modified, read_processed, read_at_time */
 };
 
 _UA_END_DECLS

+ 6 - 7
include/ua_plugin_pubsub.h

@@ -42,13 +42,13 @@ typedef enum {
 struct UA_PubSubChannel;
 typedef struct UA_PubSubChannel UA_PubSubChannel;
 
-//interface structure between network plugin and internal implementation
-struct UA_PubSubChannel{
-    UA_UInt32 publisherId;                                  // unique identifier
+/* Interface structure between network plugin and internal implementation */
+struct UA_PubSubChannel {
+    UA_UInt32 publisherId; /* unique identifier */
     UA_PubSubChannelState state;
-    UA_PubSubConnectionConfig *connectionConfig;            //link to parent connection config
+    UA_PubSubConnectionConfig *connectionConfig; /* link to parent connection config */
     UA_SOCKET sockfd;
-    void *handle;                                           //implementation specific data
+    void *handle; /* implementation specific data */
     /*@info for handle: each network implementation should provide an structure
     * UA_PubSubChannelData[ImplementationName] This structure can be used by the
     * network implementation to store network implementation specific data.*/
@@ -72,7 +72,6 @@ struct UA_PubSubChannel{
 };
 
 /**
- *
  * The UA_PubSubTransportLayer is used for the creation of new connections. Whenever on runtime a new
  * connection is request, the internal PubSub implementation call * the 'createPubSubChannel' function.
  * The 'transportProfileUri' contains the standard defined transport profile information
@@ -81,7 +80,7 @@ struct UA_PubSubChannel{
  * Take a look in the tutorial_pubsub_connection to get informations about the TransportLayer handling.
  */
 
-typedef struct UA_PubSubTransportLayer{
+typedef struct {
     UA_String transportProfileUri;
     UA_PubSubChannel * (*createPubSubChannel)(UA_PubSubConnectionConfig *connectionConfig);
 } UA_PubSubTransportLayer;