]> granicus.if.org Git - yasm/commitdiff
Watch placement of \internal Doxygen tag.
authorPeter Johnson <peter@tortall.net>
Sun, 4 May 2003 08:40:35 +0000 (08:40 -0000)
committerPeter Johnson <peter@tortall.net>
Sun, 4 May 2003 08:40:35 +0000 (08:40 -0000)
svn path=/trunk/yasm/; revision=938

libyasm/bytecode.h
libyasm/errwarn.h

index 59f00d94d4cb8086eaee9755f02cbf53f5382423..f6bd42beea925d09534f3a53a8e42697522642b1 100644 (file)
@@ -2,7 +2,7 @@
  * \file bytecode.h
  * \brief YASM bytecode interface.
  *
- * $IdPath$
+ * $IdPath: yasm/libyasm/bytecode.h,v 1.71 2003/03/31 08:22:05 peter Exp $
  *
  *  Copyright (C) 2001  Peter Johnson
  *
@@ -43,9 +43,9 @@ typedef struct yasm_datavalhead yasm_datavalhead;
 /*@reldef@*/ STAILQ_HEAD(yasm_bytecodehead, yasm_bytecode);
 /*@reldef@*/ STAILQ_HEAD(yasm_datavalhead, yasm_dataval);
 
-/** \internal Built-in bytecode types.
- * Additional types may be #yasm_arch defined starting at
- * #YASM_BYTECODE_TYPE_BASE.
+/** Built-in bytecode types.  Additional types may be #yasm_arch defined
+ * starting at #YASM_BYTECODE_TYPE_BASE.
+ * \internal
  */
 typedef enum {
     YASM_BC__EMPTY = 0,            /**< Empty; should not exist except temporarily. */
index 524047121de824286037771d90b0dabd88d9c12a..cb11692f6070f5b3f8ce9638e0871fc8943a2ae4 100644 (file)
@@ -2,7 +2,7 @@
  * \file errwarn.h
  * \brief YASM error and warning reporting interface.
  *
- * $IdPath: yasm/libyasm/errwarn.h,v 1.35 2003/03/16 23:52:54 peter Exp $
+ * $IdPath: yasm/libyasm/errwarn.h,v 1.36 2003/05/04 01:39:10 peter Exp $
  *
  *  Copyright (C) 2001  Peter Johnson
  *
@@ -72,14 +72,16 @@ extern /*@exits@*/ void (*yasm_fatal) (const char *message);
 
 #ifdef YASM_INTERNAL
 
-/** \internal Log an error.  va_list version of yasm__error().
+/** Log an error.  va_list version of yasm__error().
+ * \internal
  * \param lindex    line index
  * \param message   printf-like-format message
  * \param va       argument list for message
  */
 void yasm__error_va(unsigned long lindex, const char *message, va_list va);
 
-/** \internal Log a warning.  va_list version of yasm__warning().
+/** Log a warning.  va_list version of yasm__warning().
+ * \internal
  * \param wclass    warning class
  * \param lindex    line index
  * \param message   printf-like-format message
@@ -88,8 +90,9 @@ void yasm__error_va(unsigned long lindex, const char *message, va_list va);
 void yasm__warning_va(yasm_warn_class wclass, unsigned long lindex,
                      const char *message, va_list va);
 
-/** \internal Log an error.  Does not print it out immediately;
- * yasm_errwarn_output_all() outputs errors and warnings.
+/** Log an error.  Does not print it out immediately; yasm_errwarn_output_all()
+ * outputs errors and warnings.
+ * \internal
  * \param lindex    line index
  * \param message   printf-like-format message
  * \param ...      argument list for message
@@ -97,8 +100,9 @@ void yasm__warning_va(yasm_warn_class wclass, unsigned long lindex,
 void yasm__error(unsigned long lindex, const char *message, ...)
     /*@printflike@*/;
 
-/** \internal Log a warning.  Does not print it out immediately;
+/** Log a warning.  Does not print it out immediately;
  * yasm_errwarn_output_all() outputs errors and warnings.
+ * \internal
  * \param wclass    warning class
  * \param lindex    line index
  * \param message   printf-like-format message
@@ -107,8 +111,9 @@ void yasm__error(unsigned long lindex, const char *message, ...)
 void yasm__warning(yasm_warn_class, unsigned long lindex, const char *message,
                   ...) /*@printflike@*/;
 
-/** \internal Log a parser error.  Parser errors can be overwritten by
- * non-parser errors on the same line.
+/** Log a parser error.  Parser errors can be overwritten by non-parser errors
+ * on the same line.
+ * \internal
  * \param lindex    line index
  * \param message   parser error message
  */
@@ -162,7 +167,8 @@ void yasm_errwarn_output_all
      yasm_print_warning_func print_warning);
 
 #ifdef YASM_INTERNAL
-/** \internal Convert a possibly unprintable character into a printable string.
+/** Convert a possibly unprintable character into a printable string.
+ * \internal
  * \param ch   possibly unprintable character
  * \return Printable string representation (static buffer).
  */