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 best solutions below
Related Questions in ASP.NET
- Create an IIS web request activity light
- Writing/Overwriting to specific XML file from ASP.NET code behind
- What is the point of definnig Asp.net Intrinsic Objects In different places and what is the different betwen them?
- Deleting Orphans with Fluent NHibernate
- IOrderedEnumerable to vb.net IOrderedEnumerable Conversion
- Entity Framework Code First with Fluent API Concurrency `DbUpdateConcurrencyException` Not Raising
- Getting deeply embedded XML element values
- What is best way to check if any of the property of object is null or empty?
- NuGet - Given a type name or a DLL, how can I find the NuGet package?
- ASP-MVC Code-first migrations checkbox not active
- How do i add onclient click to my jquery button
- Jquery: Change contents of <select> tag dynamically
- Retrieving data from Oracle database
- ASP.NET: Fill Textbox field upon dropdownlist selection by user
- Why web API return 404 when deploy to IIS
Related Questions in ASP.NET-WEB-API
- Implement Onfailure in webApi controller
- WebApi: Reading errors
- Why web API return 404 when deploy to IIS
- One Web API calls the other Web APIs
- colon(:) in url causes error in asp.net
- Make a per-web-application object available to Web API and SignalR controllers
- Using Azure MobileServices library with my own LAN WebApi
- redirect to actionResult method from an api
- How to catch postpack result to Web Api
- Exposing webapi to third party
- .net Web Api 2 Owin authentication token expires suddenly and often on IIS 8.5
- Can you use the same token in ADFS for 2 different relying parties?
- Does 'api/SomeEntity/ForOtherEntity/{otherEntityId}' break REST?
- Generic webAPI method based on parameter types of arrays
- Where can I find user identity when using webapi with Windows Authentication on IIS8
Related Questions in XML-DOCUMENTATION
- Creating XML document with Two root nodes
- A method's description doesn't show up in another class
- How to get into into another child than 'firstChild' of XML file in PHP?
- PHP XML DOC getElementsByTagName
- Web Api Help Page - Show only some controllers but no others
- WCF - Add service reference XML docs
- C#, How to make overload methods share <summary> tag
- VS2013 activity item code analysis and xml documentation will not compile
- .NET (VB) XML Comments - Code Examples in Summary
- How to put a line break in xmldoc comments
- C# : How to modify the structure of my xml?
- Only certain xmldoc tags are relevant for IntelliSense
- How to define programming language for the `<code>` element
- Documenting incomplete object graph of DTO object
- Conventions For Summary And Parameter Text?
Related Questions in ASP.NET-WEB-API-HELPPAGES
- Doesn't display field with array in object
- asp.net mvc web api help page not populating for given route
- WebApi HelpPage api detail page 404, when "api" prefix removed?
- Web API Help Page for method with Enum parameters
- Web Api - Auto generating request samples using ApiExplorer
- Web API Help pages - customizing Property documentation
- Web API Help Page emitting "An item with the same key has already been added"
- Extending webapi 2.1's help page to include additional data
- WebApi2 Help Page stops generating documentation after extending ApiController
- How to display parameter in Web API help page documentation for Response only?
- How to format/style ///<summary> in Web API 2
- Documenting descriptions on Complex Types
- "Access is denied" on build server when deploying Web API project with XML documentation
- WebApi documentation not recognizing endpoints
- ASP.Net web API Help Page - no content
Related Questions in MAML
- Heisenberg was here: Aliases for PowerShell parameters only appear in cmdlet help when you do NOT document the cmdlet
- Links to other terms within a term definition in Sandcastle
- Is it possible to create MAML only documentation
- Is this the process of meta-learning MAML for inner loop and outer loop training?
- MAML (Powershell Help) XSD
- PowerShell MAML Help Generator
- SandCastle Help File Builder and MAML, how to have an ordered list with a different starting index?
- Is it possible to tag text as italics inside the code element using MAML
- Documenting extension methods with MAML
- Using MAML for conceptual documentation of library
- Sandcastle Help File Builder: HTML not being generated from MAML
- codeEntityReference linkText not working
- List all classes tagged with a specific (custom) tag in a sandcastle documentation
- Get-Help is not seeing the MAML help files when used against commands in my module
- When training with MAML and Siamese networks, I've encountered issues where the weights aren't updating or the accuracy remains unchanged
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)
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?