doxypress
doxypress copied to clipboard
C# verbatim string misinterpreted as documentation command
It appears that having a C# verbatim string (string literal prefixed with @
) in a method before the documentation of a property leads to the text in the string being included in the name of the property in the docs.
Example code:
public class Test
{
/// <summary>Test method</summary>
/// <returns>a string</returns>
public static string Bar()
{
return new string(@"Ratione dolores qui voluptatem. Sunt facere dignissimos quod est odit. Omnis ipsum quos possimus quis aut. Voluptatem dolorem ut minima magnam aut modi.");
}
/// <summary>A property</summary>
/// <value>a number</value>
public static int Foo
{
get {return 3;}
}
}
This code documents as:
First noticed in DoxyPress 1.2.5
Workaround for those interested: use a preprocessor block with a predfine in DoxyPress.
Example: #if !DOX_IGNORE
followed by #endif
around the line with the offending string with DOX_IGNORE
added to DoxyPress's predefined macros in Build Settings -> Preprocessor.