Changeset 344 for trunk/archive/pslib/include/psMemory.h

Timestamp:

Mar 31, 2004, 5:01:04 PM (22 years ago)

Author:

Paul Price

Message:

Standardised on /< as Doxygen comment for variable.

File:

• trunk/archive/pslib/include/psMemory.h (modified) (3 diffs)

trunk/archive/pslib/include/psMemory.h

@@ -16 +16 @@
  */
 typedef struct {
-    const void *magic0;                 //!< initialised to p_psMEMMAGIC
-    const unsigned long id;             //!< a unique ID for this allocation
-    const char *file;                   //!< set from __FILE__ in e.g. p_psAlloc
-    const int lineno;                   //!< set from __LINE__ in e.g. p_psAlloc
-    int refCounter;                     //!< how many times pointer is referenced
-    const void *magic;                  //!< initialised to p_psMEMMAGIC
+    const void *magic0;                 ///< initialised to p_psMEMMAGIC
+    const unsigned long id;             ///< a unique ID for this allocation
+    const char *file;                   ///< set from __FILE__ in e.g. p_psAlloc
+    const int lineno;                   ///< set from __LINE__ in e.g. p_psAlloc
+    int refCounter;                     ///< how many times pointer is referenced
+    const void *magic;                  ///< initialised to p_psMEMMAGIC
 } psMemBlock;
 
@@ -39 +39 @@
 
 /// Memory allocation. Underlying private function called by macro psAlloc. 
-void *p_psAlloc(size_t size,            //!< Size required
-                const char *file,       //!< File of call
-                int lineno              //!< Line number of call
+void *p_psAlloc(size_t size,            ///< Size required
+                const char *file,       ///< File of call
+                int lineno              ///< Line number of call
                 );
 
 /// Memory re-allocation.  Underlying private function called by macro psRealloc. 
-void *p_psRealloc(void *ptr,            //!< Pointer to re-allocate
-                  size_t size,          //!< Size required
-                  const char *file,     //!< File of call
-                  int lineno            //!< Line number of call
+void *p_psRealloc(void *ptr,            ///< Pointer to re-allocate
+                  size_t size,          ///< Size required
+                  const char *file,     ///< File of call
+                  int lineno            ///< Line number of call
                   );
 
 /// Free memory.  Underlying private function called by macro psFree. 
-void p_psFree(void *ptr,                //!< Pointer to free
-              const char *file,         //!< File of call
-              int lineno                //!< Line number of call
+void p_psFree(void *ptr,                ///< Pointer to free
+              const char *file,         ///< File of call
+              int lineno                ///< Line number of call
               );
 
 /// Check for memory leaks 
-int psMemCheckLeaks(int id0,            //!< don't list blocks with id < id0
-                    psMemBlock ***arr,  //!< pointer to array of pointers to leaked blocks, or NULL
-                    FILE *fd            //!< print list of leaks to fd (or NULL)
+int psMemCheckLeaks(int id0,            ///< don't list blocks with id < id0
+                    psMemBlock ***arr,  ///< pointer to array of pointers to leaked blocks, or NULL
+                    FILE *fd            ///< print list of leaks to fd (or NULL)
                     );
 
 /// Check for memory corruption 
-int psMemCheckCorruption(int abort_on_error //!< Abort on detecting corruption?
+int psMemCheckCorruption(int abort_on_error ///< Abort on detecting corruption?
                          );
 
 /// Return reference counter 
-int psMemGetRefCounter(void *vptr       //!< Pointer to get refCounter for
+int psMemGetRefCounter(void *vptr       ///< Pointer to get refCounter for
                        );
 
 /// Increment reference counter and return the pointer 
-void *psMemIncrRefCounter(void *vptr    //!< Pointer to increment refCounter, and return
+void *psMemIncrRefCounter(void *vptr    ///< Pointer to increment refCounter, and return
                           );
 
 /// Decrement reference counter and return the pointer 
-void *psMemDecrRefCounter(void *vptr    //!< Pointer to decrement refCounter, and return
+void *psMemDecrRefCounter(void *vptr    ///< Pointer to decrement refCounter, and return
                           );
 
 /// Set callback for problems 
-psMemProblemCallback psMemProblemSetCB(psMemProblemCallback func //!< Function to run
+psMemProblemCallback psMemProblemSetCB(psMemProblemCallback func ///< Function to run
                                        );
 
 /// Set callback for out-of-memory 
-psMemExhaustedCallback psMemExhaustedSetCB(psMemExhaustedCallback func //!< Function to run
+psMemExhaustedCallback psMemExhaustedSetCB(psMemExhaustedCallback func ///< Function to run
                                            );
 
 /// Set call back for when a particular memory block is allocated 
-psMemCallback psMemAllocateSetCB(psMemCallback func //!< Function to run
+psMemCallback psMemAllocateSetCB(psMemCallback func ///< Function to run
                                  );
 
@@ -99 +99 @@
 
 /// set p_psMemAllocateID to id 
-long psMemSetAllocateID(long id         //!< ID to set
+long psMemSetAllocateID(long id         ///< ID to set
                         );
 
 /// set p_psMemFreeID to id 
-long psMemSetFreeID(long id             //!< ID to set
+long psMemSetFreeID(long id             ///< ID to set
                     );