[prev in list] [next in list] [prev in thread] [next in thread] 

List:       ruby-core
Subject:    Re: RDoc parse_c.rb for C ext libs consisting of many *.c files
From:       sheepman <sheepman () tcn ! zaq ! ne ! jp>
Date:       2005-01-29 15:13:38
Message-ID: 20050130001326.227bf6d3.sheepman () tcn ! zaq ! ne ! jp
[Download RAW message or body]


Hi,

On Sat, 29 Jan 2005 05:16:05 +0900
Charles Mills <cmills@freeshell.org> wrote:

> 
> This functionality would be very nice.  Is this patch sensitive to the 
> order files are scanned?  For example if I have 3 files module.c, 
> class1.c and class2.c.  Where Class1 and Class2 are inner classes of 
> Module would module.c have to be scanned first?
> 
> -Charlie

Yes. Sorry, I missed that. But it works well for ext/openssl by chance.
To solve this problem, rdoc should sort files alphabetically and then parse them. 
By doing this, the definition of an outer module that might be commented out with /* */ 
would be needed only in the first scanned file. 

Index: rdoc.rb
===================================================================
RCS file: /src/ruby/lib/rdoc/rdoc.rb,v
retrieving revision 1.9
diff -u -1 -r1.9 rdoc.rb
--- rdoc.rb     12 Dec 2004 01:15:10 -0000      1.9
+++ rdoc.rb     29 Jan 2005 15:09:12 -0000
@@ -184,3 +184,3 @@
     def list_files_in_directory(dir, options)
-      normalized_file_list(options, Dir.glob(File.join(dir, "*")), false, options.exclude)
+      normalized_file_list(options, Dir.glob(File.join(dir, "*")).sort, false, options.exclude)
     end

Or, is it better that files are sorted just by hand and given to rdoc? 

  $ rdoc --op /tmp/openssl ext/openssl/ossl.c ext/openssl/

I am not sure which is better.

Regards,

-- 
sheepman / TAMURA Takashi
sheepman@tcn.zaq.ne.jp http://sheepman.parfait.ne.jp/

[prev in list] [next in list] [prev in thread] [next in thread]