ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-04-29 15:37:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reformat annotations in preparation for automated extraction

Browse Source
This commit is contained in:
Vinnie Falco
2013-06-07 14:46:09 -07:00
parent 6d8ee90a8d
commit a6fdabc68a
89 changed files with 192 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/ripple_data/crypto/ripple_Base58.h
View File

@@ -36,7 +36,7 @@
class Base58
{
public:
// VFALCO: TODO, clean up this poor API
// VFALCO TODO clean up this poor API
static char const* getCurrentAlphabet ();
static void setCurrentAlphabet (char const* alphabet);

6
modules/ripple_data/crypto/ripple_CBigNum.h
View File

@@ -51,7 +51,7 @@ public:
//------------------------------------------------------------------------------
// VFALCO: TODO figure out a way to remove the dependency on openssl in the
// VFALCO TODO figure out a way to remove the dependency on openssl in the
// header. Maybe rewrite this to use cryptopp.
class CBigNum : public BIGNUM
@@ -130,7 +130,7 @@ bool operator>(const CBigNum& a, const CBigNum& b);
//------------------------------------------------------------------------------
// VFALCO: NOTE, this seems as good a place as any for this.
// VFALCO NOTE this seems as good a place as any for this.
// Here's the old implementation using macros, in case something broke
//#if (ULONG_MAX > UINT_MAX)
@@ -140,7 +140,7 @@ bool operator>(const CBigNum& a, const CBigNum& b);
//#define BN_div_word64(bn, word) BN_div_word(bn, word)
//#endif
// VFALCO: I believe only STAmount uses these
// VFALCO I believe only STAmount uses these
extern int BN_add_word64 (BIGNUM *a, uint64 w);
extern int BN_sub_word64 (BIGNUM *a, uint64 w);
extern int BN_mul_word64 (BIGNUM *a, uint64 w);

2
modules/ripple_data/crypto/ripple_CKey.cpp
View File

@@ -4,4 +4,4 @@
// file license.txt or http://www.opensource.org/licenses/mit-license.php.
// VFALCO: TODO, move inlined stuff from CKey into here
// VFALCO TODO move inlined stuff from CKey into here

2
modules/ripple_data/crypto/ripple_CKey.h
View File

@@ -32,7 +32,7 @@
// see www.keylength.com
// script supports up to 75 for single byte push
// VFALCO: NOTE, this is unused
// VFALCO NOTE this is unused
/*
int static inline EC_KEY_regenerate_key(EC_KEY *eckey, BIGNUM *priv_key)
{

2
modules/ripple_data/crypto/ripple_RFC1751.cpp
View File

@@ -2,7 +2,7 @@
// RFC 1751 code converted to C++/Boost.
//
// VFALCO: TODO, move these
// VFALCO TODO move these
#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/trim.hpp>
#include <boost/algorithm/string/predicate.hpp>

6
modules/ripple_data/protocol/ripple_FieldNames.h
View File

@@ -1,7 +1,7 @@
#ifndef RIPPLE_FIELDNAMES_H
#define RIPPLE_FIELDNAMES_H
// VFALCO: TODO, lose the macro.
// VFALCO TODO lose the macro.
#define FIELD_CODE(type, index) ((static_cast<int>(type) << 16) | index)
enum SerializedTypeID
@@ -23,7 +23,7 @@ enum SerializedTypeID
STI_VALIDATION = 10003,
};
// VFALCO: TODO, rename this to NamedField
// VFALCO TODO rename this to NamedField
class SField
{
public:
@@ -104,7 +104,7 @@ public:
static int compare(SField::ref f1, SField::ref f2);
// VFALCO: TODO, make these private
// VFALCO TODO make these private
protected:
static std::map<int, ptr> codeToField;
static boost::mutex mapMutex;

2
modules/ripple_data/protocol/ripple_LedgerFormat.cpp
View File

@@ -3,7 +3,7 @@ std::map <int, LedgerEntryFormat*> LedgerEntryFormat::byType;
std::map <std::string, LedgerEntryFormat*> LedgerEntryFormat::byName;
// VFALCO: TODO, surely we can think of a better way than macros?
// VFALCO TODO surely we can think of a better way than macros?
#define LEF_BASE \
<< SOElement(sfLedgerIndex, SOE_OPTIONAL) \

2
modules/ripple_data/protocol/ripple_PackedMessage.h
View File

@@ -25,7 +25,7 @@ public:
/** Retrieve the packed message data.
*/
// VFALCO: TODO, shouldn't this be const?
// VFALCO TODO shouldn't this be const?
std::vector <uint8_t>& getBuffer()
{
return mBuffer;

2
modules/ripple_data/protocol/ripple_RippleAddress.cpp
View File

@@ -1,6 +1,6 @@
// VFALCO: TODO, remove this when it's safe to do so.
// VFALCO TODO remove this when it's safe to do so.
#ifdef __APPLICATION__
#error Including Application.h is disallowed!
#endif

4
modules/ripple_data/protocol/ripple_RippleSystem.h
View File

@@ -3,7 +3,7 @@
/** Protocol specific constant globals.
*/
// VFALCO: NOTE, use these from now on instead of the macros!!
// VFALCO NOTE use these from now on instead of the macros!!
class RippleSystem
{
public:
@@ -28,7 +28,7 @@ public:
}
};
// VFALCO: TODO, I would love to replace these macros with the language
// VFALCO TODO I would love to replace these macros with the language
// constructs above. The problem is the way they are used at
// the point of call, i.e. "User-agent:" SYSTEM_NAME
// It will be necessary to rewrite some of them to use string streams.

2
modules/ripple_data/protocol/ripple_SerializedObject.h
View File

@@ -186,7 +186,7 @@ public:
const vector& getValue() const { return value; }
vector& getValue() { return value; }
// VFALCO: NOTE as long as we're married to boost why not use boost::iterator_facade?
// VFALCO NOTE as long as we're married to boost why not use boost::iterator_facade?
//
// vector-like functions
void push_back(const STObject& object) { value.push_back(object.oClone().release()); }

2
modules/ripple_data/protocol/ripple_SerializedObjectTemplate.h
View File

@@ -5,7 +5,7 @@
/** Flags for elements in a SerializedObjectTemplate.
*/
// VFALCO: NOTE, these don't look like bit-flags...
// VFALCO NOTE these don't look like bit-flags...
enum SOE_Flags
{
SOE_INVALID = -1,

12
modules/ripple_data/protocol/ripple_SerializedTypes.h
View File

@@ -1,7 +1,7 @@
#ifndef RIPPLE_SERIALIZEDTYPES_H
#define RIPPLE_SERIALIZEDTYPES_H
// VFALCO: TODO, fix this restriction on copy assignment.
// VFALCO TODO fix this restriction on copy assignment.
//
// CAUTION: Do not create a vector (or similar container) of any object derived from
// SerializedType. Use Boost ptr_* containers. The copy assignment operator of
@@ -25,12 +25,12 @@ enum PathFlags
PF_ISSUE = 0x80,
};
// VFALCO: TODO, make these non static or otherwise clean constants.
// VFALCO TODO make these non static or otherwise clean constants.
static const uint160 u160_zero(0), u160_one(1);
static inline const uint160& get_u160_zero() { return u160_zero; }
static inline const uint160& get_u160_one() { return u160_one; }
// VFALCO: TODO, replace these with language constructs, gah!
// VFALCO TODO replace these with language constructs, gah!
#define CURRENCY_XRP get_u160_zero()
#define CURRENCY_ONE get_u160_one() // Used as a place holder.
#define CURRENCY_BAD uint160(0x5852500000000000) // Do not allow XRP as an IOU currency.
@@ -79,7 +79,7 @@ public:
virtual bool isDefault() const { return true; }
protected:
// VFALCO: TODO, make accessors for this
// VFALCO TODO make accessors for this
SField::ptr fName;
private:
@@ -476,7 +476,7 @@ private:
}
};
// VFALCO: TODO Make static member accessors for these in STAmount
// VFALCO TODO Make static member accessors for these in STAmount
extern const STAmount saZero;
extern const STAmount saOne;
@@ -631,7 +631,7 @@ private:
class STPathElement
{
private:
// VFALCO: Remove these friend declarations
// VFALCO Remove these friend declarations
friend class STPathSet;
friend class STPath;
friend class Pathfinder;

10
modules/ripple_data/protocol/ripple_TER.h
View File

@@ -1,11 +1,11 @@
#ifndef RIPPLE_TER_H
#define RIPPLE_TER_H
// VFALCO: TODO do not use auto-incrementing. Explicitly assign each
// VFALCO TODO do not use auto-incrementing. Explicitly assign each
// constant so there is no possibility of someone coming in
// and screwing it up.
//
// VFALCO: TODO, consider renaming TER to TxErr or TxResult for clarity.
// VFALCO TODO consider renaming TER to TxErr or TxResult for clarity.
//
enum TER // aka TransactionEngineResult
{
@@ -17,7 +17,7 @@ enum TER // aka TransactionEngineResult
// - Not forwarded
// - No fee check
telLOCAL_ERROR = -399,
telBAD_DOMAIN, // VFALCO: TODO, should read "telBAD_DOMAIN = -398," etc...
telBAD_DOMAIN, // VFALCO TODO should read "telBAD_DOMAIN = -398," etc...
telBAD_PATH_COUNT,
telBAD_PUBLIC_KEY,
telFAILED_PROCESSING,
@@ -143,7 +143,7 @@ enum TER // aka TransactionEngineResult
tecUNFUNDED = 129, // Deprecated, old ambiguous unfunded.
};
// VFALCO: TODO, change these to normal functions.
// VFALCO TODO change these to normal functions.
#define isTelLocal(x) ((x) >= telLOCAL_ERROR && (x) < temMALFORMED)
#define isTemMalformed(x) ((x) >= temMALFORMED && (x) < tefFAILURE)
#define isTefFailure(x) ((x) >= tefFAILURE && (x) < terRETRY)
@@ -151,7 +151,7 @@ enum TER // aka TransactionEngineResult
#define isTesSuccess(x) ((x) == tesSUCCESS)
#define isTecClaim(x) ((x) >= tecCLAIM)
// VFALCO: TODO, group these into a shell class along with the defines above.
// VFALCO TODO group these into a shell class along with the defines above.
extern bool transResultInfo (TER terCode, std::string& strToken, std::string& strHuman);
extern std::string transToken (TER terCode);
extern std::string transHuman (TER terCode);

2
modules/ripple_data/protocol/ripple_TransactionFormat.cpp
View File

@@ -3,7 +3,7 @@ std::map<int, TransactionFormat*> TransactionFormat::byType;
std::map<std::string, TransactionFormat*> TransactionFormat::byName;
// VFALCO: TODO, surely we can think of a better way than to use macros??
// VFALCO TODO surely we can think of a better way than to use macros??
#define TF_BASE \
<< SOElement(sfTransactionType, SOE_REQUIRED) \
<< SOElement(sfFlags, SOE_OPTIONAL) \

6
modules/ripple_data/ripple_data.cpp
View File

@@ -51,7 +51,7 @@
#include <openssl/rand.h>
#include <openssl/err.h>
// VFALCO: TODO, fix these warnings!
// VFALCO TODO fix these warnings!
#ifdef _MSC_VER
//#pragma warning (push) // Causes spurious C4503 "decorated name exceeds maximum length"
#pragma warning (disable: 4018) // signed/unsigned mismatch
@@ -65,7 +65,7 @@
#endif
#include "crypto/ripple_Base58.h" // for RippleAddress
#include "crypto/ripple_CKey.h" // needs RippleAddress VFALCO: TODO, remove this dependency cycle
#include "crypto/ripple_CKey.h" // needs RippleAddress VFALCO TODO remove this dependency cycle
#include "crypto/ripple_RFC1751.h"
#include "crypto/ripple_CBigNum.cpp"
@@ -95,7 +95,7 @@ static const uint64 tenTo17m1 = tenTo17 - 1;
#include "protocol/ripple_STAmount.cpp"
#include "protocol/ripple_STAmountRound.cpp"
// VFALCO: TODO Fix this for SConstruct
// VFALCO TODO Fix this for SConstruct
#ifdef _MSC_VER
#include "ripple.pb.cc" // BROKEN because of SConstruct
#endif

8
modules/ripple_data/ripple_data.h
View File

@@ -45,7 +45,7 @@
#include <boost/enable_shared_from_this.hpp>
#include <boost/functional/hash.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/ptr_container/ptr_vector.hpp> // VFALCO: NOTE, this looks like junk
#include <boost/ptr_container/ptr_vector.hpp> // VFALCO NOTE this looks like junk
#include <openssl/bn.h>
#include <openssl/ec.h>
@@ -54,15 +54,15 @@
//------------------------------------------------------------------------------
// VFALCO: TODO, try to reduce these dependencies
// VFALCO TODO try to reduce these dependencies
#include "../ripple_basics/ripple_basics.h"
// VFALCO: TODO, figure out a good place for this file, perhaps give it some
// VFALCO TODO figure out a good place for this file, perhaps give it some
// additional hierarchy via directories.
#include "ripple.pb.h"
#include "crypto/ripple_CBigNum.h"
#include "crypto/ripple_Base58.h" // VFALCO: TODO, Can be moved to .cpp if we clean up setAlphabet stuff
#include "crypto/ripple_Base58.h" // VFALCO TODO Can be moved to .cpp if we clean up setAlphabet stuff
#include "crypto/ripple_Base58Data.h"
#include "protocol/ripple_FieldNames.h"