From 25bd2bc7fe95fc7d102ed706c2b55b0f1f039c32 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jean-S=C3=A9bastien=20P=C3=A9dron?=
 <js.pedron@meetic-corp.com>
Date: Fri, 6 Feb 2009 13:35:40 +0000
Subject: [PATCH] Document the short JID type.

PR:		EJABP-1

SVN Revision: 1866
---
 ChangeLog    | 2 ++
 src/jlib.erl | 4 ++++
 2 files changed, 6 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 9e1c5c57b..b9bcbc526 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -3,6 +3,8 @@
 	* src/web/ejabberd_web.erl, src/web/ejabberd_http.erl: Add
 	documentation stub for some types. This will be filled later.
 
+	* src/jlib.erl: Document the short JID type.
+
 2009-02-05  Jean-Sébastien Pédron  <js.pedron@meetic-corp.com>
 
 	* src/ejabberd_auth.erl, src/ejabberd_auth_anonymous.erl,
diff --git a/src/jlib.erl b/src/jlib.erl
index aba42c935..f19dd052e 100644
--- a/src/jlib.erl
+++ b/src/jlib.erl
@@ -49,6 +49,10 @@
 
 -include("jlib.hrl").
 
+%% @type shortjid() = {U, S, R}
+%%     U = binary()
+%%     S = binary()
+%%     R = binary().
 
 parse_xdata_submit(#xmlel{attrs = Attrs, children = Els}) ->
     case exmpp_xml:get_attribute_from_list_as_list(Attrs, 'type', "") of