Skip to content

Commit

Permalink
Added docstrings in infinote/rudel-infinote-group-directory.el
Browse files Browse the repository at this point in the history
* infinote/rudel-infinote-group-directory.el
  (rudel-infinote-directory-state-idle): added documentation string
  (rudel-infinote-directory-state-idle::rudel-infinote/sync-in):
  return nil to avoid state switch
  (rudel-infinote-directory-state-exploring): added documentation
  string
  (rudel-infinote-directory-state-subscribing): added documentation
  string
  • Loading branch information
scymtym committed Feb 4, 2010
1 parent c05c152 commit 35a0a23
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions infinote/rudel-infinote-group-directory.el
Expand Up @@ -49,7 +49,7 @@
(defclass rudel-infinote-directory-state-idle
(rudel-infinote-group-state)
()
"")
"Idle state of the directory group.")

(defmethod rudel-infinote/add-node
((this rudel-infinote-directory-state-idle) xml)
Expand All @@ -75,11 +75,11 @@
nil))

(defmethod rudel-infinote/sync-in
((this rudel-infinote-directory-state-idle)
xml)
((this rudel-infinote-directory-state-idle) xml)
""
;; TODO can contain child <subscribe group="group_name" method="method_name" />
(with-tag-attrs (id parent name type group method) xml) ;; optional? seq
(with-tag-attrs (id parent name type group method) xml ;; optional? seq
nil)
)


Expand All @@ -92,7 +92,8 @@
:type (integer 0)
:documentation
""))
"")
"Directory group state entered when the children of a node are
explored.")

(defmethod rudel-enter
((this rudel-infinote-directory-state-exploring) id)
Expand Down Expand Up @@ -141,7 +142,7 @@
(defclass rudel-infinote-directory-state-subscribing
(rudel-infinote-group-state)
()
"")
"Directory group state entered when subscribing to a session.")

(defmethod rudel-enter
((this rudel-infinote-directory-state-subscribing) id)
Expand Down Expand Up @@ -175,7 +176,7 @@



;;; states
;;; Directory group states
;;

(defvar rudel-infinote-group-directory-states
Expand Down

0 comments on commit 35a0a23

Please sign in to comment.