CODEWITHSUNDEEP
windowsdoxygen
Bojan Hrnkas
Bojan Hrnkas

Reputation: 1694

Custom XML Tags with Doxygen

In reference to this solution: Custom tags with Doxygen

It seems this does not work if I use XML (c#) style for documenting. I tried to add a "change" tag:

ALIASES = "change=\xrefitem change \"Change\" \"Changes\""

However, when I use it in my documentation:

<change>Bojan Hrnkas, 14.08.2012: Optimized performance.</change>

The HTML Output looks like this:

<change>Bojan Hrnkas, 14.08.2012: Optimized performance.</change>

Is there a way to implement aliases for xml tags?

Upvotes: 4

Views: 2063

Answers (2)

Chris
Chris

Reputation: 46326

One way to achieve this is to use the INPUT_FILTER configuration file option to replace custom XML commands with an alias. For example, defining 

ALIASES = "change=\xrefitem change \"Change\" \"Changes\""

we could use INPUT_FILTER to find and replace

<change>Text</change>

with 

\change Text

From this SO question one could use sed to perform this transformation using something along the lines of

sed 's/<change>\(.*\)<\/change>/\1/'

Upvotes: 2

Bojan Hrnkas
Bojan Hrnkas

Reputation: 1694

I could confirm that custom tags are not supported when using XML-Style documentation. My solution was to mix two styles, so now I have <summary> along with @change{}. Not very nice, but it works.

Upvotes: 0

Related Questions