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

20
src/gen/lib/mediaref.py
View File

@@ -83,8 +83,8 @@ class MediaRef(SecondaryObject, PrivacyBase, SourceBase, NoteBase, 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 + self.source_list
@@ -92,9 +92,9 @@ class MediaRef(SecondaryObject, PrivacyBase, SourceBase, NoteBase, 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
@@ -102,9 +102,9 @@ class MediaRef(SecondaryObject, PrivacyBase, SourceBase, NoteBase, 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 + self.source_list
@@ -113,8 +113,8 @@ class MediaRef(SecondaryObject, PrivacyBase, SourceBase, NoteBase, RefBase,
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.ref:
@@ -126,8 +126,8 @@ class MediaRef(SecondaryObject, PrivacyBase, SourceBase, NoteBase, 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.attribute_list + self.source_list