# HG changeset patch
# User Nicolas Cornu <nicolas.cornu@ensi-bourges.fr>
# Date 1281976375 -7200
# Node ID 4fef4ced1e97e9004874f9d24b89bd12d15f22ad
# Parent  943c3f938cb4ed88ad9bbbdf97cfaae41170f4ef
Fix the doc

diff -r 943c3f938cb4 -r 4fef4ced1e97 doc.txt
--- a/doc.txt	Mon Aug 16 02:56:46 2010 +0200
+++ b/doc.txt	Mon Aug 16 18:32:55 2010 +0200
@@ -1,16 +1,22 @@
 DOCUMENTATION:
 
 I: Jingle
-Jingle is a module who can't work alone. His meaning of life is make working
-others modules. There is two sorts of modules: applications (File Transfer, Voice)
-and transports (IBB, socks5, ...).
-The "sub-modules" must register in jingle and provide some generic function.
-After the jingle module catch and dispatch all jingle's iqs. And offer an
-interface between apps and trans.
-Jingle module keep a way of all sessions via JingleSession structures.
-This JingleSession got all the informations and a list of SessionContent, which
-are struct containing information about content and 2 gconstpointer. This pointer
-are data from apps and trans.
+Jingle is a module whose purpose is to allow other modules to work together.
+There are two sorts of modules jingle can work with: application modules
+handle or produce data (e.g. File Transfer, Voice) and transport modules
+transport the data using some method/protocol (e.g In-Band Bytestreams, SOCKS5
+Bytestreams).
+The "sub-modules" must implement a set of functions and register to the jingle
+module.
+The jingle module will catch and dispatch incoming jingle iqs and also offer an
+interface between apps and trans modules. The module also keep track of all
+initialized sessions in a linked list of JingleSession structures. This
+structure contains all the relevant informations about a session together with a
+linked list of SessionContent, a structure containing information about a
+specific content.
+SessionContent contains pointer to fonctions in the application and transport
+modules and opaque pointers to the internal representation of the app and
+transport by the corresponding app and transport modules.
 
 An application module must provide:
 - check: check if the description of a JingleContent is correct;