diff arrayalloc.h @ 5:5f3c32dc6e17

* Adjust comment syntax to permit Doxygen to generate HTML documentation; add Doxyfile
author Chris Cannam
date Wed, 06 Oct 2010 15:19:49 +0100
parents 6422640a802f
children 977f541d6683
line wrap: on
line diff
--- a/arrayalloc.h	Tue Oct 05 17:03:27 2010 +0100
+++ b/arrayalloc.h	Wed Oct 06 15:19:49 2010 +0100
@@ -1,8 +1,8 @@
 #ifndef ARRAYALLOC
 #define ARRAYALLOC
 
-/*
-  arrayalloc.h - 2D, 3D and 4D array memory allocation routines.
+/**
+  \file arrayalloc.h - 2D, 3D and 4D array memory allocation routines.
 
   An x-dimensional array (x=2, 3, 4, ...) is managed as a single memory block hosting all records, plus
   an index block which is a (x-1)D array itself. Therefore a 2D array is allocated as two 1D arrays, a