Documentation updates

svn: r13182
This commit is contained in:
Gerald Britton 2009-09-09 14:43:18 +00:00
parent e9b89204a8
commit 47994ff569

View File

@ -13,7 +13,7 @@ Base object
GrampsDbBase GrampsDbBase
==================================== ====================================
.. automodule:: gen.db.base .. automodule:: gen.db.base
.. autoclass:: gen.db.base.GrampsDbBase .. autoclass:: GrampsDbBase
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -25,7 +25,7 @@ Read object
GrampsDbRead GrampsDbRead
==================================== ====================================
.. automodule:: gen.db.read .. automodule:: gen.db.read
.. autoclass:: gen.db.read.GrampsDbRead .. autoclass:: GrampsDbRead
:members: :members:
:show-inheritance: :show-inheritance:
@ -36,8 +36,124 @@ Write object
GrampsDbWrite GrampsDbWrite
==================================== ====================================
.. automodule:: gen.db.write .. automodule:: gen.db.write
.. autoclass:: gen.db.write.GrampsDBDir .. autoclass:: GrampsDBDir
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
*****************************
Cursor
*****************************
GrampsCursor
====================================
.. automodule:: gen.db.cursor
.. autoclass:: GrampsCursor
:members:
:undoc-members:
:show-inheritance:
*****************************
BSDDB txn
*****************************
BSDDBtxn
====================================
.. automodule:: gen.db.bsddbtxn
.. autoclass:: BSDDBTxn
:members:
:undoc-members:
:show-inheritance:
*****************************
Txn object
*****************************
GrampsDbTxn
====================================
.. automodule:: gen.db.txn
.. autoclass:: GrampsDbTxn
:members:
:undoc-members:
:show-inheritance:
*****************************
Undoredo object
*****************************
GrampsDbUndo
====================================
.. automodule:: gen.db.undoredo
.. autoclass:: GrampsDbUndo
:members:
:undoc-members:
:show-inheritance:
GrampsDbUndoList
====================================
.. autoclass:: GrampsDbUndoList
:members:
:undoc-members:
:show-inheritance:
GrampsDbUndoBSDDB
====================================
.. autoclass:: GrampsDbUndoBSDDB
:members:
:undoc-members:
:show-inheritance:
*****************************
Dbconst object
*****************************
DbConst
====================================
.. automodule:: gen.db.dbconst
:members:
*****************************
Exceptions object
*****************************
GrampsDbException
====================================
.. automodule:: gen.db.exceptions
.. autoclass:: GrampsDbException
:members:
:undoc-members:
:show-inheritance:
GrampsDbWriteFailure
====================================
.. autoclass:: GrampsDbWriteFailure
:members:
:undoc-members:
:show-inheritance:
FileVersionError
====================================
.. autoclass:: FileVersionError
:members:
:undoc-members:
:show-inheritance:
FileVersionDeclineToUpgrade
====================================
.. autoclass:: FileVersionDeclineToUpgrade
:members:
:undoc-members:
:show-inheritance:
*****************************
Upgrade utilities
*****************************
.. automodule:: gen.db.upgrade
:members:
:undoc-members: