Create custom doxygen command to manage deprecated and removed functions
Closed, ResolvedPublic
Actions

Assigned To

None

Authored By

	• goch
	Sep 12 2012, 12:15 PM

Description

It is desirable to be able to group deprecated and removed functions by their status (deprecated/removed) and the date of the release where they achieve this status.

A promising candidate for this kind of aliasing is
http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem

Event Timeline

• goch added projects: MITK, Bugzilla.Sep 12 2012, 12:15 PM

First attempt as an alias was

"deprecatedSince{1}=\xrefitem deprecatedSince\1 \" Deprecated as of \1\" \"Functions deprecated as of \1\" "

Usage \deprecatedSince{ONE_WORD} Some Text
This will result in:

A related page called "Functions deprecated as of ONE_WORD" containing the members
An addition to the member documentation at their class
They will not appear in the global Deprecated list, unless \deprecated is used explicitly

A deprecated as of page

Same documentation in a class

Would this be an acceptable way to manage deprecated/removed functions or are there other requirements?

See branch
bug-13081-create-deprecated-since-version-alias
for details

[457cbf]: Merge branch 'bug-13081-create-deprecated-since-version-alias'

Merged commits:

2012-09-18 14:56:34 Caspar Goch [2f0e9a]
Tell doxygen how to handle the deprecated macro

2012-09-18 12:57:23 Caspar Goch [6f23a4]
Added new alias for deprecated functions

kislinsk edited projects, added MITK (2012-09); removed MITK.Aug 1 2016, 10:48 PM

	F894: ClassPage.png
	Sep 12 2012, 3:56 PM

	F893: singlePage.png
	Sep 12 2012, 3:56 PM

	F892: relPa.png
	Sep 12 2012, 3:55 PM

Create custom doxygen command to manage deprecated and removed functionsClosed, ResolvedPublicActions

Description

Event Timeline

Merged commits:

Create custom doxygen command to manage deprecated and removed functions
Closed, ResolvedPublic
Actions