Minor changes to the documentation.
authoraszostak <aszostak@f7af4fe6-9843-0410-8265-dc069ae4e863>
Wed, 30 Apr 2008 17:54:01 +0000 (17:54 +0000)
committeraszostak <aszostak@f7af4fe6-9843-0410-8265-dc069ae4e863>
Wed, 30 Apr 2008 17:54:01 +0000 (17:54 +0000)
HLT/MUON/AliHLTMUONDataBlockReader.h
HLT/MUON/AliHLTMUONDataBlockWriter.h

index 2e98e57..91098fe 100644 (file)
@@ -45,7 +45,7 @@
  * stored in memory and the size of the data block is given by the variable 'size'.
  * The data block is of type 'block_type' and the data block entries are of type
  * 'entries_type'. The data block can be accessed in the following way:
- *
+ * \code
  *   void* buffer = somebuffer;
  *   AliHLTUInt32_t size = somebuffer_size;
  *   
@@ -67,6 +67,7 @@
  *      const entries_type& entry = block[i];
  *      // Do something with the entry...
  *   }
+ * \endcode
  */
 template <class DataBlockType, class DataElementType>
 class AliHLTMUONDataBlockReader
index 1d4c6ab..3b64410 100644 (file)
@@ -45,7 +45,7 @@
  * variable 'size'. The data block is of type 'block_type', the data block entries
  * are of type 'entries_type' and the data block type code is 'type_code'.
  * The data block can be written in the following way:
- *
+ * \code
  *   void* buffer = somebuffer;
  *   AliHLTUInt32_t size = somebuffer_size;
  *   
@@ -72,9 +72,9 @@
  *      // fill the new entry...
  *      entry.somefield = somevalue;
  *   }
- *
+ * \endcode
  * The slightly slower but safer method is to do the following:
- *
+ * \code
  *   AliHLTMUONDataBlockWriter<block_type, entries_type, type_code>
  *   block(buffer, size);
  *   if (not block.InitCommonHeader())
@@ -93,6 +93,7 @@
  *      // fill the new entry...
  *      entry->somefield = somevalue;
  *   }
+ * \endcode
  */
 template <
        class DataBlockType,