[Xapian-tickets] [Xapian] #706: Use doxygen @since?

Xapian nobody at xapian.org
Mon Jun 8 01:47:37 BST 2020


#706: Use doxygen @since?
---------------------------+-------------------------------
 Reporter:  Olly Betts     |             Owner:  Olly Betts
     Type:  enhancement    |            Status:  new
 Priority:  normal         |         Milestone:  1.4.x
Component:  Documentation  |           Version:  git master
 Severity:  normal         |        Resolution:
 Keywords:                 |        Blocked By:
 Blocking:                 |  Operating System:  All
---------------------------+-------------------------------
Description changed by Olly Betts:

Old description:

> I noticed doxygen has a way to specify the version since which something
> is supported:
>
> http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdsince
>
> (We prefer to use `@foo` to `\foo` as the latter looks confusingly like a
> C escape sequence...)
>
> We should try this out, and switch to using it if it looks better than
> just having a normal paragraph in the description.

New description:

 I noticed doxygen has a way to specify the version since which something
 is supported:

 https://www.doxygen.nl/manual/commands.html#cmdsince

 (We prefer to use `@foo` to `\foo` as the latter looks confusingly like a
 C escape sequence...)

 We should try this out, and switch to using it if it looks better than
 just having a normal paragraph in the description.

--
-- 
Ticket URL: <https://trac.xapian.org/ticket/706#comment:1>
Xapian <https://xapian.org/>
Xapian


More information about the Xapian-tickets mailing list