First inclusion

[SVN r37593]

example/doc_entity.cpp

@@ -0,0 +1,59 @@
+/////////////////////////////////////////////////////////////////////////////
+//
+// (C) Copyright Ion Gaztañaga  2006-2007
+//
+// Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//          http://www.boost.org/LICENSE_1_0.txt)
+//
+// See http://www.boost.org/libs/intrusive for documentation.
+//
+/////////////////////////////////////////////////////////////////////////////
+//[doc_entity_code
+#include <boost/intrusive/list.hpp>
+
+//A class that can be inserted in an intrusive list
+class entity 
+   :  public boost::intrusive::list_base_hook<>
+{
+   public:
+   virtual ~entity();
+   //...
+};
+
+//"some_entity" derives from "entity"
+class some_entity  :  public entity
+{/**/};
+
+//Definition of the intrusive list
+typedef boost::intrusive::list< entity::value_traits<entity> > entity_list;
+
+//A global list
+entity_list list;
+
+//The destructor removes itself from the list
+entity::~entity()
+{  list.erase(entity_list::iterator_to(*this));  }
+
+//Function to insert a new "some_entity" in the list
+void insert_some_entity()
+{  list.push_back (*new some_entity(/*...*/));  } 
+
+//Function to clear an entity from the intrusive list
+void clear_list ()
+{
+   // entity's destructor removes itself from the list implicitly
+   while (!list.empty())
+      delete &list.front();   
+}
+
+int main()
+{
+   //Insert some new entities
+   insert_some_entity();
+   insert_some_entity();
+   //list's destructor will free objects
+   return 0;
+}
+
+//]