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

[Xapian]

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

  * milestone:  1.1.4 => 1.0.18


Old description:

> There is incomplete rdoc there
> http://xapian.org/docs/bindings/ruby/rdocs/
>
> For example no description of WritableDatabase or TermGenerator classes.
>
> Also 404 error on the top left frame:
>
> Not Found The requested URL
> /docs/bindings/ruby/rdocs/files/data/home/olly/tmp/xapian-svn-
> snapshot/tags/1_0_17/xapian/xapian-bindings/ruby/docs/__/xapian_rb.html
> was not found on this server.

New description:

 There is incomplete rdoc there http://xapian.org/docs/bindings/ruby/rdocs/

 For example no description of !WritableDatabase or !TermGenerator classes.

 Also 404 error on the top left frame:

 {{{
 Not Found The requested URL
 /docs/bindings/ruby/rdocs/files/data/home/olly/tmp/xapian-svn-
 snapshot/tags/1_0_17/xapian/xapian-bindings/ruby/docs/__/xapian_rb.html
 was not found on this server.
 }}}

--

Comment:

 I've added a script to generate entries for all classes which don't
 otherwise have them, committed to trunk as r13748.  These just refer the
 user to the appropriate page of the C++ API documentation, which is much
 better than the current state.  Once we get SWIG's doxygen comment
 translator straightened out, we can do better than this.

 Marking for backporting (both r13712 and r13748) to 1.0.18.

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