2691: Create api documentation with sphinx

svn: r12704

src/gen/lib/eventref.py

@@ -91,8 +91,8 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         """
         Return the list of all textual attributes of the object.
 
-        @return: Returns the list of all textual attributes of the object.
-        @rtype: list
+        :returns: Returns the list of all textual attributes of the object.
+        :rtype: list
         """
         return [self.__role.string]
 
@@ -100,8 +100,8 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         """
         Return the list of child objects that may carry textual data.
 
-        @return: Returns the list of child objects that may carry textual data.
-        @rtype: list
+        :returns: Returns the list of child objects that may carry textual data.
+        :rtype: list
         """
         return  self.attribute_list
 
@@ -109,9 +109,9 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         """
         Return the list of child secondary objects that may refer sources.
 
-        @return: Returns the list of child secondary child objects that may 
+        :returns: Returns the list of child secondary child objects that may 
                 refer sources.
-        @rtype: list
+        :rtype: list
         """
         return self.attribute_list
 
@@ -119,9 +119,9 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         """
         Return the list of child secondary objects that may refer notes.
 
-        @return: Returns the list of child secondary child objects that may 
+        :returns: Returns the list of child secondary child objects that may 
                 refer notes.
-        @rtype: list
+        :rtype: list
         """
         return self.attribute_list
 
@@ -130,9 +130,9 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         Return the list of (classname, handle) tuples for all directly
         referenced primary objects.
         
-        @return: Returns the list of (classname, handle) tuples for referenced 
+        :returns: Returns the list of (classname, handle) tuples for referenced 
                 objects.
-        @rtype: list
+        :rtype: list
         """
         ret = self.get_referenced_note_handles()
         if self.ref:
@@ -144,8 +144,8 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         Return the list of child objects which may, directly or through their 
         children, reference primary objects..
         
-        @return: Returns the list of objects refereincing primary objects.
-        @rtype: list
+        :returns: Returns the list of objects refereincing primary objects.
+        :rtype: list
         """
         return self.get_sourcref_child_list()
 
@@ -154,11 +154,11 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         Return True if any of the child objects has reference to this source 
         handle.
 
-        @param src_handle: The source handle to be checked.
-        @type src_handle: str
-        @return: Returns whether any of it's child objects has reference to 
+        :param src_handle: The source handle to be checked.
+        :type src_handle: str
+        :returns: Returns whether any of it's child objects has reference to 
                 this source handle.
-        @rtype: bool
+        :rtype: bool
         """
         for item in self.get_sourcref_child_list():
             if item.has_source_reference(src_handle):
@@ -171,8 +171,8 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         Remove references to all source handles in the list in all child 
         objects.
 
-        @param src_handle_list: The list of source handles to be removed.
-        @type src_handle_list: list
+        :param src_handle_list: The list of source handles to be removed.
+        :type src_handle_list: list
         """
         for item in self.get_sourcref_child_list():
             item.remove_source_references(src_handle_list)
@@ -182,10 +182,10 @@ class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase):
         Replace references to source handles in the list in this object and 
         all child objects.
 
-        @param old_handle: The source handle to be replaced.
-        @type old_handle: str
-        @param new_handle: The source handle to replace the old one with.
-        @type new_handle: str
+        :param old_handle: The source handle to be replaced.
+        :type old_handle: str
+        :param new_handle: The source handle to replace the old one with.
+        :type new_handle: str
         """
         for item in self.get_sourcref_child_list():
             item.replace_source_references(old_handle, new_handle)