Permalink
Browse files

Update some development documentation.

Update doc/getting_started.txt
Complete doxygen documentation for src/tds/token.c

Signed-off-by: Frediano Ziglio <freddy77@gmail.com>
  • Loading branch information...
freddy77 committed Feb 15, 2014
1 parent 0c22970 commit 44a5c9a9b4aa826db459a831aabddb77eba24b8a
Showing with 1,959 additions and 20 deletions.
  1. +31 −0 doc/getting_started.txt
  2. +5 −0 include/fakepoll.h
  3. +5 −0 src/tds/data.c
  4. +1,767 −0 src/tds/mem.plist/report-E7qheL.html
  5. +150 −20 src/tds/token.c
  6. +1 −0 tds.dox
View
@@ -84,6 +84,37 @@ general there will be one tds_process_*() function for each marker unless it is
not worth looking at, in which case tds_process_default_tokens() will read past
it.
+libTDS
+------
+
+libTDS (src/tds) is the core of this projects
+
+Files details (not exaustive):
+* convert.c Handles conversion between types;
+* bulk.c Handles bulk transfer;
+* config.c Handles configuration files;
+* data.c Handles handling different column types;
+* numeric.c Handles specific numeric stuff;
+* net.c Low level network stuff including socket and SSL;
+* packet.c Handles network stream at packet level, all TDS communication
+ is encapsulated in packets (TDS packets, do not confuse with network
+ ones);
+* locale.c Deals with locale information;
+* log.c Handles logging;
+* mem.c Handles allocation and freeing of structures;
+* login.c Handles login with server (contains tds_connect);
+* read.c, write.c Handle reading and writing to TDS packets;
+* query.c Contains all routines to send requests;
+* token.c Contains all routines to get reply from server;
+* tds_checks.c, tds_checks.h Internal checks;
+* iconv.c, alternative_character_sets.h, character_sets.h
+ and sybase_character_sets.h Handle character conversions;
+* tdsstring.c Dynamic string management;
+* challenge.c, des.c, gssapi.c, hmac_md5.c, md4.c, md5.c,
+ sspi.c Deals with various authentications;
+* stream.c Deals with large stream of data;
+* threadsafe.c Utilities for thread safe.
+
Misc
----
View
@@ -1,4 +1,9 @@
/* $Id: fakepoll.h,v 1.5 2011-05-16 08:51:40 freddy77 Exp $ */
+
+/** \file
+ * \brief Provide poll call where missing
+ */
+
#if !defined(_FAKE_POLL_H) && !defined(HAVE_POLL)
#define _FAKE_POLL_H
View
@@ -17,6 +17,11 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * @file data.c
+ * @brief Handle different data handling from network
+ */
+
#include <config.h>
#include <stdarg.h>
Oops, something went wrong.

0 comments on commit 44a5c9a

Please sign in to comment.