Opened 8 years ago

Closed 8 years ago

#736 closed defect (fixed)

Better Doxygen API doc options

Reported by: James Aylett Owned by: Olly Betts
Priority: high Milestone: 1.4.1
Component: Documentation Version: 1.4.0
Severity: major Keywords:
Cc: Blocked By:
Blocking: Operating System: All

Description

Right now our API docs don't include undocumented members, which includes enum members, methods &c. The best solution I've found so far is to set HIDE_UNDOC_MEMBERS to NO (in xapian-core/docs/doxygen_api.conf.in), but it includes things like this:

    template<typename I >
    	Query (op op_, I begin, I end, Xapian::termcount window=0)

which we may or may not actually want presented in that fashion. It's certainly better than what we have at the moment, which (for instance) only lists one of the available Query operators. This affects the website as well (which needs its apidocs regenerating anyway, since thyestes has a more recent version of doxygen which I believe will sort class names more helpfully).

Suggesting to target for 1.4.1, since people have already been thrown by this.

Change History (2)

comment:1 by Olly Betts, 8 years ago

Status: newassigned

Set HIDE_UNDOC_MEMBERS=NO and HIDE_UNDOC_CLASSES=NO in master in [a504845ef75a15dc61ede7c5c0624dae05cc8512/git], and also added doxygen comments for everything which was missing it in a few commits leading up to that.

Needs backporting to 1.4.x. I don't think it's worth the effort to backport the relevant doxygen comment additions to 1.2.x - so much has changed, and active development should be targetting 1.4.x now anyway, but we could change the two settings there I guess.

comment:2 by Olly Betts, 8 years ago

Resolution: fixed
Status: assignedclosed
Note: See TracTickets for help on using tickets.