Some docs written by Thorns. Need reviewing.

4 files changed, 50 insertions, 0 deletions

diff --git a/doc/.directory b/doc/.directory
new file mode 100644
index 00000000..2bcc45d8
--- /dev/null
+++ b/doc/.directory
@@ -0,0 +1,3 @@
+[Dolphin]
+Timestamp=2008,9,15,21,41,28
+ViewMode=1
diff --git a/doc/lxmppd_core_offlinemessages.txt b/doc/lxmppd_core_offlinemessages.txt
new file mode 100644
index 00000000..fa06a8e0
--- /dev/null
+++ b/doc/lxmppd_core_offlinemessages.txt
@@ -0,0 +1,12 @@
+lxmppd -> core -> offlinemessages.lua
+	requires	"util.datamanager"
+	module		"offlinemessage"
+
+function new(user, host, stanza)
+	returns a function that stores the offline message it received
+
+This module offers storing of offline messages.
+
+Description:	If the user that is supposed to get the message is not online,
+		we store the messages locally as offline messages for later
+		processing.
\ No newline at end of file
diff --git a/doc/lxmppd_core_rostermanager.txt b/doc/lxmppd_core_rostermanager.txt
new file mode 100644
index 00000000..4f501158
--- /dev/null
+++ b/doc/lxmppd_core_rostermanager.txt
@@ -0,0 +1,9 @@
+lxmppd -> core -> rostermanager.lua
+	requires	"util.datamanager"
+	module		"rostermanager"
+	
+function log(type, message)
+	logs a message of type "rostermanager"
+
+function getroster(username, host)
+	Retrieves the user's roster from the server and loads it with the datamanager
\ No newline at end of file
diff --git a/doc/lxmppd_core_stanz_dispatch.txt b/doc/lxmppd_core_stanz_dispatch.txt
new file mode 100644
index 00000000..c76844e9
--- /dev/null
+++ b/doc/lxmppd_core_stanz_dispatch.txt
@@ -0,0 +1,26 @@
+lxmppd -> core -> stanza_dispatch
+	requires	"util.stanza"
+	requires	"core.usermanager"
+	
+function init_stanza_dispatcher(session)
+	Initialises the stanza dispatcher which handles different stanza according
+	to their type and XML namespace, dispatching to required handlers.
+	
+	iq_handlers["jabber:iq:auth"]
+		A list of handlers for "jabber:iq:auth" stanzas -- authentication
+		(request) stanzas.
+		
+		function (stanza)
+			If one of username, password and resource are missing then it ????.
+			If not, then it validates the credentials and replies with the
+			appropriate stanza.
+			
+	iq_handlers["jabber:iq:roster"]
+		A list of handlers for "jabber:iq:roster" stanzas -- roster management
+		
+		function (stanza)
+			Parses the type of stanza for roster management and does what is
+			requested (roster retrieval, etc.)
+	
+	function (stanza)
+		Validates the stanza and calls the required handler