aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2013-11-17 14:17:39 +0100
committerWladimir J. van der Laan <laanwj@gmail.com>2013-11-17 14:17:39 +0100
commit0e165b97d97e76e2fd3a6e78306e78121dd74bd2 (patch)
treee01ebecbbd3f7b3f05a762ecd311879a10d75184 /src
parentaf6e093f062548d850b6eb510240aeb1ff24e2a3 (diff)
downloadbitcoin-0e165b97d97e76e2fd3a6e78306e78121dd74bd2.tar.xz
doc: small doxygen update
I was merging change this every time before generation of the doxygen developer docs (https://dev.visucore.com/bitcoin/doxygen/) but there's no reason why it can't just be merged upstream.
Diffstat (limited to 'src')
-rw-r--r--src/bitcoind.cpp16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/bitcoind.cpp b/src/bitcoind.cpp
index f0aad4f33a..6dbab240bf 100644
--- a/src/bitcoind.cpp
+++ b/src/bitcoind.cpp
@@ -13,6 +13,22 @@
#include <boost/algorithm/string/predicate.hpp>
#include <boost/filesystem.hpp>
+/* 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 Bitcoin (http://www.bitcoin.org/),
+ * which enables instant payments to anyone, anywhere in the world. Bitcoin 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 <code>Namespaces</code>, <code>Classes</code> or <code>Files</code> at the top of the page to start navigating the code.
+ */
+
void DetectShutdownThread(boost::thread_group* threadGroup)
{
bool fShutdown = ShutdownRequested();