diff options
| author | Badlop <badlop@process-one.net> | 2010-09-30 13:44:16 +0200 |
|---|---|---|
| committer | Badlop <badlop@process-one.net> | 2010-09-30 13:44:16 +0200 |
| commit | 349c44fcc0bef5b6cbf95fbeca92e1b2b0267e4f (patch) | |
| tree | f17e2afc7ea33d4a2f4add3ca586bb1959762546 /src | |
| parent | fix dializer warnings (thanks to Karim Gemayel) (diff) | |
Fix Edoc errors (thanks to Karim Gemayel)
Diffstat (limited to 'src')
| -rw-r--r-- | src/mod_pubsub/pubsub.hrl | 58 |
1 files changed, 39 insertions, 19 deletions
diff --git a/src/mod_pubsub/pubsub.hrl b/src/mod_pubsub/pubsub.hrl index be062f28b..832b4d8c4 100644 --- a/src/mod_pubsub/pubsub.hrl +++ b/src/mod_pubsub/pubsub.hrl @@ -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()]). |