diff options
| author | Alexis Hildebrandt <afh@surryhill.net> | 2023-04-09 17:49:19 +0200 |
|---|---|---|
| committer | Alexis Hildebrandt <afh@surryhill.net> | 2023-04-10 09:01:23 +0200 |
| commit | 75c1aeb269285a41c388e416ed1cb5f1108ddb44 (patch) | |
| tree | 356c7c16b2e046a3389e01061e1f094c5c4e34a8 /doc | |
| parent | 339706f6a6cb92801d32d2530cc4856120af040e (diff) | |
| download | fork-ledger-75c1aeb269285a41c388e416ed1cb5f1108ddb44.tar.gz fork-ledger-75c1aeb269285a41c388e416ed1cb5f1108ddb44.tar.bz2 fork-ledger-75c1aeb269285a41c388e416ed1cb5f1108ddb44.zip | |
doc: Add API documentation main page
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile.in | 2 | ||||
| -rw-r--r-- | doc/mainpage.txt | 10 |
2 files changed, 11 insertions, 1 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 87196437..58683baa 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -680,7 +680,7 @@ WARN_LOGFILE = # with spaces. # please update dependencies in CMakeList.txt if you change this -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../src +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../src @CMAKE_CURRENT_SOURCE_DIR@/mainpage.txt # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/doc/mainpage.txt b/doc/mainpage.txt new file mode 100644 index 00000000..51ec956c --- /dev/null +++ b/doc/mainpage.txt @@ -0,0 +1,10 @@ +/** +\mainpage API Documentation + +\section intro_sec Introduction + +Documentation of the Ledger API is an ongoing process and you are invited +to help out and contribute. In case you find this documentation incorrent, +incomplete, unclear, or entirely lacking please +[open a pull request](https://git.ledger-cli.org/ledger/pulls). +*/ |