mdbx: more Doxygen tags (almost done).

Change-Id: I696e717e37a905f68af059c51f9df327c257332e

GNUmakefile

@@ -270,8 +270,8 @@ docs/intro.md: docs/_preface.md docs/__characteristics.md docs/__improvements.md
 docs/usage.md: docs/__usage.md docs/_starting.md docs/__bindings.md
 	echo -e "\\page usage Usage\n\\section getting Getting the libmdbx" | cat - $? | sed 's/^Bindings$$/Bindings {#bindings}/' > $@
 
-doxygen: docs/Doxyfile docs/overall.md docs/intro.md docs/usage.md mdbx.h ChangeLog.md
-	rm -rf docs/html && cp mdbx.h ChangeLog.md docs/ && (cd docs && doxygen Doxyfile)
+doxygen: docs/Doxyfile docs/overall.md docs/intro.md docs/usage.md mdbx.h ChangeLog.md AUTHORS LICENSE
+	rm -rf docs/html && cp mdbx.h ChangeLog.md docs/ && (cd docs && doxygen Doxyfile) && cp AUTHORS LICENSE docs/html/
 
 .PHONY: dist release-assets
 dist: libmdbx-sources-$(MDBX_VERSION_SUFFIX).tar.gz $(lastword $(MAKEFILE_LIST))

README.md

@@ -460,9 +460,9 @@ from the [ios-cmake](https://github.com/leetal/ios-cmake) project.
 <!-- section-end -->
 
 ## API description
-For more information and API description see the [mdbx.h](mdbx.h) header.
-Please do not hesitate to point out errors in the documentation,
-including creating [PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) with corrections and improvements.
+
+Please refer to the online [_libmdbx_ API reference](https://erthink.github.io/libmdbx/)
+and/or see the [mdbx.h](mdbx.h) header.
 
 <!-- section-begin bindings -->
 

docs/Doxyfile.in

@@ -1558,7 +1558,7 @@ FORMULA_MACROFILE      =
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-USE_MATHJAX            = NO
+USE_MATHJAX            = YES
 
 # When MathJax is enabled you can set the default output format to be used for
 # the MathJax output. See the MathJax site (see:

docs/_toc.md

@@ -34,8 +34,9 @@ each of which is divided into several sections.
     - Cleaning up
   - \ref bindings
 
-3. The `C` API reference manual:
-  - TODO
+3. The `C` API manual:
+  - The \ref c_api reference
+  - The \ref mdbx.h header file reference
 
 Please do not hesitate to point out errors in the documentation,
 including creating [PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) with corrections and improvements.

src/core.c

@@ -15708,7 +15708,7 @@ static int __cold mdbx_env_compact(MDBX_env *env, MDBX_txn *read_txn,
   MDBX_meta *const meta = mdbx_init_metas(env, buffer);
   mdbx_meta_set_txnid(env, meta, read_txn->mt_txnid);
 
-  if (flags & MDBX_CP_FORCE_RESIZEABLE)
+  if (flags & MDBX_CP_FORCE_DYNAMIC_SIZE)
     make_sizeable(meta);
 
   /* copy canary sequenses if present */
@@ -15864,7 +15864,7 @@ static int __cold mdbx_env_copy_asis(MDBX_env *env, MDBX_txn *read_txn,
       (MDBX_meta *)(buffer + ((uint8_t *)mdbx_meta_head(env) - env->me_map));
   mdbx_txn_unlock(env);
 
-  if (flags & MDBX_CP_FORCE_RESIZEABLE)
+  if (flags & MDBX_CP_FORCE_DYNAMIC_SIZE)
     make_sizeable(headcopy);
   /* Update signature to steady */
   headcopy->mm_datasync_sign = mdbx_meta_sign(headcopy);
@@ -17666,7 +17666,7 @@ int __cold mdbx_env_pgwalk(MDBX_txn *txn, MDBX_pgvisitor_func *visitor,
   return rc;
 }
 
-int mdbx_canary_put(MDBX_txn *txn, const mdbx_canary *canary) {
+int mdbx_canary_put(MDBX_txn *txn, const MDBX_canary *canary) {
   int rc = check_txn_rw(txn, MDBX_TXN_BLOCKED);
   if (unlikely(rc != MDBX_SUCCESS))
     return rc;
@@ -17685,7 +17685,7 @@ int mdbx_canary_put(MDBX_txn *txn, const mdbx_canary *canary) {
   return MDBX_SUCCESS;
 }
 
-int mdbx_canary_get(const MDBX_txn *txn, mdbx_canary *canary) {
+int mdbx_canary_get(const MDBX_txn *txn, MDBX_canary *canary) {
   int rc = check_txn(txn, MDBX_TXN_BLOCKED);
   if (unlikely(rc != MDBX_SUCCESS))
     return rc;

src/internals.h

@@ -304,7 +304,7 @@ typedef struct MDBX_meta {
 #define mm_psize mm_dbs[FREE_DBI].md_xsize
 /* Any persistent environment flags, see mdbx_env */
 #define mm_flags mm_dbs[FREE_DBI].md_flags
-  mdbx_canary mm_canary;
+  MDBX_canary mm_canary;
 
 #define MDBX_DATASIGN_NONE 0u
 #define MDBX_DATASIGN_WEAK 1u
@@ -770,7 +770,7 @@ struct MDBX_txn {
    * don't decrement it when individual DB handles are closed. */
   MDBX_dbi mt_numdbs;
   size_t mt_owner; /* thread ID that owns this transaction */
-  mdbx_canary mt_canary;
+  MDBX_canary mt_canary;
 
   union {
     struct {

src/mdbx_dump.c

@@ -138,7 +138,7 @@ static int dump_sdb(MDBX_txn *txn, MDBX_dbi dbi, char *name) {
     printf("mapsize=%" PRIu64 "\n", info.mi_geo.upper);
     printf("maxreaders=%u\n", info.mi_maxreaders);
 
-    mdbx_canary canary;
+    MDBX_canary canary;
     rc = mdbx_canary_get(txn, &canary);
     if (unlikely(rc != MDBX_SUCCESS)) {
       error("mdbx_canary_get", rc);

src/mdbx_load.c

@@ -109,7 +109,7 @@ static char *subname = nullptr;
 static int dbi_flags;
 static txnid_t txnid;
 static uint64_t sequence;
-static mdbx_canary canary;
+static MDBX_canary canary;
 static MDBX_envinfo envinfo;
 
 #define PRINT 1

test/test.cc

@@ -411,7 +411,7 @@ bool testcase::should_continue(bool check_timeout_only) const {
 }
 
 void testcase::fetch_canary() {
-  mdbx_canary canary_now;
+  MDBX_canary canary_now;
   log_trace(">> fetch_canary");
 
   int rc = mdbx_canary_get(txn_guard.get(), &canary_now);
@@ -434,7 +434,7 @@ void testcase::fetch_canary() {
 }
 
 void testcase::update_canary(uint64_t increment) {
-  mdbx_canary canary_now = last.canary;
+  MDBX_canary canary_now = last.canary;
 
   log_trace(">> update_canary: sequence %" PRIu64 " += %" PRIu64, canary_now.y,
             increment);

test/test.h

@@ -155,7 +155,7 @@ protected:
   keygen::maker keyvalue_maker;
 
   struct {
-    mdbx_canary canary;
+    MDBX_canary canary;
   } last;
 
   SET speculum{ItemCompare(this)}, speculum_commited{ItemCompare(this)};