some fixes for xml dumper / still buggy.
[libfirm] / ir / common / tune.h
index 6186679..7af5698 100644 (file)
@@ -6,7 +6,14 @@
 #ifndef _TUNE_H
 #define _TUNE_H
 
-/* From the jargon file:
+/**
+ @file tune.h
+
+ Tunable parameters.
+
+ @author Markus Armbruster & Christian von Roques
+
+ From the jargon file:
 
    :tune: vt.  [from automotive or musical usage] To optimize a
       program or system for a particular environment, esp. by adjusting
  */
 
 
-/* Suggested minimal block size for buffered I/O */
+/** Suggested minimal block size for buffered I/O */
 #define TUNE_SMALL_IOBUF_SIZE 512
 
-/* Size of pdeq block cache */
+/** Size of pdeq block cache */
 #define TUNE_NSAVED_PDEQS 16
 
 
    larger values generally mean slower startup.  */
 
 
-/* Expected number of distinct identifiers */
+/** Expected number of distinct identifiers */
 #define TUNE_NIDENTS 1024
 
-/* Expected number of classes */
+/** Expected number of classes */
 #define TUNE_NCLASSES 128
 
-/* Expected number of class types */
+/** Expected number of class types */
 #define TUNE_NCTYPES 128
 
-/* Expected number of routine, stream and stream object types */
+/** Expected number of routine, stream and stream object types */
 #define TUNE_NMTYPES 512
 
-/* Expected number of method families */
+/** Expected number of method families */
 #define TUNE_NMFAMILIES (TUNE_NCTYPES * 16)
 
-/* Expected number of Intermediate Representation nodes for a method */
+/** Expected number of Intermediate Representation nodes for a method */
 #define TUNE_NIR_NODES 512
 
-/* Expected number of distinct constant target values */
+/** Expected number of distinct constant target values */
 #define TUNE_NCONSTANTS        2048
 
-/* notify configuration manager to prefetch sources */
+/** notify configuration manager to prefetch sources */
 #define TUNE_PREFETCH
 
 #endif