Opened 15 years ago

Closed 15 years ago

#417 closed defect (fixed)

ruby rdoc is incomplete on the site

Reported by: Do Owned by: Olly Betts
Priority: normal Milestone: 1.0.18
Component: Xapian-bindings Version: 1.0.17
Severity: normal Keywords:
Cc: Blocked By:
Blocking: Operating System: All

Description (last modified by Olly Betts)

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.

Change History (4)

comment:1 by Olly Betts, 15 years ago

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...

comment:2 by Olly Betts, 15 years ago

Milestone: 1.1.4
Status: newassigned

The path issue seems to be fixed on trunk by r13712.

comment:3 by Olly Betts, 15 years ago

Description: modified (diff)
Milestone: 1.1.41.0.18

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.

comment:4 by Olly Betts, 15 years ago

Resolution: fixed
Status: assignedclosed

Fix backported for 1.0 as r13770.

I'll update the docs once the snapshot has generated with this in.

Note: See TracTickets for help on using tickets.