Merge bitcoin#9544: [trivial] Add end of namespace comments. Improve consistency.

laanwj · laanwj · commit f3f1e2e7d380 · 2017-06-26T13:40:26.000+02:00
5a9b508 [trivial] Add end of namespace comments (practicalswift) Tree-SHA512: 92b0fcae4d1d3f4da9e97569ae84ef2d6e09625a5815cd0e5f0eb6dd2ecba9852fa85c184c5ae9de5117050330ce995e9867b451fa8cd5512169025990541a2b
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
@@ -68,7 +68,7 @@ public:
         return true;
     }
 }
-}
+} // namespace foo
 ```
 
 Doxygen comments
@@ -438,6 +438,21 @@ Source code organization
 
   - *Rationale*: Avoids symbol conflicts
 
+- Terminate namespaces with a comment (`// namespace mynamespace`). The comment
+  should be placed on the same line as the brace closing the namespace, e.g.
+
+```c++
+namespace mynamespace {
+    ...
+} // namespace mynamespace
+
+namespace {
+    ...
+} // namespace
+```
+
+  - *Rationale*: Avoids confusion about the namespace context
+
 GUI
 -----
 
diff --git a/src/base58.cpp b/src/base58.cpp
@@ -225,7 +225,7 @@ class CBitcoinAddressVisitor : public boost::static_visitor<bool>
     bool operator()(const CNoDestination& no) const { return false; }
 };
 
-} // anon namespace
+} // namespace
 
 bool CBitcoinAddress::Set(const CKeyID& id)
 {
diff --git a/src/bench/checkblock.cpp b/src/bench/checkblock.cpp
@@ -11,7 +11,7 @@
 
 namespace block_bench {
 #include "bench/data/block413567.raw.h"
-}
+} // namespace block_bench
 
 // These are the two major time-sinks which happen after we have fully received
 // a block off the wire, but before we can relay the block on to peers using
diff --git a/src/compat/glibc_sanity.cpp b/src/compat/glibc_sanity.cpp
@@ -56,7 +56,7 @@ bool sanity_test_fdelt()
 }
 #endif
 
-} // anon namespace
+} // namespace
 
 bool glibc_sanity_test()
 {
diff --git a/src/compat/glibcxx_sanity.cpp b/src/compat/glibcxx_sanity.cpp
@@ -38,7 +38,7 @@ bool sanity_test_list(unsigned int size)
     return true;
 }
 
-} // anon namespace
+} // namespace
 
 // trigger: string::at(x) on an empty string to trigger __throw_out_of_range_fmt.
 // test: force std::string to throw an out_of_range exception. Verify that
diff --git a/src/dbwrapper.cpp b/src/dbwrapper.cpp
@@ -209,4 +209,4 @@ const std::vector<unsigned char>& GetObfuscateKey(const CDBWrapper &w)
     return w.obfuscate_key;
 }
 
-};
+} // namespace dbwrapper_private
diff --git a/src/init.cpp b/src/init.cpp
@@ -822,7 +822,7 @@ int nUserMaxConnections;
 int nFD;
 ServiceFlags nLocalServices = NODE_NETWORK;
 
-}
+} // namespace
 
 [[noreturn]] static void new_handler_terminate()
 {
diff --git a/src/net_processing.cpp b/src/net_processing.cpp
@@ -120,7 +120,7 @@ namespace {
     MapRelay mapRelay;
     /** Expiration-time ordered list of (expire time, relay map entry) pairs, protected by cs_main). */
     std::deque<std::pair<int64_t, MapRelay::iterator>> vRelayExpiration;
-} // anon namespace
+} // namespace
 
 //////////////////////////////////////////////////////////////////////////////
 //
@@ -559,7 +559,7 @@ void FindNextBlocksToDownload(NodeId nodeid, unsigned int count, std::vector<con
     }
 }
 
