Skip to content

Commit c15ac2c

Browse files
committed
doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE
doc: Change header to notitle
1 parent 3ce8298 commit c15ac2c

File tree

3 files changed

+17
-20
lines changed

3 files changed

+17
-20
lines changed

doc/Doxyfile.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -790,7 +790,7 @@ WARN_LOGFILE =
790790
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
791791
# Note: If this tag is empty the current directory is searched.
792792

793-
INPUT = src
793+
INPUT = src doc/README_doxygen.md
794794

795795
# This tag can be used to specify the character encoding of the source files
796796
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -974,7 +974,7 @@ FILTER_SOURCE_PATTERNS =
974974
# (index.html). This can be useful if you have a project on for instance GitHub
975975
# and want to reuse the introduction page also for the doxygen output.
976976

977-
USE_MDFILE_AS_MAINPAGE =
977+
USE_MDFILE_AS_MAINPAGE = doc/README_doxygen.md
978978

979979
#---------------------------------------------------------------------------
980980
# Configuration options related to source browsing

doc/README_doxygen.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
\mainpage notitle
2+
3+
\section intro_sec Introduction
4+
5+
This is the developer documentation of the reference client for an experimental new digital currency called Bitcoin,
6+
which enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
7+
with no central authority: managing transactions and issuing money are carried out collectively by the network.
8+
9+
The software is a community-driven open source project, released under the MIT license.
10+
11+
See https://github.com/bitcoin/bitcoin and https://bitcoincore.org/ for further information about the project.
12+
13+
\section Navigation
14+
Use the buttons <code>Namespaces</code>, <code>Classes</code> or <code>Files</code> at the top of the page to start navigating the code.
15+

src/bitcoind.cpp

-18
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,6 @@
2525

2626
const std::function<std::string(const char*)> G_TRANSLATION_FUN = nullptr;
2727

28-
/* Introduction text for doxygen: */
29-
30-
/*! \mainpage Developer documentation
31-
*
32-
* \section intro_sec Introduction
33-
*
34-
* This is the developer documentation of the reference client for an experimental new digital currency called Bitcoin,
35-
* which enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
36-
* with no central authority: managing transactions and issuing money are carried out collectively by the network.
37-
*
38-
* The software is a community-driven open source project, released under the MIT license.
39-
*
40-
* See https://github.com/bitcoin/bitcoin and https://bitcoincore.org/ for further information about the project.
41-
*
42-
* \section Navigation
43-
* Use the buttons <code>Namespaces</code>, <code>Classes</code> or <code>Files</code> at the top of the page to start navigating the code.
44-
*/
45-
4628
static void WaitForShutdown()
4729
{
4830
while (!ShutdownRequested())

0 commit comments

Comments
 (0)