Changeset 579 for trunk/zoo-project/zoo-kernel/service_internal.h

Timestamp:

Feb 12, 2015, 5:01:11 PM (10 years ago)

Author:

djay

Message:

Add initial doxygen comments in some C files, for future documentation generation.

File:

• trunk/zoo-project/zoo-kernel/service_internal.h (modified) (4 diffs)

trunk/zoo-project/zoo-kernel/service_internal.h

@@ -1 @@
-/**
+/*
  * Author : Gérald FENOY
  *
@@ -28 +28 @@
 #pragma once 
 
+/**
+ * The default service url (overriden by serverAddress)
+ */
 #define DEFAULT_SERVICE_URL "http://www.zoo-project.org/"
+/**
+ * The time size
+ */
 #define TIME_SIZE 40
 
 #include <libintl.h>
 #include <locale.h>
+/**
+ * ZOO-Kernel internal messages translation function
+ */
 #define _(String) dgettext ("zoo-kernel",String)
+/**
+ * ZOO-Services messages translation function
+ */
 #define _ss(String) dgettext ("zoo-services",String)
 
+/**
+ * ZOO-Kernel was unable to create a lock
+ */
 #define ZOO_LOCK_CREATE_FAILED -4
+/**
+ * ZOO-Kernel was unable to acquire a lock
+ */
 #define ZOO_LOCK_ACQUIRE_FAILED -5
+/**
+ * ZOO-Kernel was unable to release a lock
+ */
 #define ZOO_LOCK_RELEASE_FAILED -6
 
@@ -89 +110 @@
 #include <libxml/xpath.h>
 
+  /**
+   * Maximum number of XML namespaces
+   */
+#define ZOO_NS_MAX 10
+  /**
+   * Maximum number of XML docs
+   */
+#define ZOO_DOC_MAX 20
+
+  /**
+   * Global char* to store the serverAddress value of the mmmmmain section
+   */
   static char* SERVICE_URL;
-  static xmlNsPtr usedNs[10];
-  static char* nsName[10];
-  static xmlDocPtr iDocs[10];
+  /**
+   * Array of xmlNsPtr storing all used XML namespace
+   */
+  static xmlNsPtr usedNs[ZOO_NS_MAX];
+  /**
+   * Array storing names of the used XML namespace
+   */
+  static char* nsName[ZOO_NS_MAX];
+  /**
+   * Number of XML namespaces
+   */
   static int nbNs=0;
+  /**
+   * Array of xmlDocPtr storing XML docs
+   */
+  static xmlDocPtr iDocs[ZOO_DOC_MAX];
+  /**
+   * Number of XML docs
+   */
   static int nbDocs=0;
 
@@ -107 +155 @@
   char* getStatus(int);
   int removeShmLock(maps*, int);
+  /**
+   * Cross platform type used for Lock identifier
+   */
 #ifndef WIN32
 #define semid int