-} // anon namespace
+} // namespace
 
 bool GetNodeStateStats(NodeId nodeid, CNodeStateStats &stats) {
     LOCK(cs_main);
diff --git a/src/protocol.cpp b/src/protocol.cpp
@@ -39,7 +39,7 @@ const char *SENDCMPCT="sendcmpct";
 const char *CMPCTBLOCK="cmpctblock";
 const char *GETBLOCKTXN="getblocktxn";
 const char *BLOCKTXN="blocktxn";
-};
+} // namespace NetMsgType
 
 /** All known message types. Keep this in the same order as the list of
  * messages above and in protocol.h.
diff --git a/src/pubkey.cpp b/src/pubkey.cpp
@@ -11,7 +11,7 @@ namespace
 {
 /* Global secp256k1_context object used for verification. */
 secp256k1_context* secp256k1_context_verify = NULL;
-}
+} // namespace
 
 /** This function is taken from the libsecp256k1 distribution and implements
  *  DER parsing for ECDSA signatures, while supporting an arbitrary subset of
diff --git a/src/script/bitcoinconsensus.cpp b/src/script/bitcoinconsensus.cpp
@@ -68,7 +68,7 @@ struct ECCryptoClosure
 };
 
 ECCryptoClosure instance_of_eccryptoclosure;
-}
+} // namespace
 
 /** Check that all specified flags are part of the libconsensus interface. */
 static bool verify_flags(unsigned int flags)
diff --git a/src/script/interpreter.cpp b/src/script/interpreter.cpp
@@ -31,7 +31,7 @@ inline bool set_error(ScriptError* ret, const ScriptError serror)
     return false;
 }
 
-} // anon namespace
+} // namespace
 
 bool CastToBool(const valtype& vch)
 {
@@ -1164,7 +1164,7 @@ uint256 GetOutputsHash(const CTransaction& txTo) {
     return ss.GetHash();
 }
 
-} // anon namespace
+} // namespace
 
 PrecomputedTransactionData::PrecomputedTransactionData(const CTransaction& txTo)
 {
diff --git a/src/script/sigcache.cpp b/src/script/sigcache.cpp
@@ -66,7 +66,7 @@ class CSignatureCache
  * signatureCache could be made local to VerifySignature.
 */
 static CSignatureCache signatureCache;
-}
+} // namespace
 
 // To be called once in AppInitMain/BasicTestingSetup to initialize the
 // signatureCache.
diff --git a/src/script/sign.cpp b/src/script/sign.cpp
@@ -399,7 +399,7 @@ class DummySignatureChecker : public BaseSignatureChecker
     }
 };
 const DummySignatureChecker dummyChecker;
-}
+} // namespace
 
 const BaseSignatureChecker& DummySignatureCreator::Checker() const
 {
diff --git a/src/script/standard.cpp b/src/script/standard.cpp
@@ -273,7 +273,7 @@ class CScriptVisitor : public boost::static_visitor<bool>
         return true;
     }
 };
-}
+} // namespace
 
 CScript GetScriptForDestination(const CTxDestination& dest)
 {
diff --git a/src/test/coins_tests.cpp b/src/test/coins_tests.cpp
@@ -99,7 +99,7 @@ class CCoinsViewCacheTest : public CCoinsViewCache
     size_t& usage() { return cachedCoinsUsage; }
 };
 
-}
+} // namespace
 
 BOOST_FIXTURE_TEST_SUITE(coins_tests, BasicTestingSetup)
 
diff --git a/src/test/script_tests.cpp b/src/test/script_tests.cpp
@@ -468,7 +468,7 @@ std::string JSONPrettyPrint(const UniValue& univalue)
     }
     return ret;
 }
-}
+} // namespace
 
 BOOST_AUTO_TEST_CASE(script_build)
 {
diff --git a/src/txmempool.cpp b/src/txmempool.cpp
@@ -769,7 +769,7 @@ class DepthAndScoreComparator
         return counta < countb;
     }
 };
-}
+} // namespace
 
 std::vector<CTxMemPool::indexed_transaction_set::const_iterator> CTxMemPool::GetSortedDepthAndScore() const
 {
diff --git a/src/validation.cpp b/src/validation.cpp
@@ -1297,7 +1297,7 @@ bool AbortNode(CValidationState& state, const std::string& strMessage, const std
     return state.Error(strMessage);
 }
 
-} // anon namespace
+} // namespace
 
 enum DisconnectResult
 {
diff --git a/src/versionbits.cpp b/src/versionbits.cpp
@@ -189,7 +189,7 @@ class VersionBitsConditionChecker : public AbstractThresholdConditionChecker {
     uint32_t Mask(const Consensus::Params& params) const { return ((uint32_t)1) << params.vDeployments[id].bit; }
 };
 
-}
+} // namespace
 
 ThresholdState VersionBitsState(const CBlockIndex* pindexPrev, const Consensus::Params& params, Consensus::DeploymentPos pos, VersionBitsCache& cache)
 {

Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,7 @@ class CBitcoinAddressVisitor : public boost::static_visitor<bool>`
`225`	`225`	`bool operator()(const CNoDestination& no) const { return false; }`
`226`	`226`	`};`
`227`	`227`
`228`		`-} // anon namespace`
	`228`	`+} // namespace`
`229`	`229`
`230`	`230`	`bool CBitcoinAddress::Set(const CKeyID& id)`
`231`	`231`	`{`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ bool sanity_test_fdelt()`
`56`	`56`	`}`
`57`	`57`	`#endif`
`58`	`58`
`59`		`-} // anon namespace`
	`59`	`+} // namespace`
`60`	`60`
`61`	`61`	`bool glibc_sanity_test()`
`62`	`62`	`{`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ bool sanity_test_list(unsigned int size)`
`38`	`38`	`return true;`
`39`	`39`	`}`
`40`	`40`
`41`		`-} // anon namespace`
	`41`	`+} // namespace`
`42`	`42`
`43`	`43`	`// trigger: string::at(x) on an empty string to trigger __throw_out_of_range_fmt.`
`44`	`44`	`// test: force std::string to throw an out_of_range exception. Verify that`
Original file line number	Diff line number	Diff line change
`@@ -209,4 +209,4 @@ const std::vector<unsigned char>& GetObfuscateKey(const CDBWrapper &w)`
`209`	`209`	`return w.obfuscate_key;`
`210`	`210`	`}`
`211`	`211`
`212`		`-};`
	`212`	`+} // namespace dbwrapper_private`
Original file line number	Diff line number	Diff line change
`@@ -822,7 +822,7 @@ int nUserMaxConnections;`
`822`	`822`	`int nFD;`
`823`	`823`	`ServiceFlags nLocalServices = NODE_NETWORK;`
`824`	`824`
`825`		`-}`
	`825`	`+} // namespace`
`826`	`826`
`827`	`827`	`[[noreturn]] static void new_handler_terminate()`
`828`	`828`	`{`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ namespace {`
`120`	`120`	`MapRelay mapRelay;`
`121`	`121`	`/** Expiration-time ordered list of (expire time, relay map entry) pairs, protected by cs_main). */`
`122`	`122`	`std::deque<std::pair<int64_t, MapRelay::iterator>> vRelayExpiration;`
`123`		`-} // anon namespace`
	`123`	`+} // namespace`
`124`	`124`
`125`	`125`	`//////////////////////////////////////////////////////////////////////////////`
`126`	`126`	`//`
`@@ -559,7 +559,7 @@ void FindNextBlocksToDownload(NodeId nodeid, unsigned int count, std::vector<con`
`559`	`559`	`}`
`560`	`560`	`}`
`561`	`561`
`562`		`-} // anon namespace`
	`562`	`+} // namespace`
`563`	`563`
`564`	`564`	`bool GetNodeStateStats(NodeId nodeid, CNodeStateStats &stats) {`
`565`	`565`	`LOCK(cs_main);`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ namespace`
`11`	`11`	`{`
`12`	`12`	`/* Global secp256k1_context object used for verification. */`
`13`	`13`	`secp256k1_context* secp256k1_context_verify = NULL;`
`14`		`-}`
	`14`	`+} // namespace`
`15`	`15`
`16`	`16`	`/** This function is taken from the libsecp256k1 distribution and implements`
`17`	`17`	`* DER parsing for ECDSA signatures, while supporting an arbitrary subset of`