Re: [ ruby-Patches-7499 ] RDoc patch that fixes rb_const_define output

On Dec 30, 2006, at 19:16, Daniel Berger wrote:
> On 12/30/06, Eric Hodel <[e-mail]> wrote:
>
> <snip>
>
>> Does the input end up being:
>>
>> /* value: 300 The perfect score in bowling */
>> rb_define_const(...);
>>
>> ?
>>
>> Can the value derictive be ":value: 300" to match the rest of the
>> RDoc directives?
>
> No, I didn't mean to imply that I was using "value" as a literal tag.
> The input line would just be:
>
> /* 300: The perfect score in bowling */
>
> Take a look at the file I attached (on RubyForge) - that has a pretty
> good selection of examples I think.

Oh! sorry, I didn't read closely enough.

> It doesn't have to be that exact syntax, obviously, but I thought that
> was pretty straightforward.  I'd rather not do literal tags for what
> will likely just be one line comments in the majority of cases.
>
> On a side note, I've noticed that multiline comments for constants
> don't format properly (with or without my patch) - they seem to indent
> on the newline.  But, I'll worry about that in another patch. :)

Like this?

It could possibly be made cleaner, I am tired.

Index: lib/rdoc/parsers/parse_c.rb
===================================================================
--- lib/rdoc/parsers/parse_c.rb (revision 11436)
+++ lib/rdoc/parsers/parse_c.rb (working copy)
@@ -444,7 +446,30 @@

        comment = find_const_comment(type, const_name)
-      con = Constant.new(const_name, definition, mangle_comment 
(comment))
+      # In the case of rb_define_const, the definition and comment  
are in
+      # "/* definition: comment */" form.  The literal ':' and '\'  
characters
+      # can be escaped with a backslash.
+      if type.downcase == 'const' then
+         elements = mangle_comment(comment).split(':')
+         if elements.nil? or elements.empty? then
+            con = Constant.new(const_name, definition, mangle_comment 
(comment))
+         else
+            new_definition = elements[0..-2].join(':')
+            if new_definition.empty? then # Default to literal C  
definition
+               new_definition = definition
+            else
+               new_definition.gsub!("\:", ":")
+               new_definition.gsub!("\\", '\\')
+            end
+            new_definition.sub!(/\A(\s+)/, '')
+            new_comment = $1.nil? ? elements.last : "#{$1}# 
{elements.last.lstrip}"
+            con = Constant.new(const_name, new_definition,
+                               mangle_comment(new_comment))
+         end
+      else
+         con = Constant.new(const_name, definition, mangle_comment 
(comment))
+      end
+
        class_obj.add_constant(con)
      end

-- 
Eric Hodel - [e-mail] - http://blog.segment7.net

I LIT YOUR GEM ON FIRE!