CODEWITHSUNDEEP
doxygendeprecated
Dru Freeman
Dru Freeman

Reputation: 1826

Doxygen: Creating a specialised page

I finally figured out how to use deprecated to mark functions as going away. What I'd like to generate is an additional page listed on "Related Pages" (much like GENERATE_DEPRECATED does) that allows me to list APIs that have changed.

If we pull a function say doFoo(int,SOMECLASS)

in place of doFoo(uInt_64, SOMECLASS, &errInstance)

What I'd like is a way to have a page that I can put

Changed:

doFoo(int, SOMECLASS) removed: Use doFoo(uInt, SOMECLASS, &errInstance)

To make matters worse; I'm not sure how to do this without actually reenabling the old call in the header despite the fact that it's now been removed.

Suggestions welcomed.

Upvotes: 2

Views: 794

Answers (2)

doxygen
doxygen

Reputation: 14859

Look at the \xrefitem command in combination with an ALIAS definition if you want to define your own command (such as \change) that behaves like \deprecated.

See http://www.doxygen.nl/manual/commands.html#cmdxrefitem for more info.

Upvotes: 1

Eric Farr
Eric Farr

Reputation: 2713

For stuff like that, I create a file that is one big comment with text and code blocks:

/*! 
\page changed Changed

<b>Changed:</b>

/code
doFoo(int, SOMECLASS) removed: Use doFoo(uInt, SOMECLASS, &errInstance)
/endcode

*/

Upvotes: 0

Related Questions