Changeset 580 for trunk/zoo-project/zoo-kernel/service_yaml.c

Timestamp:

Feb 12, 2015, 11:18:07 PM (9 years ago)

Author:

djay

Message:

Continue adding initial doxygen documentation.

File:

• trunk/zoo-project/zoo-kernel/service_yaml.c (modified) (2 diffs)

trunk/zoo-project/zoo-kernel/service_yaml.c

@@ -1 @@
-/**
+/*
  * Author : Gérald FENOY
  *
@@ -31 +31 @@
 static map* current_content=NULL;
 static elements* current_element=NULL;
-static char* curr_key;
-
-/**
- * getServiceFromFile :
- * set service given as second parameter with informations extracted from the
- * definition file.
- */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/**
+ * Read and parse a ZCFG file in YAML format 
+ *
+ * @param conf the conf maps containing the main.cfg settings
+ * @param file the file name to read
+ * @param service the service structure to fill
+ * @param name the service name
+ * @return 1 on success, -1 if error occured
+ */
 int getServiceFromYAML(maps* conf, char* file,service** service,char *name){
   FILE *fh = fopen("test.yml", "r");