From 75c1aeb269285a41c388e416ed1cb5f1108ddb44 Mon Sep 17 00:00:00 2001 From: Alexis Hildebrandt Date: Sun, 9 Apr 2023 17:49:19 +0200 Subject: doc: Add API documentation main page --- doc/Doxyfile.in | 2 +- doc/mainpage.txt | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 doc/mainpage.txt (limited to 'doc') 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). +*/ -- cgit v1.2.3