[Xapian-tickets] [Xapian] #736: Better Doxygen API doc options

[Xapian]

#736: Better Doxygen API doc options
----------------------------------+-------------------
        Reporter:  james          |      Owner:  olly
            Type:  defect         |     Status:  new
        Priority:  high           |  Milestone:  1.4.1
       Component:  Documentation  |    Version:  1.4.0
        Severity:  major          |   Keywords:
      Blocked By:                 |   Blocking:
Operating System:  All            |
----------------------------------+-------------------
 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.

--
Ticket URL: <https://trac.xapian.org/ticket/736>
Xapian <//xapian.org/>
Xapian