From: Dave Thomas <Dave@...>
Date: 2002-02-23T13:31:21+09:00
Subject: rdoc/xml questions


I'm wondering about having rdoc generate xml output, and have a couple
of questions.

1. Given the Ruby source

       # comment 1
       class A
          # comment 2
          class B
          end
       end

   how should the corresponding XML be generated in terms of
   nesting. Logically, you might want to see

      <class name="A">
         <class name="A::B">
           <description>
             comment 2
           </description>
         </class>
         <description>
           comment 1
         </description>
       </class>

   However, it might also make sense in terms of processing to instead
   have

      <class name="A">
         <description>
           comment 1
         </description>
       </class>

       <class name="A::B">
         <description>
           comment 2
         </description>
       </class>

   What are the arguments either way.


2. For hyperlinking between things, should I use my own tags, or are there
   benefits to using xlink/xpointer?


Cheers


Dave