From 610f1e41d8d21f8a37a60844ed6c5eab5489f3f1 Mon Sep 17 00:00:00 2001 From: MarcoFalke Date: Tue, 24 Sep 2019 11:32:34 -0400 Subject: [PATCH] Merge #16912: doc: Remove Doxygen intro from src/bitcoind.cpp dbdc758c27cfdda9d255742b6c6ff4d1b7be82df doc: Improve doxygen readme navigation section (Jon Layton) c15ac2c0aa45c59aee6d36c2d6d5210290dc601c doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE (Jon Layton) Pull request description: With `USE_MDFILE_AS_MAINPAGE`, this moves the introductory Doxygen comment to its own file. This makes `bitcoind.cpp` cleaner. It also removes the `\mainpage` header text, which was smaller than the section titles, and improves the Navigation section. ACKs for top commit: promag: ACK dbdc758c27cfdda9d255742b6c6ff4d1b7be82df. Tree-SHA512: 9352baad655877437913b74dc8888a71d1cccf55a837657ee2630fde3f427d0f0339155b7ab3d9e63a9edb9d53512d747eafcb11987a7c26c47a6df2eca93351 --- doc/Doxyfile.in | 4 ++-- doc/README_doxygen.md | 15 +++++++++++++++ src/dashd.cpp | 16 ---------------- 3 files changed, 17 insertions(+), 18 deletions(-) create mode 100644 doc/README_doxygen.md diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index b716bafe31..ba3307198d 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -793,7 +793,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = src dash-docs doc/release-notes/dash +INPUT = src dash-docs doc/release-notes/dash doc/README_doxygen.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 @@ -989,7 +989,7 @@ FILTER_SOURCE_PATTERNS = # (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 = doc/README_doxygen.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/doc/README_doxygen.md b/doc/README_doxygen.md new file mode 100644 index 0000000000..80bf136164 --- /dev/null +++ b/doc/README_doxygen.md @@ -0,0 +1,15 @@ +\mainpage notitle + +\section intro_sec Introduction + +This is the developer documentation of the reference client for an experimental new digital currency called Dash, +which enables instant payments to anyone, anywhere in the world. Dash 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. + +See https://github.com/dashpay/dash and https://dash.org/ for further information about the project. + +\section Navigation +Use Modules, Namespaces, Classes, or Files at the top of the page to start navigating the code. + diff --git a/src/dashd.cpp b/src/dashd.cpp index 5b4bc0d0b8..d621d57846 100644 --- a/src/dashd.cpp +++ b/src/dashd.cpp @@ -29,22 +29,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 the reference client for an experimental new digital currency called Dash (https://www.dash.org/), - * which enables instant payments to anyone, anywhere in the world. Dash 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() { while (!ShutdownRequested())