From: Michael Beck <beck@ipd.info.uni-karlsruhe.de>
Date: Tue, 4 Feb 2003 13:52:58 +0000 (+0000)
Subject: Converted comments to doxygen
X-Git-Url: http://nsz.repo.hu/git/?a=commitdiff_plain;h=46b5a81b33d38442ddff26d75f4c8ba61742aa1e;hp=c1295ef6252a6d902d67f5f038534e9125743cd0;p=libfirm

Converted comments to doxygen

[r735]
---

diff --git a/ir/debug/dbginfo_t.h b/ir/debug/dbginfo_t.h
index f84a4babe..3b963af79 100644
--- a/ir/debug/dbginfo_t.h
+++ b/ir/debug/dbginfo_t.h
@@ -1,14 +1,16 @@
 /*
 *  Copyright (C) 2001 by Universitaet Karlsruhe
 *  All rights reserved.
+*/
+
+/**
+* @file dbginfo_t.h
 *
-*  Authors: Goetz Lindenmaier
+* @author Goetz Lindenmaier
 *
 *  dbginfo: This is a empty implementation of the Firm interface to
 *  debugging support.  It only guarantees that the Firm library compiles
 *  and runs without any real debugging support.
-*  The functions herein are declared weak so that they can be overriden
-*  by a real implementation.
 */
 
 /* $Id$ */
diff --git a/ir/st/st.h b/ir/st/st.h
index 37e28943f..309df8ae4 100644
--- a/ir/st/st.h
+++ b/ir/st/st.h
@@ -1,17 +1,22 @@
-/* Copyright (c) 2002 by Universität Karlsruhe (TH).  All Rights Reserved  */
+/* Copyright (c) 2002 by Universitaet Karlsruhe (TH).  All Rights Reserved  */
 
 /**
-   NAME
-     st.h
-   PURPOSE
-     provide some auxilliary structures for firm graphs.
-   S
+   @file st.h
+
+   Provide some auxilliary structures for firm graphs.
+
+   @author Florian Liekweg
+
+   @note
      not quite complete
+*/
+
+/*
    HISTORY
      liekweg - Feb 26, 2002: Created.
    CVS:
      $Id$
-***/
+*/
 
 # ifndef _ST_H_
 # define _ST_H_
@@ -27,18 +32,18 @@
 
 /* Data Types: */
 
-/*   One dominator tree */
+/**  One dominator tree */
 typedef struct
 {
   int n_blocks;
-  ir_graph *graph;	/* PRE */
+  ir_graph *graph;	/**< PRE */
   ir_node **blocks;
-  ir_node **idoms;	/* idom [n] == immediate dominator of blocks [n] */
+  ir_node **idoms;	/**< idom [n] == immediate dominator of blocks [n] */
   bs_t *masks;
 }
 dt_t;
 
-/* List entry:  */
+/** List entry.  */
 typedef struct dtree_t
 {
   dt_t *tree;
@@ -48,7 +53,7 @@ typedef struct dtree_t
 }
 dtree_t;
 
-/* dominator environment for a node @a in graph @graph */
+/** dominator environment for a node dom_env_t::a in graph dom_env_t::graph */
 typedef struct dom_env_t
 {
   dt_t     *dt;
diff --git a/ir/tr/typegmod_t.h b/ir/tr/typegmod_t.h
index 6cf1416c4..91f2b804d 100644
--- a/ir/tr/typegmod_t.h
+++ b/ir/tr/typegmod_t.h
@@ -1,3 +1,4 @@
+/* (C) 2001 by Universitaet Karlsruhe */
 
 /* $Id$ */
 
@@ -7,9 +8,7 @@
 # include "typegmod.h"
 
 /**
- *
- *  file typegmod.h
- *   (C) 2001 by Universitaet Karlsruhe
+ * @file typegmod.h
  *   Goetz Lindenmaier
  *  This module supplies routines that support changing the type graph.
  */