added license information, cleaned up doxygen comments

[libfirm] / ir / common / firmwalk.h

diff --git a/ir/common/firmwalk.h b/ir/common/firmwalk.h
index 56b41ff..83b7dca 100644 (file)
--- a/ir/common/firmwalk.h
+++ b/ir/common/firmwalk.h
@@ -1,18 +1,29 @@
 /*
- * Project:     libFIRM
- * File name:   ir/common/firmwalk.h
- * Purpose:     Walker that touches all Firm data structures
- * Author:      Sebastian Felis
- * Modified by:
- * Created:     7.2003
- * CVS-ID:      $Id$
- * Copyright:   (c) 2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 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 firmwalk.h
- *
+ * @file
+ * @biref    Walker that touches all Firm data structures
+ * @author   Sebastian Felis
+ * @date     7.2003
+ * @version  $Id$
+ * @summary
  *  Firm walker over intermediate representation.
  *
  *  To initialize the walker, call firm_walk_init(). This function
@@ -28,9 +39,10 @@
  *        of any firm node, the the wrapper functions set_firm_walk_link()
  *        and get_firm_walk_link() should be used, because the firm walker
  *        make use of the link field to store its own data.
+ *  @note Deprecated, better use the stuff in irgwalk.h, typewalk.h
  */
-#ifndef _FIRM_WALK_H_
-#define _FIRM_WALK_H_
+#ifndef FIRM_COMMON_FIRM_WALK_H
+#define FIRM_COMMON_FIRM_WALK_H
 
 #include "firm_types.h"
 
@@ -216,4 +228,4 @@ void firm_walk_finalize(void);
 #endif
 
 
-#endif /* _FIRM_WALK_H_ */
+#endif