From 47994ff5690ec8ccc6050652505c6e699bd8c29f Mon Sep 17 00:00:00 2001 From: Gerald Britton Date: Wed, 9 Sep 2009 14:43:18 +0000 Subject: [PATCH] Documentation updates svn: r13182 --- docs/gen/gen_db.rst | 122 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 119 insertions(+), 3 deletions(-) diff --git a/docs/gen/gen_db.rst b/docs/gen/gen_db.rst index 745ca0d5a..7f3283f29 100644 --- a/docs/gen/gen_db.rst +++ b/docs/gen/gen_db.rst @@ -13,7 +13,7 @@ Base object GrampsDbBase ==================================== .. automodule:: gen.db.base -.. autoclass:: gen.db.base.GrampsDbBase +.. autoclass:: GrampsDbBase :members: :undoc-members: :show-inheritance: @@ -25,7 +25,7 @@ Read object GrampsDbRead ==================================== .. automodule:: gen.db.read -.. autoclass:: gen.db.read.GrampsDbRead +.. autoclass:: GrampsDbRead :members: :show-inheritance: @@ -36,8 +36,124 @@ Write object GrampsDbWrite ==================================== .. automodule:: gen.db.write -.. autoclass:: gen.db.write.GrampsDBDir +.. autoclass:: GrampsDBDir :members: :undoc-members: :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: