Browse code

- fix a few errors in doxygen documentation - sync one function definitions variables with declaration

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@5254 689a6050-402a-0410-94f2-e92a70836424

Henning Westerholt authored on 25/11/2008 09:34:15
Showing 4 changed files
... ...
@@ -41,8 +41,14 @@
41 41
 #include "res.h"
42 42
 
43 43
 
44
-/*! \brief
45
- * Get and convert columns from a result
44
+/*!
45
+ * \brief Get and convert columns from a result
46
+ *
47
+ * Get and convert columns from a result, fills the result structure
48
+ * with data from the database.
49
+ * \param _h database connection
50
+ * \param _r database result set
51
+ * \return 0 on success, negative on failure
46 52
  */
47 53
 int db_mysql_get_columns(const db_con_t* _h, db_res_t* _r)
48 54
 {
... ...
@@ -143,8 +149,11 @@ int db_mysql_get_columns(const db_con_t* _h, db_res_t* _r)
143 149
 }
144 150
 
145 151
 
146
-/*! \brief
147
- * Convert rows from mysql to db API representation
152
+/*!
153
+ * \brief Convert rows from mysql to db API representation
154
+ * \param _h database connection
155
+ * \param _r database result set
156
+ * \return 0 on success, negative on failure
148 157
  */
149 158
 static inline int db_mysql_convert_rows(const db_con_t* _h, db_res_t* _r)
150 159
 {
... ...
@@ -190,8 +199,11 @@ static inline int db_mysql_convert_rows(const db_con_t* _h, db_res_t* _r)
190 199
 }
191 200
 
192 201
 
193
-/*! \brief
194
- * Fill the structure with data from database
202
+/*!
203
+ * \brief Fill the result structure with data from database
204
+ * \param _h database connection
205
+ * \param _r database result
206
+ * \return 0 on success, negative on failure
195 207
  */
196 208
 int db_mysql_convert_result(const db_con_t* _h, db_res_t* _r)
197 209
 {
... ...
@@ -38,11 +38,21 @@
38 38
 #include "../../db/db_con.h"
39 39
 
40 40
 
41
-/*
42
- * Fill the structure with data from database
41
+/*!
42
+ * \brief Fill the result structure with data from database
43
+ * \param _h database connection
44
+ * \param _r database result
45
+ * \return 0 on success, negative on failure
43 46
  */
44 47
 int db_mysql_convert_result(const db_con_t* _h, db_res_t* _r);
45 48
 
49
+
50
+/*!
51
+ * \brief Get and convert columns from a result
52
+ * \param _h database connection
53
+ * \param _r database result set
54
+ * \return 0 on success, negative on failure
55
+ */
46 56
 int db_mysql_get_columns(const db_con_t* _h, db_res_t* _r);
47 57
 
48
-#endif /* RES_H */
58
+#endif
... ...
@@ -37,8 +37,12 @@
37 37
 #include "val.h"
38 38
 #include "row.h"
39 39
 
40
-/*! \brief
41
- * Convert a row from result into db API representation
40
+/*!
41
+ * \brief Convert a row from result into DB API representation
42
+ * \param _h database connection
43
+ * \param _res database result in the DB API representation
44
+ * \param _r database result row
45
+ * \return 0 on success, -1 on failure
42 46
  */
43 47
 int db_mysql_convert_row(const db_con_t* _h, db_res_t* _res, db_row_t* _r)
44 48
 {
... ...
@@ -39,9 +39,13 @@
39 39
 #include "../../db/db_row.h"
40 40
 
41 41
 
42
-/**
43
- * Convert a row from result into db API representation
42
+/*!
43
+ * \brief Convert a row from result into DB API representation
44
+ * \param _h database connection
45
+ * \param _res database result in the DB API representation
46
+ * \param _r database result row
47
+ * \return 0 on success, -1 on failure
44 48
  */
45 49
 int db_mysql_convert_row(const db_con_t* _h, db_res_t* _res, db_row_t* _r);
46 50
 
47
-#endif /* ROW_H */
51
+#endif