Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

2691: Create api documentation with sphinx

Browse Source 
svn: r12704
This commit is contained in:
Benny Malengier
2009-06-24 21:56:07 +00:00
parent 1042bb3fe2
commit a52bc62be9
68 changed files with 2203 additions and 1161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/gen/lib/ldsord.py
View File

@@ -156,8 +156,8 @@ class LdsOrd(SecondaryObject, SourceBase, NoteBase,
"""
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.temple]
#return [self.temple,self.get_date()]
@@ -166,8 +166,8 @@ class LdsOrd(SecondaryObject, SourceBase, NoteBase,
"""
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.source_list
@@ -175,9 +175,9 @@ class LdsOrd(SecondaryObject, SourceBase, NoteBase,
"""
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.source_list
@@ -186,8 +186,8 @@ class LdsOrd(SecondaryObject, SourceBase, NoteBase,
Return the list of (classname, handle) tuples for all directly
referenced primary objects.
@return: List of (classname, handle) tuples for referenced objects.
@rtype: list
:returns: List of (classname, handle) tuples for referenced objects.
:rtype: list
"""
ret = self.get_referenced_note_handles()
if self.place:
@@ -199,8 +199,8 @@ class LdsOrd(SecondaryObject, SourceBase, NoteBase,
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.source_list
@@ -208,8 +208,8 @@ class LdsOrd(SecondaryObject, SourceBase, NoteBase,
"""
Return the type of the Event.
@return: Type of the Event
@rtype: tuple
:returns: Type of the Event
:rtype: tuple
"""
return self.type
@@ -217,8 +217,8 @@ class LdsOrd(SecondaryObject, SourceBase, NoteBase,
"""
Set the type of the LdsOrd to the passed (int,str) tuple.
@param ord_type: Type to assign to the LdsOrd
@type ord_type: tuple
:param ord_type: Type to assign to the LdsOrd
:type ord_type: tuple
"""
self.type = ord_type