ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tidy up List documentation

Browse Source
This commit is contained in:
Vinnie Falco
2013-06-30 09:41:01 -07:00
parent 4d7fe731d8
commit 02f137ace8
1 changed files with 222 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
Subtrees/beast/modules/beast_core/containers/beast_List.h
View File

@@ -17,14 +17,10 @@
*/ */
//============================================================================== //==============================================================================
#ifndef BEAST_LIST_BEASTHEADER #ifndef BEAST_LIST_H_INCLUDED
#define BEAST_LIST_BEASTHEADER #define BEAST_LIST_H_INCLUDED
struct ListDefaultTag; /** Intrusive Containers
/*============================================================================*/
/**
Intrusive Containers
# Introduction # Introduction
@@ -69,7 +65,7 @@ struct ListDefaultTag;
@code @code
class Object; // Forward declaration struct Object; // Forward declaration
List <Object> list; // Doubly-linked list of Object List <Object> list; // Doubly-linked list of Object
@@ -84,9 +80,8 @@ struct ListDefaultTag;
@code @code
class Object : public List <Object>::Node // Required for List struct Object : public List <Object>::Node // Required for List
{ {
public:
void performAction (); void performAction ();
}; };
@@ -98,12 +93,12 @@ struct ListDefaultTag;
@code @code
class Object; // Forward declaration struct Object; // Forward declaration
// Specify template parameters just once // Specify template parameters just once
typedef List <Object> ListType; typedef List <Object> ListType;
class Object : public ListType::Node struct Object : public ListType::Node
{ {
void performAction (); void performAction ();
}; };
@@ -195,7 +190,14 @@ struct ListDefaultTag;
@ingroup beast_core @ingroup beast_core
*/ */
/*============================================================================*/ //------------------------------------------------------------------------------
/** Default tag for List.
@ingroup beast_core intrusive
*/
struct ListDefaultTag;
/** /**
Intrusive doubly linked list. Intrusive doubly linked list.
@@ -207,7 +209,7 @@ struct ListDefaultTag;
struct Object : List <Object>::Node struct Object : List <Object>::Node
{ {
Object (int value) : m_value (value) explicit Object (int value) : m_value (value)
{ {
} }
@@ -786,11 +788,4 @@ private:
Node m_tail; Node m_tail;
}; };
/**
Default tag for List.
@ingroup beast_core intrusive
*/
struct ListDefaultTag { };
#endif #endif