From f1b9f1fb63bb35a2424a913bd4167459a6fcc823 Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 13 Oct 2009 21:36:32 +0000 Subject: [PATCH] Fix EDoc compilation errors. SVN Revision: 2667 --- src/mod_pubsub/mod_pubsub.erl | 2 +- src/mod_pubsub/mod_pubsub_odbc.erl | 2 +- src/mod_pubsub/node_hometree.erl | 6 +++--- src/mod_pubsub/node_hometree_odbc.erl | 6 +++--- src/mod_pubsub/nodetree_tree.erl | 6 +++--- src/mod_pubsub/nodetree_tree_odbc.erl | 6 +++--- src/mod_pubsub/nodetree_virtual.erl | 8 ++++---- src/mod_pubsub/pubsub.hrl | 9 +++++---- 8 files changed, 23 insertions(+), 22 deletions(-) diff --git a/src/mod_pubsub/mod_pubsub.erl b/src/mod_pubsub/mod_pubsub.erl index 2918ae17d..444175548 100644 --- a/src/mod_pubsub/mod_pubsub.erl +++ b/src/mod_pubsub/mod_pubsub.erl @@ -1536,7 +1536,7 @@ find_authorization_response(Packet) -> %% Host = mod_pubsub:host() %% JID = jlib:jid() %% SNode = string() -%% Subscription = atom() | {atom(), mod_pubsub:subid)} +%% Subscription = atom() | {atom(), mod_pubsub:subid()} %% Plugins = [Plugin::string()] %% @doc Send a message to JID with the supplied Subscription send_authorization_approval(Host, JID, SNode, Subscription) -> diff --git a/src/mod_pubsub/mod_pubsub_odbc.erl b/src/mod_pubsub/mod_pubsub_odbc.erl index dbed3e0b0..93e07c172 100644 --- a/src/mod_pubsub/mod_pubsub_odbc.erl +++ b/src/mod_pubsub/mod_pubsub_odbc.erl @@ -1368,7 +1368,7 @@ find_authorization_response(Packet) -> %% Host = mod_pubsub:host() %% JID = jlib:jid() %% SNode = string() -%% Subscription = atom() | {atom(), mod_pubsub:subid)} +%% Subscription = atom() | {atom(), mod_pubsub:subid()} %% Plugins = [Plugin::string()] %% @doc Send a message to JID with the supplied Subscription send_authorization_approval(Host, JID, SNode, Subscription) -> diff --git a/src/mod_pubsub/node_hometree.erl b/src/mod_pubsub/node_hometree.erl index d8d933e4c..c3fa6e293 100644 --- a/src/mod_pubsub/node_hometree.erl +++ b/src/mod_pubsub/node_hometree.erl @@ -245,7 +245,7 @@ delete_node(Removed) -> end, Removed), {result, {default, broadcast, Reply}}. -%% @spec (NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup) -> +%% @spec (NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> %% {error, Reason} | {result, Result} %% @doc

Accepts or rejects subcription requests on a PubSub node.

%%

The mechanism works as follow: @@ -851,8 +851,8 @@ set_state(State) when is_record(State, pubsub_state) -> set_state(_) -> {error, 'internal-server-error'}. -%% @spec (StateId) -> ok | {error, Reason::stanzaError()} -%% StateId = mod_pubsub:pubsubStateId() +%% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()} +%% NodeId = mod_pubsub:pubsubNodeId() %% @doc

Delete a state from database.

del_state(NodeId, JID) -> mnesia:delete({pubsub_state, {JID, NodeId}}). diff --git a/src/mod_pubsub/node_hometree_odbc.erl b/src/mod_pubsub/node_hometree_odbc.erl index 74d2ffd71..4bac466db 100644 --- a/src/mod_pubsub/node_hometree_odbc.erl +++ b/src/mod_pubsub/node_hometree_odbc.erl @@ -263,7 +263,7 @@ delete_node(Removed) -> end, Removed), {result, {default, broadcast, Reply}}. -%% @spec (NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup) -> +%% @spec (NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> %% {error, Reason} | {result, Result} %% @doc

Accepts or rejects subcription requests on a PubSub node.

%%

The mechanism works as follow: @@ -945,8 +945,8 @@ set_state(NodeId, State) -> end, {result, []}. -%% @spec (StateId) -> ok | {error, Reason::stanzaError()} -%% StateId = mod_pubsub:pubsubStateId() +%% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()} +%% NodeId = mod_pubsub:pubsubNodeId() %% @doc

Delete a state from database.

