Merge pull request #5145

484e350 Update comments in client version to be doxygen compatible (Michael Ford)
6395ba3 Update comments in version to be doxygen compatible (Michael Ford)

Author: laanwj

src/clientversion.cpp

@@ -1,5 +1,5 @@
-// Copyright (c) 2012 The Bitcoin developers
-// Distributed under the MIT/X11 software license, see the accompanying
+// Copyright (c) 2012-2014 The Bitcoin developers
+// Distributed under the MIT software license, see the accompanying
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #include "clientversion.h"
@@ -8,35 +8,41 @@
 
 #include <string>
 
-// Name of client reported in the 'version' message. Report the same name
-// for both bitcoind and bitcoin-qt, to make it harder for attackers to
-// target servers or GUI users specifically.
+/**
+ * Name of client reported in the 'version' message. Report the same name
+ * for both bitcoind and bitcoin-core, to make it harder for attackers to
+ * target servers or GUI users specifically.
+ */
 const std::string CLIENT_NAME("Satoshi");
 
-// Client version number
+/**
+ * Client version number
+ */
 #define CLIENT_VERSION_SUFFIX ""
 
 
-// The following part of the code determines the CLIENT_BUILD variable.
-// Several mechanisms are used for this:
-// * first, if HAVE_BUILD_INFO is defined, include build.h, a file that is
-//   generated by the build environment, possibly containing the output
-//   of git-describe in a macro called BUILD_DESC
-// * secondly, if this is an exported version of the code, GIT_ARCHIVE will
-//   be defined (automatically using the export-subst git attribute), and
-//   GIT_COMMIT will contain the commit id.
-// * then, three options exist for determining CLIENT_BUILD:
-//   * if BUILD_DESC is defined, use that literally (output of git-describe)
-//   * if not, but GIT_COMMIT is defined, use v[maj].[min].[rev].[build]-g[commit]
-//   * otherwise, use v[maj].[min].[rev].[build]-unk
-// finally CLIENT_VERSION_SUFFIX is added
-
-// First, include build.h if requested
+/**
+ * The following part of the code determines the CLIENT_BUILD variable.
+ * Several mechanisms are used for this:
+ * * first, if HAVE_BUILD_INFO is defined, include build.h, a file that is
+ *   generated by the build environment, possibly containing the output
+ *   of git-describe in a macro called BUILD_DESC
+ * * secondly, if this is an exported version of the code, GIT_ARCHIVE will
+ *   be defined (automatically using the export-subst git attribute), and
+ *   GIT_COMMIT will contain the commit id.
+ * * then, three options exist for determining CLIENT_BUILD:
+ *   * if BUILD_DESC is defined, use that literally (output of git-describe)
+ *   * if not, but GIT_COMMIT is defined, use v[maj].[min].[rev].[build]-g[commit]
+ *   * otherwise, use v[maj].[min].[rev].[build]-unk
+ * finally CLIENT_VERSION_SUFFIX is added
+ */
+
+//! First, include build.h if requested
 #ifdef HAVE_BUILD_INFO
 #include "build.h"
 #endif
 
-// git will put "#define GIT_ARCHIVE 1" on the next line inside archives. $Format:%n#define GIT_ARCHIVE 1$
+//! git will put "#define GIT_ARCHIVE 1" on the next line inside archives. $Format:%n#define GIT_ARCHIVE 1$
 #ifdef GIT_ARCHIVE
 #define GIT_COMMIT_ID "$Format:%h$"
 #define GIT_COMMIT_DATE "$Format:%cD$"
@@ -85,7 +91,9 @@ std::string FormatFullVersion()
     return CLIENT_BUILD;
 }
 
