Quantcast
Channel: ASPNETWebStack Issue Tracker Rss Feed
Viewing all articles
Browse latest Browse all 7215

Closed Issue: ApiExplorer does not generate documentation correctly [385]

$
0
0
When I have following method - I'm getting "No documentation available."

/// <summary>
/// Get Reynaers dealers from a market
/// </summary>
/// <param name="marketcode">Market code representing a world region</param>
/// <param name="page">Optional parameter - default value = 1, request a specific page of the total resultlist of dealers</param>
/// <param name="pagesize">Optional parameter - default value = 5, set the size of the amount of dealers returned in the resultlist of dealers</param>
/// <returns>
/// Response object containing total amount of results and a list of dealers
/// Sorted on Dealer name ascending
/// </returns>
/// <example>
/// ../api/v*/Dealers?marketcode=0008
/// ../api/v*/Dealers?marketcode=0008&page=2&pagesize=4
/// </example>
public Response Get(string marketcode, int page = 1, int pagesize = 5)

But when I leave out the <example> part, it works!

Although on another method, this does work! ( so with <example> tag )

/// <summary>
/// Get a specific Reynaers dealer
/// </summary>
/// <param name="id">Unique identifier for the requested dealer</param>
/// <returns>A dealer or nothing</returns>
/// <example>
/// ../api/v*/dealers/34296
/// </example>
public DealerDTO Get(int id)

> Any idea?
Comments: Per Kiran's investigation, we should make sure xml doc is valid here.

Viewing all articles
Browse latest Browse all 7215

Trending Articles