c-tree.texi: Wrap comments in @r{}.
authorJames A. Morrison <phython@gcc.gnu.org>
Sat, 5 Mar 2005 19:56:31 +0000 (19:56 +0000)
committerJames A. Morrison <phython@gcc.gnu.org>
Sat, 5 Mar 2005 19:56:31 +0000 (19:56 +0000)
2005-03-05  James A. Morrison  <phython@gcc.gnu.org>

        * doc/c-tree.texi: Wrap comments in @r{}.
        * doc/cpp.texi: Likewise.
        * doc/cppinternals.texi: Likewise.
        * doc/extend.texi: Likewise.
        * doc/md.texi: Likewise.
        * doc/objc.texi: Likewise.
        * doc/sourcebuild.texi: Likewise.
        * doc/tm.texi: Likewise.
        * doc/tree-ssa.texi

From-SVN: r95939

gcc/ChangeLog
gcc/doc/c-tree.texi
gcc/doc/cpp.texi
gcc/doc/cppinternals.texi
gcc/doc/extend.texi
gcc/doc/md.texi
gcc/doc/objc.texi
gcc/doc/sourcebuild.texi
gcc/doc/tm.texi
gcc/doc/tree-ssa.texi

index b04f74952c45b578971e1eb5d66480e62a8e6c57..6e8b77fc0243d425c47dc08d1ed9a37bb9b02a2b 100644 (file)
@@ -1,3 +1,15 @@
+2005-03-05  James A. Morrison  <phython@gcc.gnu.org>
+
+       * doc/c-tree.texi: Wrap comments in @r{}.
+       * doc/cpp.texi: Likewise.
+       * doc/cppinternals.texi: Likewise.
+       * doc/extend.texi: Likewise.
+       * doc/md.texi: Likewise.
+       * doc/objc.texi: Likewise.
+       * doc/sourcebuild.texi: Likewise.
+       * doc/tm.texi: Likewise.
+       * doc/tree-ssa.texi
+
 2005-03-05  Kazu Hirata  <kazu@cs.umass.edu>
 
        * predict.c (apply_return_prediction): Standardize PHI chain
index e0881cf2d807ebbabae983d313d2d5496520ee69..a6033f16256856f12e2c4bc7cbb815366b6d272d 100644 (file)
@@ -1363,7 +1363,7 @@ void process_stmt (stmt)
         @{
         case IF_STMT:
           process_stmt (THEN_CLAUSE (stmt));
-          /* More processing here.  */
+          /* @r{More processing here.}  */
           break;
 
         @dots{}
index ea38218b8c14a25d01cda861c318ed3d7a0e694c..e6a7dcd06eb6b71905f5494d99db36b0b22d08cc 100644 (file)
@@ -1318,7 +1318,7 @@ name, and you wish to use the function sometimes.
 
 @smallexample
 extern void foo(void);
-#define foo() /* optimized inline version */
+#define foo() /* @r{optimized inline version} */
 @dots{}
   foo();
   funcptr = foo;
@@ -2211,7 +2211,7 @@ These definitions are effectively the same:
 @smallexample
 #define FOUR (2 + 2)
 #define FOUR         (2    +    2)
-#define FOUR (2 /* two */ + 2)
+#define FOUR (2 /* @r{two} */ + 2)
 @end smallexample
 @noindent
 but these are not:
@@ -3538,8 +3538,8 @@ require matching quotes.  For example:
 @smallexample
 #define m This macro's fine and has an unmatched quote
 "/* This is not a comment.  */
-/* This is a comment.  The following #include directive
-   is ill-formed.  */
+/* @r{This is a comment.  The following #include directive
+   is ill-formed.}  */
 #include <stdio.h
 @end smallexample
 
@@ -3626,7 +3626,7 @@ example
 
 @smallexample
 #define str(x) "x"
-str(/* A comment */some text )
+str(/* @r{A comment} */some text )
      @expansion{} "some text "
 @end smallexample
 
index b5ee7844d2dcc5bf26cec45189871a63e402bfdd..13db034b0ca42f09a5b40c1f903a325e24175c19 100644 (file)
@@ -789,8 +789,8 @@ lexed on if, for example, there are intervening escaped newlines or
 C-style comments.  For example:
 
 @smallexample
-foo /* A long
-comment */ bar \
+foo /* @r{A long
+comment} */ bar \
 baz
 @result{}
 foo bar baz
index c15104926901636eded702449496be549645321d..3b336d44dda1c071a6fd609f3eb50765726fcabd 100644 (file)
@@ -2575,7 +2575,7 @@ int isroot P((uid_t));
 
 /* @r{Old-style function definition.}  */
 int
-isroot (x)   /* ??? lossage here ??? */
+isroot (x)   /* @r{??? lossage here ???} */
      uid_t x;
 @{
   return x == 0;
@@ -2854,13 +2854,13 @@ int init_data __attribute__ ((section ("INITDATA"))) = 0;
 
 main()
 @{
-  /* Initialize stack pointer */
+  /* @r{Initialize stack pointer} */
   init_sp (stack + sizeof (stack));
 
-  /* Initialize initialized data */
+  /* @r{Initialize initialized data} */
   memcpy (&init_data, &data, &edata - &data);
 
-  /* Turn on the serial ports */
+  /* @r{Turn on the serial ports} */
   init_duart (&a);
   init_duart (&b);
 @}
@@ -2899,8 +2899,8 @@ int foo __attribute__((section ("shared"), shared)) = 0;
 int
 main()
 @{
-  /* Read and write foo.  All running
-     copies see the same value.  */
+  /* @r{Read and write foo.  All running
+     copies see the same value.}  */
   return 0;
 @}
 @end smallexample
@@ -3464,7 +3464,7 @@ GCC does not inline any functions when not optimizing unless you specify
 the @samp{always_inline} attribute for the function, like this:
 
 @smallexample
-/* Prototype.  */
+/* @r{Prototype.}  */
 inline void foo (const char) __attribute__((always_inline));
 @end smallexample
 
@@ -3634,7 +3634,7 @@ example for the VAX:
 
 @smallexample
 asm volatile ("movc3 %0,%1,%2"
-              : /* no outputs */
+              : /* @r{no outputs} */
               : "g" (from), "g" (to), "g" (count)
               : "r0", "r1", "r2", "r3", "r4", "r5");
 @end smallexample
index a2b992e432304bd4b1ddf6bb1ef59cccb9b0cb37..d3312f75bc50901c7310105bbe105a8fae9984d0 100644 (file)
@@ -4678,9 +4678,9 @@ an equality comparison of a register and a large constant:
    (set (match_dup 0) (compare:CC (match_dup 3) (match_dup 5)))]
   "
 @{
-  /* Get the constant we are comparing against, C, and see what it
+  /* @r{Get the constant we are comparing against, C, and see what it
      looks like sign-extended to 16 bits.  Then see what constant
-     could be XOR'ed with C to get the sign-extended value.  */
+     could be XOR'ed with C to get the sign-extended value.}  */
 
   int c = INTVAL (operands[2]);
   int sextc = (c << 16) >> 16;
index 481b51c09b85247bc99ecb10ce0bd818f62073bb..795e281f726514b79bc2ee93955b953a13dd17e9 100644 (file)
@@ -56,7 +56,7 @@ FileStream *Stderr = nil;
     Stderr = [[FileStream new] initWithFd:2];
 @}
 
-/* Other methods here */
+/* @r{Other methods here} */
 @@end
 
 @end smallexample
@@ -84,7 +84,7 @@ method instead of @code{+initialize}:
     Stderr = [[FileStream new] initWithFd:2];
 @}
 