-// Format the subversion field according to BIP 14 spec (https://en.bitcoin.it/wiki/BIP_0014)
+/** 
+ * Format the subversion field according to BIP 14 spec (https://github.com/bitcoin/bips/blob/master/bip-0014.mediawiki) 
+ */
 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments)
 {
     std::ostringstream ss;

src/clientversion.h

@@ -1,5 +1,5 @@
 // Copyright (c) 2009-2014 The Bitcoin developers
-// Distributed under the MIT/X11 software license, see the accompanying
+// Distributed under the MIT software license, see the accompanying
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #ifndef CLIENTVERSION_H
@@ -8,38 +8,43 @@
 #if defined(HAVE_CONFIG_H)
 #include "config/bitcoin-config.h"
 #else
-//
-// client versioning and copyright year
-//
 
-// These need to be macros, as version.cpp's and bitcoin*-res.rc's voodoo requires it
+/**
+ * client versioning and copyright year
+ */
+
+//! These need to be macros, as clientversion.cpp's and bitcoin*-res.rc's voodoo requires it
 #define CLIENT_VERSION_MAJOR 0
 #define CLIENT_VERSION_MINOR 9
 #define CLIENT_VERSION_REVISION 99
 #define CLIENT_VERSION_BUILD 0
 
-// Set to true for release, false for prerelease or test build
+//! Set to true for release, false for prerelease or test build
 #define CLIENT_VERSION_IS_RELEASE false
 
-// Copyright year (2009-this)
-// Todo: update this when changing our copyright comments in the source
+/**
+ * Copyright year (2009-this)
+ * Todo: update this when changing our copyright comments in the source
+ */
 #define COPYRIGHT_YEAR 2014
 
 #endif //HAVE_CONFIG_H
 
-// Converts the parameter X to a string after macro replacement on X has been performed.
-// Don't merge these into one macro!
+/**
+ * Converts the parameter X to a string after macro replacement on X has been performed.
+ * Don't merge these into one macro!
+ */
 #define STRINGIZE(X) DO_STRINGIZE(X)
 #define DO_STRINGIZE(X) #X
 
-// Copyright string used in Windows .rc files
+//! Copyright string used in Windows .rc files
 #define COPYRIGHT_STR "2009-" STRINGIZE(COPYRIGHT_YEAR) " The Bitcoin Core Developers"
 
-/*
-  bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
-  WINDRES_PREPROC is defined to indicate that its pre-processor is running.
-  Anything other than a define should be guarded below.
-*/
+/**
+ * bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
+ * WINDRES_PREPROC is defined to indicate that its pre-processor is running.
+ * Anything other than a define should be guarded below.
+ */
 
 #if !defined(WINDRES_PREPROC)
 

src/version.h

@@ -1,37 +1,37 @@
-// Copyright (c) 2012 The Bitcoin developers
-// Distributed under the MIT/X11 software license, see the accompanying
+// Copyright (c) 2012-2014 The Bitcoin developers
+// Distributed under the MIT software license, see the accompanying
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #ifndef BITCOIN_VERSION_H
 #define BITCOIN_VERSION_H
 
-//
-// network protocol versioning
-//
+/**
+ * network protocol versioning
+ */
 
 static const int PROTOCOL_VERSION = 70002;
 
-// initial proto version, to be increased after version/verack negotiation
+//! initial proto version, to be increased after version/verack negotiation
 static const int INIT_PROTO_VERSION = 209;
 
-// In this version, 'getheaders' was introduced.
+//! In this version, 'getheaders' was introduced.
 static const int GETHEADERS_VERSION = 31800;
 
-// disconnect from peers older than this proto version
+//! disconnect from peers older than this proto version
 static const int MIN_PEER_PROTO_VERSION = GETHEADERS_VERSION;
 
-// nTime field added to CAddress, starting with this version;
-// if possible, avoid requesting addresses nodes older than this
+//! nTime field added to CAddress, starting with this version;
+//! if possible, avoid requesting addresses nodes older than this
 static const int CADDR_TIME_VERSION = 31402;
 
-// only request blocks from nodes outside this range of versions
+//! only request blocks from nodes outside this range of versions
 static const int NOBLKS_VERSION_START = 32000;
 static const int NOBLKS_VERSION_END = 32400;
 
-// BIP 0031, pong message, is enabled for all versions AFTER this one
+//! BIP 0031, pong message, is enabled for all versions AFTER this one
 static const int BIP0031_VERSION = 60000;
 
-// "mempool" command, enhanced "getdata" behavior starts with this version
+//! "mempool" command, enhanced "getdata" behavior starts with this version
 static const int MEMPOOL_GD_VERSION = 60002;
 
 #endif // BITCOIN_VERSION_H