GNOME Bugzilla – Bug 666527
"inheritdoc" Not Recognized in XML Style Documentation
Last modified: 2017-04-30 08:52:45 UTC
Created attachment 203880 [details] Example code showing problem with "<inheritdoc/>" When using XML style special commands (i.e. when developing in MS Visual Studio), the "inheritdoc" command is not recognized. If it is used as regular Doxygen special command (e.g. "@inheritdoc"), it is recognized. More specifically, the following forms will result in Doxygen reporting "warning: Unsupported xml/html tag <inheritdoc> found" /// <inheritdoc/> /// <inheritdoc /> The following will work as expected /// @inheritdoc Example code illustrating the problem is attached.
The <inheritdoc> tag is not a valid C# XML comment as far as I know. Can you point at a specification where it is explained?
It's used by NDoc and GhostDoc. Here are a couple of references. - http://stackoverflow.com/questions/311363/net-xml-docs-inheriting-documentation - http://stackoverflow.com/questions/824007/ways-to-synchronize-interface-and-implementation-comments-in-c-sharp - http://www.ewoodruff.us/shfbdocs/html/79897974-ffc9-4b84-91a5-e50c66a0221d.htm
Not as much a comment as a question: Why did this go to Unconfirmed? The use of "<inheritdoc />" in C# comments is documented in other places. NUnit doesn't support it, but does support "/// @inheritdoc".
Created attachment 208582 [details] [review] Patch to add <inheritdoc /> support to Doxygen This patch was created for 1.7.6 and then successfully applied to our local build 1.7.5. It adds support to for using "inheritdoc" as an XML tag (<inheritdoc />).
Thanks, I'll include the patch in the next subversion update.
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.8.1. Please verify if this is indeed the case. Reopen the bug if you think it is not fixed and please include any additional information that you think can be relevant.