Begin doxygen-compatible comments
[novacoin.git] / src / base58.h
index 71168cf..755e34c 100644 (file)
@@ -169,7 +169,7 @@ inline bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>
 
 
 
-// Base class for all base58-encoded data
+/** Base class for all base58-encoded data */
 class CBase58Data
 {
 protected:
@@ -252,11 +252,12 @@ public:
     bool operator> (const CBase58Data& b58) const { return CompareTo(b58) >  0; }
 };
 
-// base58-encoded bitcoin addresses
-// Public-key-hash-addresses have version 0 (or 192 testnet)
-// The data vector contains RIPEMD160(SHA256(pubkey)), where pubkey is the serialized public key
-// Script-hash-addresses have version 5 (or 196 testnet)
-// The data vector contains RIPEMD160(SHA256(cscript)), where cscript is the serialized redemption script
+/** base58-encoded bitcoin addresses.
+ * Public-key-hash-addresses have version 0 (or 111 testnet).
+ * The data vector contains RIPEMD160(SHA256(pubkey)), where pubkey is the serialized public key.
+ * Script-hash-addresses have version 5 (or 196 testnet).
+ * The data vector contains RIPEMD160(SHA256(cscript)), where cscript is the serialized redemption script.
+ */
 class CBitcoinAddress : public CBase58Data
 {
 public:
@@ -356,6 +357,7 @@ public:
     }
 };
 
+/** A base58-encoded secret key */
 class CBitcoinSecret : public CBase58Data
 {
 public: