Opened 17 years ago

Closed 13 years ago

#262 closed enhancement (fixed)

doxygen -xml should be created by python bindings build system

Reported by: Richard Boulton Owned by: Richard Boulton
Priority: high Milestone: 1.3.0
Component: Xapian-bindings (Python) Version: SVN trunk
Severity: normal Keywords:
Cc: Blocked By:
Blocking: Operating System: All

Description

Currently, the doxygen rules for the API documentation in the main build are called with "--xml" to generate xml output as a side effect, and this is later used by the python bindings to generate the documentation comments file.

Instead, it would be much cleaner for the python bindings build system to call doxygen itself, to generate the xml output when it's needed.

Change History (8)

comment:1 by Olly Betts, 16 years ago

Or perhaps we just wait for the swig doxygen stuff to get merged and use that?

comment:2 by Richard Boulton, 16 years ago

That sounds like a reasonable approach, if it's going to be merged in the reasonably near future (which it sounds like it might).

comment:3 by Olly Betts, 16 years ago

Milestone: 1.1.1
Type: taskenhancement

Sadly I've heard nothing more from the person who wanted to pick up the work on the swig doxygen stuff.

I'm guessing this is probably a fairly easy change, so adding milestone:1.1.1 so we don't fail to remember to consider it. I'm happy to leave it if the effort doesn't seem worthwhile though.

comment:4 by Olly Betts, 16 years ago

Milestone: 1.1.11.1.7

Triaging milestone:1.1.1 bugs.

comment:5 by Olly Betts, 15 years ago

Milestone: 1.1.71.2.0

Be nice to clean this up, but it can easily wait.

comment:6 by Olly Betts, 15 years ago

Priority: normalhigh

Richard mentioned wanting to get this done on IRC, and it should be fairly easy, so priority -> high.

comment:7 by Olly Betts, 15 years ago

Component: Xapian-bindingsXapian-bindings (Python)

comment:8 by Olly Betts, 13 years ago

Milestone: 1.2.x1.3.0
Resolution: fixed
Status: newclosed

Fixed in r15936 (bindings) and r15937 (core).

The ruby bindings also use this XML, so I put it at the top level of the bindings build system.

Note: See TracTickets for help on using tickets.