The "Documentation" property in the ApiDescription and ApiParameterDescription should be expanded to include more XmlComment tags than just "<summary>".
Specifically, it should at least include the <example> tag (with valid sub tags such as <code>), the <exception> tag and the <list> tag.
That way we can actually do the documentation in code and use the HelpPage feature (which is a very good idea) for real world scenarios.
If you feel like it, please also implement these tags <example> and <exception> in the out of the box UI :-)
Morten Petteroe
Comments: And <returns>. Your blog post is great, Yao, but it's also now incompatible with the latest version of the Web API Help pages in Visual Studio 2013 Preview. Some improvements in documentation support out-of-the-box would indeed be welcome.
Specifically, it should at least include the <example> tag (with valid sub tags such as <code>), the <exception> tag and the <list> tag.
That way we can actually do the documentation in code and use the HelpPage feature (which is a very good idea) for real world scenarios.
If you feel like it, please also implement these tags <example> and <exception> in the out of the box UI :-)
Morten Petteroe
Comments: And <returns>. Your blog post is great, Yao, but it's also now incompatible with the latest version of the Web API Help pages in Visual Studio 2013 Preview. Some improvements in documentation support out-of-the-box would indeed be welcome.