Added a lot of internal documentation

Signed-off-by: Frediano Ziglio <freddy77@gmail.com>
FreeTDS · Feb 19, 2014 · ce8fe69 · ce8fe69
1 parent 1ecc08f
commit ce8fe69
Show file tree

Hide file tree

Showing 3 changed files with 190 additions and 21 deletions.
diff --git a/include/freetds/proto.h b/include/freetds/proto.h
@@ -249,10 +249,10 @@ typedef enum
  */
 typedef enum
 {
-	  TDS_OPT_SET = 1	/* Set an option. */
+	  TDS_OPT_SET = 1	/**< Set an option. */
-	, TDS_OPT_DEFAULT = 2	/* Set option to its default value. */
+	, TDS_OPT_DEFAULT = 2	/**< Set option to its default value. */
-	, TDS_OPT_LIST = 3	/* Request current setting of a specific option. */
+	, TDS_OPT_LIST = 3	/**< Request current setting of a specific option. */
-	, TDS_OPT_INFO = 4	/* Report current setting of a specific option. */
+	, TDS_OPT_INFO = 4	/**< Report current setting of a specific option. */
 } TDS_OPTION_CMD;
 
 typedef enum

diff --git a/src/tds/log.c b/src/tds/log.c
@@ -270,9 +270,12 @@ tdsdump_start(FILE *file, const char *fname, int line)
 
 /**
  * Dump the contents of data into the log file in a human readable format.
- * \param msg      message to print before dump
+ * \param file       source file name
- * \param buf      buffer to dump
+ * \param level_line line and level combined. This and file are automatically computed by
- * \param length   number of bytes in the buffer
+ *                   TDS_DBG_* macros.
+ * \param msg        message to print before dump
+ * \param buf        buffer to dump
+ * \param length     number of bytes in the buffer
  */
 void
 tdsdump_dump_buf(const char* file, unsigned int level_line, const char *msg, const void *buf, size_t length)
@@ -423,7 +426,6 @@ tdsdump_log(const char* file, unsigned int level_line, const char *fmt, ...)
 
 /**
  * Write a column value to the debug log.  
- * \param file name of the log file
  * \param col column to dump
  */
 void