update APIs documentation according to last changes (GEPS008)

svn: r20032
This commit is contained in:
Jérôme Rapinat
2012-07-19 08:55:23 +00:00
parent 37e6616185
commit 17350a8c2f
9 changed files with 172 additions and 87 deletions

View File

@@ -4,6 +4,60 @@ The :mod:`gen` Module
.. automodule:: gen
*****************************
Database State
*****************************
.. automodule:: gen.dbstate
.. autoclass:: DbState
:members:
:undoc-members:
:show-inheritance:
*****************************
Errors
*****************************
.. automodule:: gen.errors
.. autoclass:: DatabaseError
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: DateError
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: DbError
:members:
:undoc-members:
:show-inheritance:
TODO
*****************************
Recent Files
*****************************
.. automodule:: gen.recentfiles
.. autoclass:: RecentFiles
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: RecentItem
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: RecentParser
:members:
:undoc-members:
:show-inheritance:
*****************************
Sort
*****************************
.. automodule:: gen.sort
.. autoclass:: Sort
:members:
:undoc-members:
:show-inheritance:
*****************************
Update callback
*****************************

View File

@@ -34,10 +34,6 @@ Private
References
====================================
.. automodule:: gen.proxy.referenced
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.proxy.referencedbyselection
:members:
:undoc-members:

View File

@@ -14,11 +14,59 @@ Utils
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.cast
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.config
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.configmanager
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.fallback
.. automodule:: gen.utils.db
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.file
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.id
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.image
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.keyword
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.lds
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.mactrans
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.place
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.string
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.trans
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.unknown
:members:
:undoc-members:
:show-inheritance: