4935: update API documentation

svn: r17644
2011-06-01 12:45:39 +00:00 · 2011-06-01 12:45:39 +00:00 · 85b57d44bb
commit 85b57d44bb
parent 10906f43be
2 changed files with 135 additions and 119 deletions
--- 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:
--- a/docs/gen/gen_lib.rst
+++ b/docs/gen/gen_lib.rst
@ -18,66 +18,6 @@ BaseObject
   :undoc-members:
   :show-inheritance:

-RefBase
-====================================
-.. automodule:: gen.lib.refbase
-.. autoclass:: RefBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-PrivacyBase
-====================================
-.. automodule:: gen.lib.privacybase
-.. autoclass:: PrivacyBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-SourceBase
-====================================
-.. automodule:: gen.lib.srcbase
-.. autoclass:: SourceBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-NoteBase
-====================================
-.. automodule:: gen.lib.notebase
-.. autoclass:: NoteBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-MediaBase
-====================================
-.. automodule:: gen.lib.mediabase
-.. autoclass:: MediaBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-PlaceBase
-====================================
-.. automodule:: gen.lib.placebase
-.. autoclass:: PlaceBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-LocationBase
-====================================
-.. automodule:: gen.lib.locationbase
-.. autoclass:: LocationBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
 AddressBase
 ====================================
 .. automodule:: gen.lib.addressbase
@ -86,7 +26,6 @@ AddressBase
   :undoc-members:
   :show-inheritance:

-
 AttributeBase
 ====================================
 .. automodule:: gen.lib.attrbase
@ -95,14 +34,6 @@ AttributeBase
   :undoc-members:
   :show-inheritance:
   
-SurnameBase
-====================================
-.. automodule:: gen.lib.surnamebase
-.. autoclass:: SurnameBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 DateBase
 ====================================
 .. automodule:: gen.lib.datebase
@ -111,14 +42,6 @@ DateBase
   :undoc-members:
   :show-inheritance:
   
-UrlBase
-====================================
-.. automodule:: gen.lib.urlbase
-.. autoclass:: UrlBase
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 LdsOrdBase
 ====================================
 .. automodule:: gen.lib.ldsordbase
@ -127,6 +50,86 @@ LdsOrdBase
   :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
+====================================
+.. automodule:: gen.lib.notebase
+.. autoclass:: NoteBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+PlaceBase
+====================================
+.. automodule:: gen.lib.placebase
+.. autoclass:: PlaceBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+PrivacyBase
+====================================
+.. automodule:: gen.lib.privacybase
+.. autoclass:: PrivacyBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   
+RefBase
+====================================
+.. automodule:: gen.lib.refbase
+.. autoclass:: RefBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+SourceBase
+====================================
+.. automodule:: gen.lib.srcbase
+.. autoclass:: SourceBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+SurnameBase
+====================================
+.. automodule:: gen.lib.surnamebase
+.. autoclass:: SurnameBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+      
+TagBase
+====================================
+.. automodule:: gen.lib.tagbase
+.. autoclass:: TagBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+UrlBase
+====================================
+.. automodule:: gen.lib.urlbase
+.. autoclass:: UrlBase
+   :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:
@ -337,6 +325,25 @@ RepoRef
   :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
@ -467,20 +446,6 @@ EventType
   :undoc-members:
   :show-inheritance:
   
-FamilyRelType
-=============
-.. automodule:: gen.lib.familyreltype
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-SourceMediaType
-================
-.. automodule:: gen.lib.srcmediatype
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 EventRoleType
 ==============
 .. automodule:: gen.lib.eventroletype
@ -488,6 +453,13 @@ EventRoleType
   :undoc-members:
   :show-inheritance:

+FamilyRelType
+=============
+.. automodule:: gen.lib.familyreltype
+   :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,6 +488,20 @@ 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
@ -509,4 +509,9 @@ StyledTextTagType
   :undoc-members:
   :show-inheritance:
   
-
+UrlType
+========
+.. automodule:: gen.lib.urltype
+   :members:
+   :undoc-members:
+   :show-inheritance: