Start blocking out some documentation.

- Fix some C rdoc so it is parsed correctly.
  - Fill out transaction testing.
  - Populate docs for DB options.

FossilOrigin-Name: f54dbfacf2dda100a116fdcc856ca5231e249f23238ca9d4355618e3a380a8f8
This commit is contained in:
Mahlon E. Smith 2021-02-14 09:47:04 +00:00
parent 81ee69295c
commit a54c286a75
11 changed files with 345 additions and 43 deletions

View file

@ -14,12 +14,18 @@ Init_mdbx_ext()
{
rmdbx_mMDBX = rb_define_module( "MDBX" );
/* The backend library version. */
VALUE version = rb_str_new_cstr( mdbx_version.git.describe );
/* The backend MDBX library version. */
rb_define_const( rmdbx_mMDBX, "LIBRARY_VERSION", version );
/* A generic exception class for internal Database errors. */
rmdbx_eDatabaseError = rb_define_class_under( rmdbx_mMDBX, "DatabaseError", rb_eRuntimeError );
rmdbx_eRollback = rb_define_class_under( rmdbx_mMDBX, "Rollback", rb_eRuntimeError );
/*
* Raising an MDBX::Rollback exception from within a transaction
* discards all changes and closes the transaction.
*/
rmdbx_eRollback = rb_define_class_under( rmdbx_mMDBX, "Rollback", rb_eRuntimeError );
rmdbx_init_database();
}