xml-documentation

Enhance Vonage .NET SDK XML documentation with OpenAPI constraints and code examples.

119|88|Updated Mar 27, 2015
One-click install
npx skills add https://github.com/Vonage/vonage-dotnet-sdk --skill xml-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: xml-documentation
Source: https://github.com/Vonage/vonage-dotnet-sdk/tree/main/.claude/skills/xml-documentation
Command: npx skills add https://github.com/Vonage/vonage-dotnet-sdk --skill xml-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill improves the XML documentation for the Vonage .NET SDK, making it easier for developers to understand and use the SDK through IntelliSense.

Core Features & Use Cases

  • IntelliSense Summaries: Provides clear and concise descriptions for public classes, methods, and properties.
  • OAS-Based Constraints: Incorporates constraints and formats from the OpenAPI Specification (OAS) for accurate property details.
  • Code Examples: Includes examples for key methods to demonstrate usage.
  • Builder Struct Documentation: Documents builder structures using custom source generators for better developer experience.

Quick Start

Use the xml-documentation skill to improve the XML documentation for the 'Messages' API.

Frequently Asked Questions about xml-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate XML documentation for a .NET SDK using OpenAPI specifications?

You can generate XML documentation for a .NET SDK by integrating OpenAPI specifications to extract constraints and formats. This approach provides accurate property details and enhances IntelliSense summaries for public classes and methods.

How do I add IntelliSense summaries for C# public classes and methods?

To add IntelliSense summaries for C# public classes and methods, you enhance the XML documentation by targeting public members specifically. This process excludes private and internal members to ensure developers only see relevant API surface details.

Does XML documentation generation work with C# records and enums?

Yes, XML documentation generation works with C# records and enums. The process explicitly targets public classes, interfaces, enums, records, properties, and methods while excluding private and internal members from the documentation output.

How do I document builder structures in a C# SDK?

You document builder structures in a C# SDK by using custom source generators to document the builder patterns. This method provides a better developer experience by clearly explaining how to construct complex SDK objects.

How do I include code examples in C# XML documentation for API methods?

To include code examples in C# XML documentation, you integrate them directly into the XML docs for key methods. This demonstrates proper usage of the SDK and helps developers understand how to implement the API effectively.

Can I use OpenAPI constraints to improve C# XML documentation accuracy?

Yes, you can use OpenAPI constraints to improve C# XML documentation accuracy by incorporating the specified formats and limitations directly into the property details. This ensures the IntelliSense reflects the true API validation rules.