-/* Other methods here */
+/* @r{Other methods here} */
 @@end
 
 @end smallexample
index f4927e80382939afd473d205a8de6ec68e51fc29..edb61b13f26a45d119078b2eb66f967018f835eb 100644 (file)
@@ -1321,8 +1321,8 @@ kind.  A command @code{branch(end)} or @code{returns(end)} marks
 the end of a range without starting a new one.  For example:
 
 @smallexample
-if (i > 10 && j > i && j < 20)  /* branch(27 50 75) */
-                                /* branch(end) */
+if (i > 10 && j > i && j < 20)  /* @r{branch(27 50 75)} */
+                                /* @r{branch(end)} */
   foo (i, j);
 @end smallexample
 
index 625af4b62789efe20746f3d8eee956ace67ef162..81b664e1c9a4c51333c077998b460dc05132ab81 100644 (file)
@@ -849,7 +849,7 @@ checking the state of the option (documentation is elided for brevity).
 
 @smallexample
 [chip.c]
-char *chip_alu = ""; /* Specify default here.  */
+char *chip_alu = ""; /* @r{Specify default here.}  */
 
 [chip.h]
 extern char *chip_alu;
index cef4212c05de93d354893f3097c262c17c980cf4..6996e834fea807defd56cf3843abf202e22fc710 100644 (file)
@@ -938,14 +938,14 @@ tree            FOR_EACH_SSA_TREE_OPERAND
     @file{tree-ssa-operands.h}:
 
 @smallexample
-#define SSA_OP_USE              0x01    /* Real USE operands.  */
-#define SSA_OP_DEF              0x02    /* Real DEF operands.  */
-#define SSA_OP_VUSE             0x04    /* VUSE operands.  */
-#define SSA_OP_VMAYUSE          0x08    /* USE portion of V_MAY_DEFS.  */
-#define SSA_OP_VMAYDEF          0x10    /* DEF portion of V_MAY_DEFS.  */
-#define SSA_OP_VMUSTDEF         0x20    /* V_MUST_DEF definitions.  */
-
-/* These are commonly grouped operand flags.  */
+#define SSA_OP_USE              0x01    /* @r{Real USE operands.}  */
+#define SSA_OP_DEF              0x02    /* @r{Real DEF operands.}  */
+#define SSA_OP_VUSE             0x04    /* @r{VUSE operands.}  */
+#define SSA_OP_VMAYUSE          0x08    /* @r{USE portion of V_MAY_DEFS.}  */
+#define SSA_OP_VMAYDEF          0x10    /* @r{DEF portion of V_MAY_DEFS.}  */
+#define SSA_OP_VMUSTDEF         0x20    /* @r{V_MUST_DEF definitions.}  */
+
+/* @r{These are commonly grouped operand flags.}  */
 #define SSA_OP_VIRTUAL_USES     (SSA_OP_VUSE | SSA_OP_VMAYUSE)
 #define SSA_OP_VIRTUAL_DEFS     (SSA_OP_VMAYDEF | SSA_OP_VMUSTDEF)
 #define SSA_OP_ALL_USES         (SSA_OP_VIRTUAL_USES | SSA_OP_USE)