Changeset 539

Timestamp:

08/17/09 09:09:10 (15 years ago)

Author:

vbarta

Message:

improved formatting

Files:

• library/doc/local/memory_management.dox (modified) (7 diffs)

library/doc/local/memory_management.dox

@@ -1 +1 @@
 /*!
-\page Memory Management in BDM
+\page memory_management Memory Management in BDM
 
 C++ memory management is notoriously flexible, allowing a wide range
@@ -33 +33 @@
 library aims to provide the minimal exception safety (that is,
 throwing an exception doesn't crash and doesn't leak any resources)
-for all thrown exceptions \b except \b memory errors - when a program
+for all thrown exceptions \b except memory errors - when a program
 using BDM exhausts memory, it should be terminated as soon as possible
 (and in most cases it has probably already terminated by
 itself). Specific exceptions may provide stronger guarantees, as
-documented for specific cases. All exceptions thrown outside the
+documented for specific cases. All exceptions thrown out of the
 library are descendants of std::exception.
 
@@ -52 +52 @@
 std::tr1:shared_ptr (which is planned to replace bdm::shared_ptr once
 it becomes widely available). Note that objects allocated on the stack
-\b must not \b have their addresses passed to shared_ptr - that is a
+\b must \b not have their addresses passed to shared_ptr - that is a
 bug leading to intermittent runtime errors.
 
@@ -61 +61 @@
 
 \code
-// egamma_ptr is typedef for object_ptr<egamma>, whose default
-// constructor calls new egamma()
+/*
+ egamma_ptr is typedef for object_ptr<egamma>, whose default
+ constructor calls new egamma()
+*/
 egamma_ptr eG; 
 eG->set_parameters ( a, b );
@@ -69 +71 @@
 Coms ( 0 ) = eG; // object_ptr<T> is derived from shared_ptr<T>
 
-// The egamma instance doesn't leak: if the shared_ptr instance which
-// wraps it isn't assigned to anything else, the pointer is deleted by
-// the destructor of either object_ptr, or Array, whichever runs last.
+/*
+ The egamma instance doesn't leak: if the shared_ptr instance which
+ wraps it isn't assigned to anything else, the pointer is deleted by
+ the destructor of either object_ptr, or Array, whichever runs last.
+*/
 \endcode
 
@@ -86 +90 @@
 
 \code
-// the pointer must stay valid for the lifetime of the object
+/* the pointer must stay valid for the lifetime of the object */
 CurrentContext ( const char *name, int idx );
 \endcode
@@ -108 +112 @@
 
 \code
-//! Returns the stored pointer (which remains owned by this
-//! instance).
+/*
+ Returns the stored pointer (which remains owned by this
+ instance).
+*/
 T *get();
 \endcode