del_state(NodeId, JID) -> J = encode_jid(JID), diff --git a/src/mod_pubsub/nodetree_tree.erl b/src/mod_pubsub/nodetree_tree.erl index 16a960430..9ea51658e 100644 --- a/src/mod_pubsub/nodetree_tree.erl +++ b/src/mod_pubsub/nodetree_tree.erl @@ -103,7 +103,7 @@ set_node(Record) when is_record(Record, pubsub_node) -> set_node(_) -> {error, 'internal-server-error'}. -%% @spec (Host, Node) -> pubsubNode() | {error, Reason} +%% @spec (Host, Node, From) -> pubsubNode() | {error, Reason} %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() get_node(Host, Node, _From) -> @@ -121,7 +121,7 @@ get_node(NodeId) -> Error -> Error end. -%% @spec (Host) -> [pubsubNode()] | {error, Reason} +%% @spec (Host, From) -> [pubsubNode()] | {error, Reason} %% Host = mod_pubsub:host() | mod_pubsub:jid() get_nodes(Host, _From) -> get_nodes(Host). @@ -165,7 +165,7 @@ get_subnodes(Host, Node) -> lists:member(Node, Parents)]), qlc:e(Q). -%% @spec (Host, Index) -> [pubsubNodeIdx()] | {error, Reason} +%% @spec (Host, Index, From) -> [pubsubNodeIdx()] | {error, Reason} %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% From = mod_pubsub:jid() diff --git a/src/mod_pubsub/nodetree_tree_odbc.erl b/src/mod_pubsub/nodetree_tree_odbc.erl index 04f657fb2..4d1995f1f 100644 --- a/src/mod_pubsub/nodetree_tree_odbc.erl +++ b/src/mod_pubsub/nodetree_tree_odbc.erl @@ -91,7 +91,7 @@ options() -> {odbc, true}]. -%% @spec (Host, Node) -> pubsubNode() | {error, Reason} +%% @spec (Host, Node, From) -> pubsubNode() | {error, Reason} %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() get_node(Host, Node, _From) -> @@ -125,7 +125,7 @@ get_node(NodeId) -> {error, 'item_not_found'} end. -%% @spec (Host) -> [pubsubNode()] | {error, Reason} +%% @spec (Host, From) -> [pubsubNode()] | {error, Reason} %% Host = mod_pubsub:host() | mod_pubsub:jid() get_nodes(Host, _From) -> get_nodes(Host). @@ -182,7 +182,7 @@ get_subnodes(Host, Node) -> [] end. -%% @spec (Host, Index) -> [pubsubNodeIdx()] | {error, Reason} +%% @spec (Host, Index, From) -> [pubsubNodeIdx()] | {error, Reason} %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% From = mod_pubsub:jid() diff --git a/src/mod_pubsub/nodetree_virtual.erl b/src/mod_pubsub/nodetree_virtual.erl index bd9b74713..6285d724c 100644 --- a/src/mod_pubsub/nodetree_virtual.erl +++ b/src/mod_pubsub/nodetree_virtual.erl @@ -26,7 +26,7 @@ %%% @doc The module {@module} is the PubSub node tree plugin that %%% allow virtual nodes handling. %%%

PubSub node tree plugins are using the {@link gen_nodetree} behaviour.

-%%% This plugin development is still a work in progress. Due to optimizations in +%%%

The development of this plugin is still a work in progress. Due to optimizations in %%% mod_pubsub, this plugin can not work anymore without altering functioning. %%% Please, send us comments, feedback and improvements.

@@ -84,7 +84,7 @@ options() -> set_node(_NodeRecord) -> ok. -%% @spec (Host, Node) -> pubsubNode() +%% @spec (Host, Node, From) -> pubsubNode() %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% @doc

Virtual node tree does not handle a node database. Any node is considered @@ -96,7 +96,7 @@ get_node(Host, Node) -> get_node({Host, _} = NodeId) -> #pubsub_node{nodeid = NodeId, id = NodeId, owners = [{undefined, list_to_binary(Host), undefined}]}. -%% @spec (Host) -> [pubsubNode()] +%% @spec (Host, From) -> [pubsubNode()] %% Host = mod_pubsub:host() | mod_pubsub:jid() %% @doc

Virtual node tree does not handle a node database. Any node is considered %% as existing. Nodes list can not be determined.

@@ -115,7 +115,7 @@ get_subnodes(Host, Node, _From) -> get_subnodes(_Host, _Node) -> []. -%% @spec (Host, Index) -> [pubsubNode()] +%% @spec (Host, Index, From) -> [pubsubNode()] %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% @doc

Virtual node tree does not handle parent/child. Child list is empty.

diff --git a/src/mod_pubsub/pubsub.hrl b/src/mod_pubsub/pubsub.hrl index 1fa8af397..e437c979c 100644 --- a/src/mod_pubsub/pubsub.hrl +++ b/src/mod_pubsub/pubsub.hrl @@ -85,12 +85,13 @@ %%% @type pubsubNode() = #pubsub_node{ %%% nodeid = {Host::host(), Node::pubsubNode()}, %%% parentid = Node::pubsubNode(), -%%% nodeidx = int(). % can be anything you want +%%% nodeidx = int(), %%% type = nodeType(), -%%% options = [nodeOption()]} +%%% options = [nodeOption()]}. %%%

This is the format of the nodes table. The type of the table %%% is: set,ram/disc.

%%%

The parentid and type fields are indexed.

+%%%

nodeidx can be anything you want.

-record(pubsub_node, {nodeid, id, parents = [], @@ -100,7 +101,7 @@ }). %%% @type pubsubState() = #pubsub_state{ -%%% stateid = {ljid(), nodeidx()}}, +%%% stateid = {ljid(), nodeidx()}, %%% items = [ItemId::string()], %%% affiliation = affiliation(), %%% subscriptions = [subscription()]}. @@ -113,7 +114,7 @@ }). %%% @type pubsubItem() = #pubsub_item{ -%%% itemid = {ItemId::string(), nodeidx()}}, +%%% itemid = {ItemId::string(), nodeidx()}, %%% creation = {now(), ljid()}, %%% modification = {now(), ljid()}, %%% payload = XMLContent::string()}.