mirror of
https://github.com/isar/libmdbx.git
synced 2024-12-30 02:34:13 +08:00
mdbx-doc: simplify Doxygen TOC.
Change-Id: I9f433628433fd8deea6c4128c4e1452bcadfba49
This commit is contained in:
parent
64e35a1e44
commit
7272403cfd
@ -268,7 +268,7 @@ docs/intro.md: docs/_preface.md docs/__characteristics.md docs/__improvements.md
|
||||
cat $^ | sed 's/^Performance comparison$$/Performance comparison {#performance}/' > $@
|
||||
|
||||
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}/' > $@
|
||||
echo -e "\\page usage Usage\n\\section getting Building & Embedding" | cat - $^ | sed 's/^Bindings$$/Bindings {#bindings}/' > $@
|
||||
|
||||
doxygen: docs/Doxyfile docs/overall.md docs/intro.md docs/usage.md mdbx.h src/options.h ChangeLog.md AUTHORS LICENSE
|
||||
rm -rf docs/html && cp mdbx.h src/options.h ChangeLog.md docs/ && (cd docs && doxygen Doxyfile) && cp AUTHORS LICENSE docs/html/
|
||||
|
19
docs/_toc.md
19
docs/_toc.md
@ -8,30 +8,11 @@ each of which is divided into several sections.
|
||||
|
||||
1. The \ref intro
|
||||
- \ref characteristics
|
||||
- Preface
|
||||
- Features
|
||||
- Limitations
|
||||
- Gotchas
|
||||
- Comparison with other databases
|
||||
- \ref restrictions
|
||||
- \ref performance
|
||||
- Integral performance
|
||||
- Read Scalability
|
||||
- Sync-write mode
|
||||
- Lazy-write mode
|
||||
- Async-write mode
|
||||
- Cost comparison
|
||||
2. \ref usage
|
||||
- \ref getting
|
||||
- Embedding
|
||||
- Building
|
||||
- \ref starting
|
||||
- Opening
|
||||
- Cursors
|
||||
- Threads and processes
|
||||
- Transactions
|
||||
- Duplicate keys aka Multi-values
|
||||
- Cleaning up
|
||||
- \ref bindings
|
||||
|
||||
3. The `C` API manual:
|
||||
|
Loading…
x
Reference in New Issue
Block a user