Tidy up List documentation

This commit is contained in:
Vinnie Falco
2013-06-30 09:41:01 -07:00
parent 4d7fe731d8
commit 02f137ace8

View File

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