search

Samsung / Dexter

Dexter is a static analysis platform to find and remove defects efficiently and immediately during the coding-time.
BSD 2-Clause "Simplified" License
56 stars 33 forks source link

Add diagnostic alayzer for doxygen comment of public API #166

Closed mdopark closed 6 years ago

mdopark commented 7 years ago
KarolAntczak commented 7 years ago

This does not look like analyzer for Doxygen comments but rather for XML Documentation Comments. These are two distinct technologies.

XML Documentation Comments looks like this: 

/// <summary>
/// This is a summary.
/// </summary>

And this is Doxygen comment: 

    /**
    * Constructor that sets the time to a given value.
    *
    * @param timemillis Number of milliseconds.
    */
mdopark commented 7 years ago

@KarolAntczak Doxygen supports several comment forms. The xml document form is one of them. Actually Platz is getting the API comment information from the cs file by running the doxygen program.