ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +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

6
modules/ripple_basics/containers/ripple_RangeSet.h
View File

@@ -68,9 +68,9 @@ namespace boost
};
}
// VFALCO: Maybe not the best place for this but it sort of makes sense here
// VFALCO Maybe not the best place for this but it sort of makes sense here
// VFALCO: NOTE, these three are unused.
// VFALCO NOTE these three are unused.
/*
template<typename T> T range_check(const T& value, const T& minimum, const T& maximum)
{
@@ -94,7 +94,7 @@ template<typename T> T range_check_max(const T& value, const T& maximum)
}
*/
// VFALCO: TODO, these parameters should not be const references.
// VFALCO TODO these parameters should not be const references.
template<typename T, typename U> T range_check_cast(const U& value, const T& minimum, const T& maximum)
{
if ((value < minimum) || (value > maximum))

4
modules/ripple_basics/ripple_basics.cpp
View File

@@ -42,7 +42,7 @@
#include <boost/asio.hpp> // for stupid parseIpPort
#include <boost/regex.hpp>
// VFALCO: TODO, Replace OpenSSL randomness with a dependency-free implementation
// VFALCO TODO Replace OpenSSL randomness with a dependency-free implementation
// Perhaps Schneier's Fortuna or a variant. Abstract the collection of
// entropy and provide OS-specific implementation. We can re-use the
// BearShare source code for this.
@@ -56,7 +56,7 @@
// 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

4
modules/ripple_basics/ripple_basics.h
View File

@@ -62,7 +62,7 @@ namespace boost {
}
}
*/
#include <boost/filesystem.hpp> // VFALCO: TODO, try to eliminate thie dependency
#include <boost/filesystem.hpp> // VFALCO TODO try to eliminate thie dependency
@@ -117,7 +117,7 @@ namespace boost {
#include <boost/bind.hpp>
#include <boost/function.hpp>
// VFALCO: TODO, remove this dependency!!!
// VFALCO TODO remove this dependency!!!
#include <openssl/dh.h> // for DiffieHellmanUtil
#include <openssl/ripemd.h> // For HashUtilities
#include <openssl/sha.h> // For HashUtilities

4
modules/ripple_basics/types/ripple_HashMaps.h
View File

@@ -11,7 +11,7 @@
done by seeding the hashing function with a random number generated
at program startup.
*/
// VFALCO: TODO derive from Uncopyable
// VFALCO TODO derive from Uncopyable
class HashMaps // : beast::Uncopayble
{
public:
@@ -88,7 +88,7 @@ private:
public:
NonceHolder ()
{
// VFALCO: NOTE, this can be dangerous if T is an object type
// VFALCO NOTE this can be dangerous if T is an object type
RandomNumbers::getInstance ().fill (&m_nonce);
}

2
modules/ripple_basics/utility/ripple_ByteOrder.h
View File

@@ -5,7 +5,7 @@
// Reference: http://www.mail-archive.com/licq-commits@googlegroups.com/msg02334.html
// VFALCO: TODO, use VFLIB_* platform macros instead of hard-coded compiler specific ones
// VFALCO TODO use VFLIB_* platform macros instead of hard-coded compiler specific ones
#ifdef WIN32
extern uint64_t htobe64(uint64_t value);
extern uint64_t be64toh(uint64_t value);

4
modules/ripple_basics/utility/ripple_HashUtilities.h
View File

@@ -1,9 +1,9 @@
#ifndef RIPPLE_HASHUTILITIES_H
#define RIPPLE_HASHUTILITIES_H
// VFALCO: NOTE, these came from BitcoinUtil.h
// VFALCO NOTE these came from BitcoinUtil.h
// VFALCO: TODO, Rewrite the callers so we don't need templates,
// VFALCO TODO Rewrite the callers so we don't need templates,
// then define these in a .cpp so they are no longer inline.
//
template<typename T1>

8
modules/ripple_basics/utility/ripple_InstanceCounter.h
View File

@@ -1,11 +1,11 @@
#ifndef RIPPLE_INSTANCECOUNTER_H
#define RIPPLE_INSTANCECOUNTER_H
// VFALCO: TODO Clean up this junk, remove the macros, replace
// VFALCO TODO Clean up this junk, remove the macros, replace
// with a robust leak checker when we have atomics.
//
// VFALCO: TODO, swap these. Declaration means header, definition means .cpp!!!
// VFALCO TODO swap these. Declaration means header, definition means .cpp!!!
#define DEFINE_INSTANCE(x) \
extern InstanceType IT_##x; \
class Instance_##x : private Instance \
@@ -23,7 +23,7 @@
#define IS_INSTANCE(x) Instance_##x
// VFALCO: NOTE, that this is just a glorified leak checker with an awkward API
// VFALCO NOTE that this is just a glorified leak checker with an awkward API
class InstanceType
{
protected:
@@ -65,7 +65,7 @@ public:
{
if (sMultiThreaded)
{
// VFALCO: NOTE, Junk that will go away with atomics
// VFALCO NOTE Junk that will go away with atomics
mLock.lock();
++mInstances;
mLock.unlock();

4
modules/ripple_basics/utility/ripple_IntegerTypes.h
View File

@@ -1,7 +1,7 @@
#ifndef INTEGERTYPES_H
#define INTEGERTYPES_H
// VFALCO: TODO, determine if Borland C is supported
// VFALCO TODO determine if Borland C is supported
#if defined (_MSC_VER) /*|| defined(__BORLANDC__)*/
typedef __int64 int64;
typedef unsigned __int64 uint64;
@@ -18,7 +18,7 @@ typedef int int32;
#endif
// VFALCO: TODO, make sure minimum VS version is 9, 10, or 11
// VFALCO TODO make sure minimum VS version is 9, 10, or 11
// If commenting this out creates a problem, contact me!
/*
#if defined(_MSC_VER) && _MSC_VER < 1300

2
modules/ripple_basics/utility/ripple_Log.cpp
View File

@@ -37,7 +37,7 @@ std::vector< std::pair<std::string, std::string> > LogPartition::getSeverities()
//------------------------------------------------------------------------------
// VFALCO: TODO, remove original code once we know the replacement is correct.
// VFALCO TODO remove original code once we know the replacement is correct.
// Original code
/*
std::string ls = oss.str();

6
modules/ripple_basics/utility/ripple_Log.h
View File

@@ -14,7 +14,7 @@ enum LogSeverity
//------------------------------------------------------------------------------
// VFALCO: TODO, make this a nested class in Log
// VFALCO TODO make this a nested class in Log
class LogPartition
{
protected:
@@ -100,11 +100,11 @@ public:
static std::string rotateLog ();
private:
// VFALCO: TODO, derive from beast::Uncopyable
// VFALCO TODO derive from beast::Uncopyable
Log (const Log&); // no implementation
Log& operator= (const Log&); // no implementation
// VFALCO: TODO, looks like there are really TWO classes in here.
// VFALCO TODO looks like there are really TWO classes in here.
// One is a stream target for '<<' operator and the other
// is a singleton. Split the singleton out to a new class.
//

6
modules/ripple_basics/utility/ripple_PlatformMacros.h
View File

@@ -19,11 +19,11 @@
#ifndef RIPPLE_PLATFORMMACROS_H
#define RIPPLE_PLATFORMMACROS_H
// VFALCO: TODO Clean this up
// VFALCO TODO Clean this up
#if (!defined(FORCE_NO_C11X) && (__cplusplus > 201100L)) || defined(FORCE_C11X)
// VFALCO: TODO, replace BIND_TYPE with a namespace lift
// VFALCO TODO replace BIND_TYPE with a namespace lift
#define C11X
#include <functional>
@@ -49,7 +49,7 @@
#endif
// VFALCO: TODO, Clean this junk up
// VFALCO TODO Clean this junk up
#define nothing() do {} while (0)
#define fallthru() do {} while (0)
#define NUMBER(x) (sizeof(x)/sizeof((x)[0]))

10
modules/ripple_basics/utility/ripple_RandomNumbers.cpp
View File

@@ -39,11 +39,11 @@ bool RandomNumbers::initialize ()
void RandomNumbers::fillBytes (void* destinationBuffer, int numberOfBytes)
{
// VFALCO: NOTE this assert is here to remind us that the code is not yet
// VFALCO NOTE this assert is here to remind us that the code is not yet
// thread safe.
assert (m_initialized);
// VFALCO: NOTE When a spinlock is available in beast, use it here.
// VFALCO NOTE When a spinlock is available in beast, use it here.
if (! m_initialized)
{
if (! initialize ())
@@ -75,7 +75,7 @@ RandomNumbers& RandomNumbers::getInstance ()
//------------------------------------------------------------------------------
// VFALCO: TODO replace WIN32 macro
// VFALCO TODO replace WIN32 macro
#ifdef WIN32
@@ -160,7 +160,7 @@ bool RandomNumbers::platformAddEntropy ()
void RandomNumbers::platformAddPerformanceMonitorEntropy ()
{
// VFALCO: This is how we simulate local functions
// VFALCO This is how we simulate local functions
struct
{
int64 operator() () const
@@ -175,7 +175,7 @@ void RandomNumbers::platformAddPerformanceMonitorEntropy ()
{
struct
{
// VFALCO: TODO, clean this up
// VFALCO TODO clean this up
int64 operator() () const
{
int64 nCounter = 0;

4
modules/ripple_basics/utility/ripple_ScopedLock.h
View File

@@ -6,7 +6,7 @@ typedef boost::recursive_mutex::scoped_lock ScopedLock;
// A lock holder that can be returned and copied by value
// When the last reference goes away, the lock is released
// VFALCO: TODO, replace these with a more generic template, and not use boost
// VFALCO TODO replace these with a more generic template, and not use boost
//
class SharedScopedLock
{
@@ -30,7 +30,7 @@ protected:
boost::recursive_mutex& mMutex;
public:
// VFALCO: TODO, get rid of this unlock parameter to restore sanity
// VFALCO TODO get rid of this unlock parameter to restore sanity
ScopedUnlock(boost::recursive_mutex& mutex, bool unlock = true) : mUnlocked(unlock), mMutex(mutex)
{
if (unlock)

2
modules/ripple_basics/utility/ripple_Sustain.h
View File

@@ -19,7 +19,7 @@
#ifndef RIPPLE_SUSTAIN_H
#define RIPPLE_SUSTAIN_H
// VFALCO: TODO, figure out what the heck this is??
// VFALCO TODO figure out what the heck this is??
extern bool HaveSustain();
extern std::string StopSustain();
extern std::string DoSustain();

2
modules/ripple_basics/utility/ripple_ThreadName.cpp
View File

@@ -16,7 +16,7 @@
*/
//==============================================================================
// VFALCO: TODO, use VFLIB_MSVC macro instead
// VFALCO TODO use VFLIB_MSVC macro instead
#if _MSC_VER
void setCallingThreadName (char const* threadName)

2
modules/ripple_basics/utility/ripple_UptimeTimer.cpp
View File

@@ -38,7 +38,7 @@ int UptimeTimer::getElapsedSeconds () const
}
else
{
// VFALCO: TODO, use time_t instead of int return
// VFALCO TODO use time_t instead of int return
result = static_cast <int> (::time (0) - m_startTime);
}

4
modules/ripple_basics/utility/ripple_UptimeTimer.h
View File

@@ -24,7 +24,7 @@
The timer can be switched to a manual system of updating, to reduce
system calls. (?)
*/
// VFALCO: TODO, determine if the non-manual timing is actually needed
// VFALCO TODO determine if the non-manual timing is actually needed
class UptimeTimer
{
private:
@@ -42,7 +42,7 @@ public:
static UptimeTimer& getInstance ();
private:
// VFALCO: DEPRECATED, Use a memory barrier instead of forcing a cache line
// VFALCO DEPRECATED, Use a memory barrier instead of forcing a cache line
int m_pad1; // make sure m_elapsedTime fits in its own cache line
int volatile m_elapsedTime;
int m_pad2;