X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fstat%2Fpattern_dmp.h;h=3c0249347c0d425242be3848fa70f7305e8eab1a;hb=b4841b96869c6fbd61f4ae3931d3c69c6b33c2e0;hp=03f466023f2546f1a1d545cf7338c2446d70f562;hpb=d9d444015d8474c39a80d2f0a87aae9c2afdba06;p=libfirm

diff --git a/ir/stat/pattern_dmp.h b/ir/stat/pattern_dmp.h
index 03f466023..3c0249347 100644
--- a/ir/stat/pattern_dmp.h
+++ b/ir/stat/pattern_dmp.h
@@ -1,32 +1,56 @@
-#ifndef _PATTERN_DMP_H_
-#define _PATTERN_DMP_H_
+/*
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
+
+/**
+ * @file
+ * @brief   Statistics for Firm. Dumping patterns.
+ * @author  Michael Beck
+ */
+#ifndef FIRM_STAT_PATTERN_DMP_H
+#define FIRM_STAT_PATTERN_DMP_H
 
 #include "counter.h"
 
-typedef struct _pattern_dumper_t pattern_dumper_t;
+typedef struct pattern_dumper_t pattern_dumper_t;
 
 /**
- * starts a new pattern
+ * Starts a new pattern.
  */
 void pattern_dump_new_pattern(pattern_dumper_t *self, counter_t *cnt);
 
 /**
- * Finishes current pattern
+ * Finish the current pattern.
  */
 void pattern_dump_finish_pattern(pattern_dumper_t *self);
 
 /**
- * Dumps a node
+ * Dumps a node.
  */
 void pattern_dump_node(pattern_dumper_t *self, unsigned id, unsigned op_code, unsigned mode_code, void *attr);
 
 /**
- * Dump a ref
+ * Dump a ref.
  */
 void pattern_dump_ref(pattern_dumper_t *self, unsigned id);
 
 /**
- * Dump an edge
+ * Dump an edge.
  *
  * @param tgt       The target ID
  * @param src       The source ID
@@ -36,31 +60,31 @@ void pattern_dump_ref(pattern_dumper_t *self, unsigned id);
 void pattern_dump_edge(pattern_dumper_t *self, unsigned tgt, unsigned src, unsigned pos, unsigned mode_code);
 
 /**
- * Start children dumper
+ * Start the children dumper.
  */
 void pattern_start_children(pattern_dumper_t *self, unsigned id);
 
 /**
- * finishes childred dumper
+ * Finish the children dumper.
  */
 void pattern_finish_children(pattern_dumper_t *self, unsigned id);
 
 /**
- * finishes dumper, destroyes the dumper object
+ * Finish the dumper, destroys the dumper object
  */
 void pattern_end(pattern_dumper_t *self);
 
 /**
- * pattern dumper factory for text dumper
+ * Pattern dumper factory for text dumper.
  */
 pattern_dumper_t *new_text_dumper(void);
 
 /**
- * pattern dumper factory for vcg dumper
+ * Pattern dumper factory for vcg dumper.
  *
  * @param vcg_name    name of the VCG file
  * @param max_pattern maximum number of pattern to be dumped
  */
 pattern_dumper_t *new_vcg_dumper(const char *vcg_name, unsigned max_pattern);
 
-#endif /* _PATTERN_DMP_H_ */
+#endif /* FIRM_STAT_PATTERN_DMP_H */