Opened 8 years ago
Closed 4 years ago
#706 closed enhancement (fixed)
Use doxygen @since?
| Reported by: | Olly Betts | Owned by: | Olly Betts |
|---|---|---|---|
| Priority: | normal | Milestone: | 1.5.0 |
| Component: | Documentation | Version: | git master |
| Severity: | normal | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Operating System: | All |
Description (last modified by )
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.
Change History (2)
comment:1 by , 4 years ago
| Description: | modified (diff) |
|---|
comment:2 by , 4 years ago
| Milestone: | 1.4.x → 1.5.0 |
|---|---|
| Resolution: | → fixed |
| Status: | new → closed |
Note:
See TracTickets
for help on using tickets.
We have since started using this, and I've pushed 7d855bdc48f427a2b30a2aee6cb50cb95ff13716 to update all the places where we ought to be but aren't in xapian-core for git master. I don't think this is worth the effort to backport as it's cosmetic.
I've noticed that it isn't properly supported for individual enum values (reported upstream as https://github.com/doxygen/doxygen/issues/7836) which is another reason not to worry about backporting.