I am trying to build API documentation for a RESTful web service using Microsoft ASP.NET Web API 2.2 Help Page 5.2.3. It looks like the contents of the <summary> and <param> elements get included in the documentation, but the <remarks> section is totally ignored, and where I would expect the description of <returns>, I see a duplicate of <summary>. I could not find any article explaining which XML comment tags Help Page supports (or how commenting controllers is different from commenting regular code). I am wondering if someone could share any pointers, in particular, which tags can be used, how to reference other pages, etc.
Which XML comment tags Microsoft ASP.NET Web API Help Page should I use on a controller methods?
372 views Asked by Alek Davis At
0
There are 0 answers
Related Questions in ASP.NET
- Implementing Azure AD B2C Authentication in .NET 8 Blazor Project (RenderMode: InteractiveAuto)
- Azure Application Insights Not Displaying Custom Logs for Azure Functions with .NET 8
- IIS Rewrite Module exclude bots but allow GoogleBot
- Angular 16 sending null values to API
- I am the domain admin, newbie, how do I connect youtube.com on my domain?
- Dropdown list showing SQLServer2005SQLBrowserUser$DONSERVER instead of Active Directory group name in ASP.NET MVC C#
- ASP.NET Identity, Losing Ability to Login until Application Pool Recycles
- How to unprotect ASP.NET FormAuthentication cookie
- How does it work using ASP.NET FormAuthentication
- What is the purpose of a completely standalone 'this'?
- Is there a way to read .csproj PropertyGroup variable in c#
- MSBuild trying to copy different dll with similar name into project sporadically
- Minimizing IdentityServer4 Round Trips in Microservice Architecture with Ocelot
- Azure AD guest account in web app authentication user claims data
- Receiving 400 bad request on post when customer auth handler is used
Related Questions in ASP.NET-WEB-API
- Log to Dynatrace using Serilog and web.config .NET Framework API
- How to create a REST API with .NET Framework?
- ASP.NET Core Background task with service container
- App gateway closing connection after 100 requests
- Web API works with Windows authentication enabled when consumed via Swagger but throws an unauthorized issue when accessed through web app
- The 'GetUriByAction' method in the LinkGenerator class in Asp.Net Core is not defined in the Repository layer of the project
- Entity Tracking Conflict when Authenticating Users in ASP.NET Core API
- Class validation on response body in .NET WebApi
- My ASP.NET server does not work and I am wondering what's missing, when I open Swagger, I get error 500
- How to split Serilog log file into multiple files?
- Response payload is not odata payload
- How can I upload picture
- Web Forms aspx - PostAsync Web API
- do you know any free reporting services like devexpress or boldreports?
- WebAPI don't deserialize JSON but same payload works in Swagger
Related Questions in XML-DOCUMENTATION
- Doxygen cref doesn't work without full namespace (even for classes in same namespace)
- What is the simplest way to add XML documentation to Swagger?
- Error building PostgreSQL documentation on macOS
- Regex substitution for variable number of capturing groups | Mass XML doc editing in Visual Studio
- Does RAD Studio (Delphi) support inheritdoc tag?
- Interface Inhertiance - override documenation
- How to update XML file using xmldoc
- Maven plugin plugin descriptor goal does not generate mojo description documentation when using annotations
- Is it possible to describe derived params in xml summary document?
- How do I include summaries of complex types in swagger ui?
- MSVC compiler : /doc option with multiple source files?
- No XML documentation / IntelliSense for WPF
- Is it possible to define links to other files in Visual Studio?
- How to refer to class properties in XML docs C#?
- C# XML documentation: dynamic generation of ID Strings?
Related Questions in ASP.NET-WEB-API-HELPPAGES
- How to format/style ///<summary> in Web API 2
- Is there a way to generate static html pages with Microsoft.AspNet.WebApi.HelpPage?
- Web API Help Pages discover API but can't show API description page
- VS 2017 WebAPI Help Page - No Document Provided
- ApiExplorer not showing methods from controller with ParameterBindingAttribute
- WebApi HelpPage api detail page 404, when "api" prefix removed?
- asp.net mvc web api help page not populating for given route
- How to direct to help page on run time of Web API 2
- Exclude HelpPage from WebAPI C#
- Web API Help page with cross authentication identity from other site
- Error When Web API Help Tries to Deserialize Microsoft Azure AD Graph API Group
- Web API Help page doesn't show documentation of extended object
- ApiExplorer does not recognize route attributes with custom type
- How to ignore parameters in asp.net web api help page which are generated automatically from routing and from action
- Empty model property description on ASP.NET Web API Help Pages
Related Questions in MAML
- How to write non code documentation in sandcastle
- When training with MAML and Siamese networks, I've encountered issues where the weights aren't updating or the accuracy remains unchanged
- Is this the process of meta-learning MAML for inner loop and outer loop training?
- .Xml help doesn't display parameter placeholders in SYNTAX section
- Get-Help is not seeing the MAML help files when used against commands in my module
- How to group methods by region or some other grouping method for documentation?
- Links to other terms within a term definition in Sandcastle
- codeEntityReference linkText not working
- codeEntityReference to method on a Sandcastle developerHowToDocument
- Heisenberg was here: Aliases for PowerShell parameters only appear in cmdlet help when you do NOT document the cmdlet
- List all classes tagged with a specific (custom) tag in a sandcastle documentation
- Which XML comment tags Microsoft ASP.NET Web API Help Page should I use on a controller methods?
- Azure Active Directory Authentication Error in Azure Management Library
- Is it possible to tag text as italics inside the code element using MAML
- Is it possible to create MAML only documentation
Popular Questions
- How do I undo the most recent local commits in Git?
- How can I remove a specific item from an array in JavaScript?
- How do I delete a Git branch locally and remotely?
- Find all files containing a specific text (string) on Linux?
- How do I revert a Git repository to a previous commit?
- How do I create an HTML button that acts like a link?
- How do I check out a remote Git branch?
- How do I force "git pull" to overwrite local files?
- How do I list all files of a directory?
- How to check whether a string contains a substring in JavaScript?
- How do I redirect to another webpage?
- How can I iterate over rows in a Pandas DataFrame?
- How do I convert a String to an int in Java?
- Does Python have a string 'contains' substring method?
- How do I check if a string contains a specific word?
Popular Tags
Trending Questions
- UIImageView Frame Doesn't Reflect Constraints
- Is it possible to use adb commands to click on a view by finding its ID?
- How to create a new web character symbol recognizable by html/javascript?
- Why isn't my CSS3 animation smooth in Google Chrome (but very smooth on other browsers)?
- Heap Gives Page Fault
- Connect ffmpeg to Visual Studio 2008
- Both Object- and ValueAnimator jumps when Duration is set above API LvL 24
- How to avoid default initialization of objects in std::vector?
- second argument of the command line arguments in a format other than char** argv or char* argv[]
- How to improve efficiency of algorithm which generates next lexicographic permutation?
- Navigating to the another actvity app getting crash in android
- How to read the particular message format in android and store in sqlite database?
- Resetting inventory status after order is cancelled
- Efficiently compute powers of X in SSE/AVX
- Insert into an external database using ajax and php : POST 500 (Internal Server Error)