From 4ed7fdf52fc6afdbd1030311dda1d8940197db9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Rapinat?= Date: Wed, 1 Jun 2011 12:43:48 +0000 Subject: [PATCH] 4935: update API documentation svn: r17643 --- docs/date.rst | 11 ++ docs/gen/gen_lib.rst | 243 ++++++++++++++++++++++--------------------- 2 files changed, 135 insertions(+), 119 deletions(-) diff --git a/docs/date.rst b/docs/date.rst index 361119384..4726ea8f1 100644 --- a/docs/date.rst +++ b/docs/date.rst @@ -266,3 +266,14 @@ DateHandler (Swedish) :members: :undoc-members: :show-inheritance: + +######################################### +The :class:`Date Edition` Classes +######################################### + +DateEdit +==================================== +.. automodule:: DateEdit + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/gen/gen_lib.rst b/docs/gen/gen_lib.rst index e1e095c08..3151f18c8 100644 --- a/docs/gen/gen_lib.rst +++ b/docs/gen/gen_lib.rst @@ -18,31 +18,53 @@ BaseObject :undoc-members: :show-inheritance: -RefBase +AddressBase ==================================== -.. automodule:: gen.lib.refbase -.. autoclass:: RefBase +.. automodule:: gen.lib.addressbase +.. autoclass:: AddressBase :members: :undoc-members: :show-inheritance: -PrivacyBase +AttributeBase ==================================== -.. automodule:: gen.lib.privacybase -.. autoclass:: PrivacyBase +.. automodule:: gen.lib.attrbase +.. autoclass:: AttributeBase :members: :undoc-members: :show-inheritance: - - -SourceBase + +DateBase ==================================== -.. automodule:: gen.lib.srcbase -.. autoclass:: SourceBase +.. automodule:: gen.lib.datebase +.. autoclass:: DateBase + :members: + :undoc-members: + :show-inheritance: + +LdsOrdBase +==================================== +.. automodule:: gen.lib.ldsordbase +.. autoclass:: LdsOrdBase + :members: + :undoc-members: + :show-inheritance: + +LocationBase +==================================== +.. automodule:: gen.lib.locationbase +.. autoclass:: LocationBase + :members: + :undoc-members: + :show-inheritance: + +MediaBase +==================================== +.. automodule:: gen.lib.mediabase +.. autoclass:: MediaBase :members: :undoc-members: :show-inheritance: - NoteBase ==================================== @@ -52,14 +74,6 @@ NoteBase :undoc-members: :show-inheritance: -MediaBase -==================================== -.. automodule:: gen.lib.mediabase -.. autoclass:: MediaBase - :members: - :undoc-members: - :show-inheritance: - PlaceBase ==================================== .. automodule:: gen.lib.placebase @@ -68,29 +82,26 @@ PlaceBase :undoc-members: :show-inheritance: - -LocationBase +PrivacyBase ==================================== -.. automodule:: gen.lib.locationbase -.. autoclass:: LocationBase +.. automodule:: gen.lib.privacybase +.. autoclass:: PrivacyBase + :members: + :undoc-members: + :show-inheritance: + +RefBase +==================================== +.. automodule:: gen.lib.refbase +.. autoclass:: RefBase :members: :undoc-members: :show-inheritance: - -AddressBase +SourceBase ==================================== -.. automodule:: gen.lib.addressbase -.. autoclass:: AddressBase - :members: - :undoc-members: - :show-inheritance: - - -AttributeBase -==================================== -.. automodule:: gen.lib.attrbase -.. autoclass:: AttributeBase +.. automodule:: gen.lib.srcbase +.. autoclass:: SourceBase :members: :undoc-members: :show-inheritance: @@ -102,11 +113,11 @@ SurnameBase :members: :undoc-members: :show-inheritance: - -DateBase + +TagBase ==================================== -.. automodule:: gen.lib.datebase -.. autoclass:: DateBase +.. automodule:: gen.lib.tagbase +.. autoclass:: TagBase :members: :undoc-members: :show-inheritance: @@ -119,14 +130,6 @@ UrlBase :undoc-members: :show-inheritance: -LdsOrdBase -==================================== -.. automodule:: gen.lib.ldsordbase -.. autoclass:: LdsOrdBase - :members: - :undoc-members: - :show-inheritance: - ***************************** Primary objects ***************************** @@ -154,7 +157,6 @@ Person :undoc-members: :show-inheritance: - Family ==================================== .. automodule:: gen.lib.family @@ -163,7 +165,6 @@ Family :undoc-members: :show-inheritance: - Event ==================================== .. automodule:: gen.lib.event @@ -180,7 +181,6 @@ Place :undoc-members: :show-inheritance: - Source ==================================== .. automodule:: gen.lib.src @@ -189,7 +189,6 @@ Source :undoc-members: :show-inheritance: - Media Object ==================================== .. automodule:: gen.lib.mediaobj @@ -198,7 +197,6 @@ Media Object :undoc-members: :show-inheritance: - Repository ==================================== .. automodule:: gen.lib.repo @@ -227,7 +225,6 @@ Secondary Object :undoc-members: :show-inheritance: - Address ==================================== .. automodule:: gen.lib.address @@ -236,14 +233,6 @@ Address :undoc-members: :show-inheritance: -Location -==================================== -.. automodule:: gen.lib.location -.. autoclass:: Location - :members: - :undoc-members: - :show-inheritance: - Attribute ==================================== .. automodule:: gen.lib.attribute @@ -260,6 +249,14 @@ LdsOrd :undoc-members: :show-inheritance: +Location +==================================== +.. automodule:: gen.lib.location +.. autoclass:: Location + :members: + :undoc-members: + :show-inheritance: + Name ==================================== .. automodule:: gen.lib.name @@ -284,19 +281,10 @@ Url :undoc-members: :show-inheritance: - ***************************** Reference objects ***************************** -PersonRef -==================================== -.. automodule:: gen.lib.personref -.. autoclass:: PersonRef - :members: - :undoc-members: - :show-inheritance: - ChildRef ==================================== .. automodule:: gen.lib.childref @@ -321,10 +309,10 @@ MediaRef :undoc-members: :show-inheritance: -SourceRef +PersonRef ==================================== -.. automodule:: gen.lib.srcref -.. autoclass:: SourceRef +.. automodule:: gen.lib.personref +.. autoclass:: PersonRef :members: :undoc-members: :show-inheritance: @@ -336,6 +324,25 @@ RepoRef :members: :undoc-members: :show-inheritance: + +SourceRef +==================================== +.. automodule:: gen.lib.srcref +.. autoclass:: SourceRef + :members: + :undoc-members: + :show-inheritance: + +***************************** +Table object +***************************** + +Table object +==================================== +.. automodule:: gen.lib.tableobj + :members: + :undoc-members: + :show-inheritance: ***************************** Date objects @@ -417,20 +424,6 @@ GrampsType :undoc-members: :show-inheritance: -NameType -=========== -.. automodule:: gen.lib.nametype - :members: - :undoc-members: - :show-inheritance: - -NameOriginType -=========== -.. automodule:: gen.lib.nameorigintype - :members: - :undoc-members: - :show-inheritance: - AttributeType ============= .. automodule:: gen.lib.attrtype @@ -438,13 +431,6 @@ AttributeType :undoc-members: :show-inheritance: -UrlType -======== -.. automodule:: gen.lib.urltype - :members: - :undoc-members: - :show-inheritance: - ChildRefType ============= .. automodule:: gen.lib.childreftype @@ -452,13 +438,6 @@ ChildRefType :undoc-members: :show-inheritance: -RepositoryType -============== -.. automodule:: gen.lib.repotype - :members: - :undoc-members: - :show-inheritance: - EventType =========== .. automodule:: gen.lib.eventtype @@ -466,6 +445,13 @@ EventType :members: :undoc-members: :show-inheritance: + +EventRoleType +============== +.. automodule:: gen.lib.eventroletype + :members: + :undoc-members: + :show-inheritance: FamilyRelType ============= @@ -474,20 +460,6 @@ FamilyRelType :undoc-members: :show-inheritance: -SourceMediaType -================ -.. automodule:: gen.lib.srcmediatype - :members: - :undoc-members: - :show-inheritance: - -EventRoleType -============== -.. automodule:: gen.lib.eventroletype - :members: - :undoc-members: - :show-inheritance: - MarkerType ========== .. automodule:: gen.lib.markertype @@ -495,6 +467,20 @@ MarkerType :undoc-members: :show-inheritance: +NameType +=========== +.. automodule:: gen.lib.nametype + :members: + :undoc-members: + :show-inheritance: + +NameOriginType +============== +.. automodule:: gen.lib.nameorigintype + :members: + :undoc-members: + :show-inheritance: + NoteType ========= .. automodule:: gen.lib.notetype @@ -502,11 +488,30 @@ NoteType :undoc-members: :show-inheritance: +RepositoryType +============== +.. automodule:: gen.lib.repotype + :members: + :undoc-members: + :show-inheritance: + +SourceMediaType +================ +.. automodule:: gen.lib.srcmediatype + :members: + :undoc-members: + :show-inheritance: + StyledTextTagType ================== .. automodule:: gen.lib.styledtexttagtype :members: :undoc-members: :show-inheritance: - - + +UrlType +======== +.. automodule:: gen.lib.urltype + :members: + :undoc-members: + :show-inheritance: