New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"inheritdoc" Not Recognized in XML Style Documentation (Origin: bugzilla #666527) #4508

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component documentation for ---
Reported in version 1.7.6.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2011-12-19 14:40:51 +0000, John Werner wrote:

Created attachment 203880
Example code showing problem with ""

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 found"

///
///

The following will work as expected

/// @inheritdoc

Example code illustrating the problem is attached.

On 2011-12-26 14:06:47 +0000, Dimitri van Heesch wrote:

The tag is not a valid C# XML comment as far as I know. Can you point at a specification where it is explained?

On 2011-12-29 17:56:14 +0000, John Werner wrote:

It's used by NDoc and GhostDoc. Here are a couple of references.

On 2012-02-03 13:30:03 +0000, John Werner wrote:

Not as much a comment as a question:

Why did this go to Unconfirmed? The use of "" in C# comments is documented in other places. NUnit doesn't support it, but does support "/// @inheritdoc".

On 2012-02-28 13:42:15 +0000, John Werner wrote:

Created attachment 208582
Patch to add 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 ().

On 2012-03-03 15:42:43 +0000, Dimitri van Heesch wrote:

Thanks, I'll include the patch in the next subversion update.

On 2012-05-19 12:26:43 +0000, Dimitri van Heesch wrote:

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.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment