From: ts <decoux@...>
Date: 2002-02-11T00:51:33+09:00
Subject: Re: Ruby Embedded Documentation

>>>>> "D" == Dave Thomas <Dave@PragmaticProgrammer.com> writes:

D> If you mean in the comments, then it automatically hyperlinks the
D> #form, but currently not the ::form. Do you want me to add the ::form
D> too? 

 Yes, I use the 2 sometimes in my latest example of bdb

pigeon% more examples/replication/mc.rb
#!/usr/bin/ruby
$LOAD_PATH.unshift "../../src"

require 'bdb'
require 'mutex_m'
require 'socket'

module BDB
   class MC < Env
      extend Mutex_m

      ENVID = 1

      attr_accessor :sites, :priority, :timeout

      def self.new(home = nil, sites = 4, pri = 10, timeout = 2000000)
         super(home, BDB::THREAD | BDB::CREATE | BDB::INIT_TRANSACTION,
               "set_verb_replication" => 1, 
               "specific" => [sites, pri, timeout]) 
      end

      def initialize(*args)
         @sites, @priority, @timeout = *args[-1]["specific"]
         @mach = {}
      end
[...]
pigeon%

D> In terms of documenting extensions: that's on my list of things to
D> do. Clearly I can extract out all the rb_defines: the issue is
D> associating fuller documentation with each. I'm not sure how to do
D> that.

 Never expect that I'll put documentation, or comments, in my C sources
 because if one day I do this these comments will be written in french. I
 don't speak this strange language that you call english. But I can write
 (try to write) a separate documentation, like I do actually with rd

 Sorry,



Guy Decoux