[Xapian-tickets] [Xapian] #417: ruby rdoc is incomplete on the site

Xapian nobody at xapian.org
Sun Dec 6 03:56:04 GMT 2009


#417: ruby rdoc is incomplete on the site
-----------------------------+----------------------------------------------
 Reporter:  do               |       Owner:  olly  
     Type:  defect           |      Status:  new   
 Priority:  normal           |   Milestone:        
Component:  Xapian-bindings  |     Version:  1.0.17
 Severity:  normal           |    Keywords:        
Blockedby:                   |    Platform:  All   
 Blocking:                   |  
-----------------------------+----------------------------------------------

Comment(by olly):

 The rdocs only currently document the '''extra''' features, not those
 automatically wrapped from the C++ API, as is documented here:

 http://xapian.org/docs/bindings/ruby/

 > The C++ methods are not yet documented in the RDocs. In the meantime,
 refer to the C++ API documentation for information on how to use the
 various methods. Most are available directly in the Ruby version. The
 RDocs currently provide information only on methods that are unique to the
 Ruby version.

 So !WritableDatabase and !TermGenerator aren't there as they have no such
 extra features.

 I'm not sure what is going on with that filename.  I'll take a look,
 though I don't know much about rdoc...

-- 
Ticket URL: <http://trac.xapian.org/ticket/417#comment:1>
Xapian <http://xapian.org/>
Xapian



More information about the Xapian-tickets mailing list