From 51381c73a9ad796f4d12faf6c7ec6f60cbc9f9b6 Mon Sep 17 00:00:00 2001 From: Matthias Braun Date: Fri, 27 Apr 2007 11:08:21 +0000 Subject: [PATCH] normalized doxygen comments [r13514] --- ir/debug/dbginfo.c | 16 ++++++---------- ir/debug/dbginfo.h | 31 +++++++++---------------------- ir/debug/dbginfo_t.h | 37 +++++++++++++------------------------ ir/debug/debugger.c | 15 ++++++--------- ir/debug/debugger.h | 21 +++++++++------------ ir/debug/firm_ycomp.c | 15 ++++++--------- ir/debug/firm_ycomp.h | 21 +++++++++------------ ir/debug/seqnumbers.c | 28 ++++++++++------------------ ir/debug/seqnumbers.h | 37 +++++++++++++++---------------------- 9 files changed, 83 insertions(+), 138 deletions(-) diff --git a/ir/debug/dbginfo.c b/ir/debug/dbginfo.c index 64ecc0476..a65f28b52 100644 --- a/ir/debug/dbginfo.c +++ b/ir/debug/dbginfo.c @@ -17,17 +17,13 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/dbginfo.c - * Purpose: Implements the Firm interface to debug information. - * Author: Goetz Lindenmaier - * Modified by: Michael Beck - * Created: 2001 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2006 Universität Karlsruhe +/** + * @file + * @brief Implements the Firm interface to debug information. + * @author Goetz Lindenmaier, Michael Beck + * @date 2001 + * @version $Id$ */ - #ifdef HAVE_CONFIG_H # include "config.h" #endif diff --git a/ir/debug/dbginfo.h b/ir/debug/dbginfo.h index 100d231de..1168907ef 100644 --- a/ir/debug/dbginfo.h +++ b/ir/debug/dbginfo.h @@ -17,24 +17,13 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/dbginfo.h - * Purpose: Implements the Firm interface to debug information. - * Author: Goetz Lindenmaier - * Modified by: Michael Beck - * Created: 2001 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2003 Universität Karlsruhe - */ - /** - * @file dbginfo.h - * - * This is the Firm interface to debugging support. - * - * @author Goetz Lindenmaier, Michael Beck - * + * @file + * @brief Implements the Firm interface to debug information. + * @author Goetz Lindenmaier, Michael Beck + * @date 2001 + * @version $Id$ + * @summary * Firm requires a debugging module fulfilling this interface, else no * debugging information is passed to the backend. * The interface requires a datatype representing the debugging @@ -42,11 +31,9 @@ * information in every Firm node. Further Firm optimizations call * routines to propagate debug information from old nodes to new nodes * if the optimization replaces the old ones by the new ones. - * */ - -#ifndef _DBGINFO_H_ -#define _DBGINFO_H_ +#ifndef FIRM_DEBUG_DBGINFO_H +#define FIRM_DEBUG_DBGINFO_H #include "firm_types.h" #include "ident.h" @@ -256,4 +243,4 @@ void default_dbg_info_merge_sets(ir_node **new_nodes, int n_new_nodes, } #endif -#endif /* _DBGINFO_H_ */ +#endif diff --git a/ir/debug/dbginfo_t.h b/ir/debug/dbginfo_t.h index fe3be93de..ffddc41f1 100644 --- a/ir/debug/dbginfo_t.h +++ b/ir/debug/dbginfo_t.h @@ -17,30 +17,19 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/dbginfo.h - * Purpose: Implements the Firm interface to debug information -- private header. - * Author: Goetz Lindenmaier - * Modified by: - * Created: 2001 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2003 Universität Karlsruhe - */ - /** -* @file dbginfo_t.h -* -* @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. -*/ - - -#ifndef __DBGINFO_T_H__ -#define __DBGINFO_T_H__ + * @file + * @brief Implements the Firm interface to debug information -- private header. + * @author Goetz Lindenmaier + * @date 2001 + * @version $Id$ + * @summary + * 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. + */ +#ifndef FIRM_DEBUG_DBGINFO_T_H +#define FIRM_DEBUG_DBGINFO_T_H #include "dbginfo.h" @@ -59,4 +48,4 @@ extern merge_sets_func *__dbg_info_merge_sets; */ extern snprint_dbg_func *__dbg_info_snprint; -#endif /* __DBGINFO_T_H__ */ +#endif diff --git a/ir/debug/debugger.c b/ir/debug/debugger.c index e28bba0dd..a9e7ac47c 100644 --- a/ir/debug/debugger.c +++ b/ir/debug/debugger.c @@ -17,15 +17,12 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/debugger.c - * Purpose: Helper function for integerated debug support - * Author: Michael Beck - * Modified by: - * Created: 2005 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2007 Universität Karlsruhe +/** + * @file + * @brief Helper function for integerated debug support + * @author Michael Beck + * @date 2005 + * @version $Id$ */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ir/debug/debugger.h b/ir/debug/debugger.h index 37d790acb..410c68f03 100644 --- a/ir/debug/debugger.h +++ b/ir/debug/debugger.h @@ -17,18 +17,15 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/debugger.h - * Purpose: Helper function for integerated debug support - * Author: Michael Beck - * Modified by: - * Created: 2005 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2005 Universität Karlsruhe +/** + * @file + * @brief Helper function for integerated debug support + * @author Michael Beck + * @date 2005 + * @version $Id$ */ -#ifndef __DEBUGGER_H__ -#define __DEBUGGER_H__ +#ifndef FIRM_DEBUG_DEBUGGER_H +#define FIRM_DEBUG_DEBUGGER_H /** Break into the debugger. */ void firm_debug_break(void); @@ -45,4 +42,4 @@ void firm_break(const char *cmd); /** Creates the debugger tables. */ void firm_init_debugger(void); -#endif /* __DEBUGGER_H__ */ +#endif diff --git a/ir/debug/firm_ycomp.c b/ir/debug/firm_ycomp.c index 626de1488..9c2c937d5 100644 --- a/ir/debug/firm_ycomp.c +++ b/ir/debug/firm_ycomp.c @@ -17,15 +17,12 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/firm_ycomp.c - * Purpose: Connect firm to ycomp - * Author: Christian Wuerdig - * Modified by: - * Created: 16.11.2006 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2006 Universität Karlsruhe +/** + * @file + * @brief Connect firm to ycomp + * @author Christian Wuerdig + * @date 16.11.2006 + * @version $Id$ */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ir/debug/firm_ycomp.h b/ir/debug/firm_ycomp.h index 5685db250..3c473e0f6 100644 --- a/ir/debug/firm_ycomp.h +++ b/ir/debug/firm_ycomp.h @@ -17,18 +17,15 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/firm_ycomp.h - * Purpose: Connect firm to ycomp - * Author: Christian Wuerdig - * Modified by: - * Created: 16.11.2006 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2006 Universität Karlsruhe +/** + * @file + * @brief Connect firm to ycomp + * @author Christian Wuerdig + * @date 16.11.2006 + * @version $Id$ */ -#ifndef _FIRM_YCOMP_H_ -#define _FIRM_YCOMP_H_ +#ifndef FIRM_DEBUG_FIRM_YCOMP_H +#define FIRM_DEBUG_FIRM_YCOMP_H #define FIRM_YCOMP_DEFAULT_HOST "localhost" #define FIRM_YCOMP_DEFAULT_PORT 4242 @@ -45,4 +42,4 @@ void firm_init_ycomp_debugger(const char *host, unsigned port); */ void firm_finish_ycomp_debugger(void); -#endif /* _FIRM_YCOMP_H_ */ +#endif diff --git a/ir/debug/seqnumbers.c b/ir/debug/seqnumbers.c index 5f4746617..bdeb0250e 100644 --- a/ir/debug/seqnumbers.c +++ b/ir/debug/seqnumbers.c @@ -17,27 +17,19 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/seqnumbers.c - * Purpose: Implements simple sequence numbers for Firm debug info. - * Author: Michael Beck - * Modified by: - * Created: 2005 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2005 Universität Karlsruhe - */ - /** - * @file seqnumbers.c + * @file + * @brief Implements simple sequence numbers for Firm debug info. + * @author Michael Beck + * @date 2005 + * @version $Id$ + * @summary + * Sequence numbers for Firm. * - * Sequence numbers for Firm. - * - * A sequence number is an unique number representing a filename - * and a line number. The number 0 represents empty information. - * This module is an optional "snap-in" for the Firm debug info. + * A sequence number is an unique number representing a filename + * and a line number. The number 0 represents empty information. + * This module is an optional "snap-in" for the Firm debug info. */ - #ifdef HAVE_CONFIG_H # include "config.h" #endif diff --git a/ir/debug/seqnumbers.h b/ir/debug/seqnumbers.h index cef173b16..bc48057d0 100644 --- a/ir/debug/seqnumbers.h +++ b/ir/debug/seqnumbers.h @@ -17,30 +17,23 @@ * PURPOSE. */ -/* - * Project: libFIRM - * File name: ir/debug/seqnumbers.h - * Purpose: Implements simple sequence numbers for Firm debug info. - * Author: Michael Beck - * Modified by: - * Created: 2005 - * CVS-ID: $Id$ - * Copyright: (c) 2001-2005 Universität Karlsruhe - */ - /** - * @file seqnumbers.h + * @file + * @brief Implements simple sequence numbers for Firm debug info. + * @author Michael Beck + * @date 2005 + * @version $Id$ + * @summary + * Sequence numbers for Firm. * - * Sequence numbers for Firm. - * - * A sequence number is an unique number representing a filename - * and a line number. The number 0 represents empty information. - * This module is an optional "snap-in" for the Firm debug info. - * In simple cases it should be possible to use sequence numbers - * as dbg_info. + * A sequence number is an unique number representing a filename + * and a line number. The number 0 represents empty information. + * This module is an optional "snap-in" for the Firm debug info. + * In simple cases it should be possible to use sequence numbers + * as dbg_info. */ -#ifndef _SEQNUMBERS_H_ -#define _SEQNUMBERS_H_ +#ifndef FIRM_DEBUG_SEQNUMBERS_H +#define FIRM_DEBUG_SEQNUMBERS_H #include "ident.h" @@ -98,4 +91,4 @@ void firm_seqno_init(void); */ void firm_seqno_term(void); -#endif /* _SEQNUMBERS_H_ */ +#endif -- 2.20.1