From: Tobias Peters <tpeters@...>
Date: 2003-09-08T21:58:17+09:00
Subject: Re: ANN: MetaTags 1.0

Ryan Pavlik wrote:
>       method_info <<-DOC
>         !Method:   initialize
>         !Title:    Initialize
>         !Category: constructors
>     
>         !Desc: Create a new MyClass object giving optional defaults
>                for "a" and "b".
>     
>         !Parameters:
>            * a: A: The "a" object; defaults to 5
>            * b: B
>     
>         !param_flag b: width=80
>       DOC
>       def initialize(a, b)
>         :
>       end

I'd rather like
   method_info <<-DOC
     Create a new MyClass object giving optional defaults
     for "a" and "b".

     Category: constructors
     Parameters:
       * a: A: The "a" object; defaults to 5
       * b: B
   DOC
   def initialize(a=5,b=B.new) ... end

I.e. less punctuation, make your "Desc:" tag the default, get method 
name by overiding method_added

Or, maybe
   doc('Create a new MyClass object giving optional defaults ',
       'for "a" and "b"',
       :category, 'constructors',
       :parameters,
       :a, 'A: The "a" object; defaults to 5',
       :b, 'B')
   def initialize(a=5,b=B.new)

-- 
   Tobias
(email-address is anti-spammed, remove invalid parts)