diff options
| author | Jon Layton <me@jonl.io> | 2019-09-18 18:54:20 -0400 |
|---|---|---|
| committer | Jon Layton <me@jonl.io> | 2019-09-23 19:22:06 -0400 |
| commit | c15ac2c0aa45c59aee6d36c2d6d5210290dc601c (patch) | |
| tree | f0fd042e440c5c307773f8a6aa06bd892660da7d /doc | |
| parent | 3ce829888861a6dc6a29da669584ada961d965fa (diff) | |
doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE
doc: Change header to notitle
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile.in | 4 | ||||
| -rw-r--r-- | doc/README_doxygen.md | 15 |
2 files changed, 17 insertions, 2 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 399d54eb85..cd7ccf80ab 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -790,7 +790,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = src +INPUT = src 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 @@ -974,7 +974,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..608680ad3e --- /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 Bitcoin, +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. + +See https://github.com/bitcoin/bitcoin and https://bitcoincore.org/ for further information about the project. + +\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. + |