Chapril/xmpp.chapril.org-ejabberd
24
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-06-06 21:37:17 +02:00
Code Releases Activity

Fix Edoc errors (thanks to Karim Gemayel)

Browse Source
This commit is contained in:
Badlop 2010-09-30 13:44:16 +02:00
parent 78b8307a1f
commit 349c44fcc0
1 changed files with 39 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
src/mod_pubsub/pubsub.hrl
View File

@ -50,7 +50,10 @@
-type(hostPubsub() :: binary()).
%%% @type hostPEP() = {User::binary(), Server::binary, Resource::undefined}.
%%% @type hostPEP() = {User, Server, Resource}
%%% User = binary()
%%% Server = binary()
%%% Resource = undefined.
-type(hostPEP() :: {User::binary(), Server::binary, Resource::undefined}).
@ -99,33 +102,43 @@
-type(nodeType() :: string()).
%%% @type ljid() = {User::binary(), Server::binary(), Resource::binary()}.
%%% @type ljid() = {User, Server, Resource}
%%% User = undefined | binary()
%%% Server = binary()
%%% Resource = undefined | binary().
-type(ljid() :: {User::binary(), Server::binary(), Resource::binary()}).
%% TODO : move upper in exmpp
%%% @type jidComponent() =
%% #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined}.
%%% @type jidComponent() = {jid, Raw, Node, Domain, Resource}
%%% Raw = binary()
%%% Node = undefined
%%% Domain = binary()
%%% Resource = undefined.
-type(jidComponent() ::
#jid{raw::binary(), node::undefined, domain::binary(), resource::undefined}).
%% TODO : move upper in exmpp
%%% @type jidContact() =
%% #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined}.
%%% @type jidContact() = {jid, Raw, Node, Domain, Resource}
%%% Raw = binary()
%%% Node = binary()
%%% Domain = binary()
%%% Resource = undefined.
-type(jidContact() ::
#jid{raw::binary(), node::binary(), domain::binary(), resource::undefined}).
%% TODO : move upper in exmpp
%%% @type jidEntity() =
%%% #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined}
%%% #jid{raw::binary(), node::binary(), domain::binary(), resource::binary()}
%%% #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined}
%%% #jid{raw::binary(), node::undefined, domain::binary(), resource::binary()}.
%%% @type jidEntity() = {jid, Raw, Node, Domain, Resource}
%%% Raw = binary()
%%% Node = undefined | binary()
%%% Domain = binary()
%%% Resource = undefined | binary().
-type(jidEntity() ::
%% Contact bare JID
@ -138,17 +151,20 @@
#jid{raw::binary(), node::undefined, domain::binary(), resource::binary()}).
%%% @type bareUsr() = {User::binary(), Server::binary(), Resource::undefined}
%%% | {User::undefined, Server::binary(), Resource::undefined}.
%%% @type bareUsr() = {User, Server, Resource}
%%% User = undefined | binary()
%%% Server = binary()
%%% Resource = undefined.
-type(bareUsr() :: {User::binary(), Server::binary(), Resource::undefined}
| {User::undefined, Server::binary(), Resource::undefined}).
%%% @type fullUsr() = {User::binary(), Server::binary(), Resource::undefined}
%%% | {User::binary(), Server::binary(), Resource::binary()}
%%% | {User::undefined, Server::binary(), Resource::undefined}
%%% | {User::undefined, Server::binary(), Resource::binary()}.
%%% @type fullUsr() = {User, Server, Resource}
%%% User = undefined | binary()
%%% Server = binary()
%%% Resource = undefined | binary().
-type(fullUsr() :: {User::binary(), Server::binary(), Resource::undefined}
| {User::binary(), Server::binary(), Resource::binary()}
@ -161,7 +177,10 @@
-type(nodeIdx() :: integer()).
%%% @type now() = {Megaseconds::integer(), Seconds::integer(), Microseconds::integer()}.
%%% @type now() = {Megaseconds, Seconds, Microseconds}
%%% Megaseconds = integer()
%%% Seconds = integer()
%%% Microseconds = integer().
-type(now() :: {Megaseconds::integer(), Seconds::integer(), Microseconds::integer()}).
@ -223,7 +242,8 @@
-type(pubsubIQResponse() :: #xmlel{}).
%%% @type features() = [Feature::string()].
%%% @type features() = [Feature]
%%% Feature = string().
-type(features() :: [Feature::string()]).