diff --git a/doc/doxygen/Doxyfile.cmake.in b/doc/doxygen/Doxyfile.cmake.in --- a/doc/doxygen/Doxyfile.cmake.in +++ b/doc/doxygen/Doxyfile.cmake.in @@ -790,7 +790,8 @@ # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ${CMAKE_SOURCE_DIR}/src +INPUT = ${CMAKE_SOURCE_DIR}/src \ + ${CMAKE_SOURCE_DIR}/doc/doxygen/README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -974,7 +975,7 @@ # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = ${CMAKE_SOURCE_DIR}/doc/doxygen/README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/doc/doxygen/README.md b/doc/doxygen/README.md new file mode 100644 --- /dev/null +++ b/doc/doxygen/README.md @@ -0,0 +1,21 @@ +\mainpage notitle + +\section intro_sec Introduction + +This is the developer documentation of Bitcoin ABC +(https://www.bitcoinabc.org/). Bitcoin ABC is a client for the digital +currency called Bitcoin Cash (https://www.bitcoincash.org/), which enables +instant payments to anyone, anywhere in the world. Bitcoin Cash uses +peer-to-peer technology to operate with no central authority: managing +transactions and issuing money are carried out collectively by the network. + +The software is a community-driven open source project, released under the +MIT license. + +\section Navigation +Use Modules, +Namespaces, +Classes, or +Files at the top of the page +to start navigating the code. + diff --git a/src/bitcoind.cpp b/src/bitcoind.cpp --- a/src/bitcoind.cpp +++ b/src/bitcoind.cpp @@ -28,27 +28,6 @@ const std::function G_TRANSLATION_FUN = nullptr; -/* Introduction text for doxygen: */ - -/*! \mainpage Developer documentation - * - * \section intro_sec Introduction - * - * This is the developer documentation of Bitcoin ABC - * (https://www.bitcoinabc.org/). Bitcoin ABC is a client for the digital - * currency called Bitcoin Cash (https://www.bitcoincash.org/), which enables - * instant payments to anyone, anywhere in the world. Bitcoin Cash uses - * peer-to-peer technology to operate with no central authority: managing - * transactions and issuing money are carried out collectively by the network. - * - * The software is a community-driven open source project, released under the - * MIT license. - * - * \section Navigation - * Use the buttons Namespaces, Classes or - * Files at the top of the page to start navigating the code. - */ - static void WaitForShutdown(NodeContext &node) { while (!ShutdownRequested()) { UninterruptibleSleep(std::chrono::milliseconds{200});