diff --git a/.claude-plugin/README.md b/.claude-plugin/README.md new file mode 100644 index 0000000..ffde332 --- /dev/null +++ b/.claude-plugin/README.md @@ -0,0 +1,204 @@ +# DotNetDocs Plugin Marketplace + +This directory contains the marketplace configuration for distributing Claude plugins from the DotNetDocs repository. + +## Structure + +``` +.claude-plugin/ +└── marketplace.json # Marketplace metadata and plugin registry +``` + +## About This Marketplace + +**Name**: `dotnetdocs-plugins` +**Owner**: CloudNimble +**Purpose**: Distribute official Claude plugins for .NET documentation + +This marketplace provides access to plugins that enhance Claude's capabilities for writing, reviewing, and maintaining .NET documentation. + +## Available Plugins + +### .NET Documentation Expert + +**Location**: `.claude/plugins/dotnet-documentation-expert` +**Version**: 1.0.0 + +Expert guidance for writing high-quality .NET API documentation and conceptual content. + +**Features**: +- XML documentation comment templates for all .NET member types +- Best practices following Microsoft's documentation standards +- DotNetDocs conceptual documentation (.mdz files) +- Mintlify-enhanced markdown features +- Project-specific standards compliance +- Code review and quality checking +- Progressive disclosure for efficient context loading + +See the [plugin documentation](../.claude/plugins/dotnet-documentation-expert/README.md) for detailed information. + +## Marketplace Configuration + +The `marketplace.json` file defines: + +- **Marketplace Identity**: Name and owner information +- **Plugin Registry**: List of available plugins with metadata +- **Distribution Settings**: Plugin sources and locations +- **Documentation Links**: References to plugin documentation + +## Using Plugins from This Marketplace + +### In This Repository + +Plugins are automatically available when working in the DotNetDocs repository. + +### In Other Projects + +#### Option 1: Install Individual Plugin + +Copy a specific plugin to your project: + +```bash +# Copy the plugin directory +cp -r .claude/plugins/dotnet-documentation-expert /path/to/your/project/.claude/plugins/ + +# The plugin will be automatically available +``` + +#### Option 2: Reference This Marketplace + +Configure your project to reference this marketplace (feature availability depends on Claude Code version): + +```json +{ + "marketplaces": [ + { + "name": "dotnetdocs-plugins", + "source": "https://github.com/CloudNimble/DotNetDocs.git" + } + ] +} +``` + +## Adding New Plugins + +To add a new plugin to this marketplace: + +1. **Create the Plugin** + + Create your plugin in `.claude/plugins/your-plugin-name/`: + ``` + .claude/plugins/your-plugin-name/ + ├── plugin.md # Main plugin content + ├── README.md # Documentation + ├── EXAMPLES.md # Usage examples + └── CHANGELOG.md # Version history + ``` + +2. **Register in Marketplace** + + Add an entry to the `plugins` array in `marketplace.json`: + ```json + { + "name": "your-plugin-name", + "source": { + "type": "relative", + "path": ".claude/plugins/your-plugin-name" + }, + "displayName": "Your Plugin Display Name", + "description": "Plugin description", + "version": "1.0.0", + "author": { + "name": "Author Name", + "url": "https://github.com/author" + }, + "license": "MIT", + "categories": ["category1", "category2"] + } + ``` + +3. **Update Documentation** + + Update this README with information about the new plugin. + +4. **Test the Plugin** + + Verify the plugin works correctly before committing. + +## Marketplace Structure + +The marketplace.json follows this schema: + +```json +{ + "name": "marketplace-identifier", + "owner": { + "name": "Maintainer Name", + "url": "https://...", + "email": "contact@..." + }, + "metadata": { + "description": "Marketplace description", + "version": "1.0.0", + "homepage": "https://...", + "repository": { ... }, + "pluginRoot": ".claude/plugins" + }, + "plugins": [ + { + "name": "plugin-identifier", + "source": { ... }, + "displayName": "Display Name", + "description": "...", + "version": "1.0.0", + ... + } + ] +} +``` + +### Required Fields + +- `name`: Marketplace identifier (kebab-case) +- `owner`: Maintainer information +- `plugins`: Array of available plugins + +### Plugin Entry Fields + +Each plugin entry should include: +- `name`: Plugin identifier (kebab-case) +- `source`: Where to fetch the plugin from +- `version`: Semantic version +- `description`: Brief description +- `author`: Author information +- `license`: License identifier + +## Version Management + +- **Marketplace Version**: Tracked in `metadata.version` +- **Plugin Versions**: Tracked individually in each plugin entry +- Use semantic versioning (MAJOR.MINOR.PATCH) +- Update CHANGELOG.md files when incrementing versions + +## Distribution + +This marketplace can be: +- **Local**: Used within this repository +- **Shared**: Referenced by other projects via git URL +- **Published**: Potentially published to official marketplace (future) + +## Support + +For questions or issues: +- **Plugin Issues**: See individual plugin documentation +- **Marketplace Issues**: Open an issue in the [DotNetDocs repository](https://github.com/CloudNimble/DotNetDocs/issues) +- **Contributions**: Submit pull requests to add or improve plugins + +## License + +All plugins in this marketplace are licensed under the MIT license unless otherwise specified. + +--- + +**Documentation**: [Plugin Marketplaces Guide](https://code.claude.com/docs/en/plugin-marketplaces) +**Repository**: [CloudNimble/DotNetDocs](https://github.com/CloudNimble/DotNetDocs) diff --git a/.claude-plugin/marketplace.json b/.claude-plugin/marketplace.json new file mode 100644 index 0000000..f56f42a --- /dev/null +++ b/.claude-plugin/marketplace.json @@ -0,0 +1,58 @@ +{ + "name": "dotnetdocs-plugins", + "owner": { + "name": "CloudNimble", + "url": "https://github.com/CloudNimble", + "email": "support@cloudnimble.com" + }, + "metadata": { + "description": "Official Claude plugins for DotNetDocs - expert guidance for .NET documentation", + "version": "1.0.0", + "homepage": "https://github.com/CloudNimble/DotNetDocs", + "repository": { + "type": "git", + "url": "https://github.com/CloudNimble/DotNetDocs.git" + }, + "pluginRoot": ".claude/plugins" + }, + "plugins": [ + { + "name": "dotnet-documentation-expert", + "source": { + "type": "relative", + "path": ".claude/plugins/dotnet-documentation-expert" + }, + "displayName": ".NET Documentation Expert", + "description": "Expert guidance for writing high-quality .NET API documentation and conceptual content. Provides comprehensive templates, best practices, and standards for XML documentation comments, conceptual .mdz files, and integration with DotNetDocs.", + "version": "1.0.0", + "author": { + "name": "CloudNimble", + "url": "https://github.com/CloudNimble" + }, + "license": "MIT", + "categories": [ + "documentation", + "dotnet", + "development", + "code-quality" + ], + "tags": [ + ".NET", + "C#", + "documentation", + "XML comments", + "API docs", + "DotNetDocs", + "Mintlify", + "technical writing" + ], + "icon": "📚", + "homepage": "https://github.com/CloudNimble/DotNetDocs/tree/main/.claude/plugins/dotnet-documentation-expert", + "documentation": { + "readme": "README.md", + "examples": "EXAMPLES.md", + "changelog": "CHANGELOG.md" + } + } + ] +} diff --git a/.claude/plugins/README.md b/.claude/plugins/README.md new file mode 100644 index 0000000..e876c39 --- /dev/null +++ b/.claude/plugins/README.md @@ -0,0 +1,151 @@ +# Claude Plugins for DotNetDocs + +This directory contains Claude Plugins that provide specialized capabilities for working on the DotNetDocs project and .NET documentation in general. + +## Available Plugins + +### .NET Documentation Expert + +**Location**: `dotnet-documentation-expert/` + +**Purpose**: Expert guidance for writing high-quality .NET API documentation and conceptual content. + +**Features**: +- XML documentation comment templates for all .NET member types +- Best practices for summaries, remarks, examples, and parameters +- DotNetDocs conceptual documentation structure (.mdz files) +- Project-specific standards from CLAUDE.md +- Mintlify-enhanced markdown features +- Code review and quality checking + +**Usage**: The plugin activates automatically when working with .NET documentation or can be explicitly referenced. + +**Architecture**: Uses progressive disclosure (3-level context loading) for efficient operation: +- Level 1: YAML frontmatter loaded at startup +- Level 2: Core guidance loaded when activated +- Level 3+: Detailed templates and best practices loaded as needed + +See the [plugin README](dotnet-documentation-expert/README.md) for detailed information. + +## Plugin vs Skill + +**Plugins** are structured packages with: +- Versioning and changelog +- Comprehensive documentation (README, EXAMPLES, CHANGELOG) +- Distribution through marketplace (see `.claude-plugin/marketplace.json`) +- Activation contexts and permissions + +**Skills** are simpler markdown files with expertise content. + +Both can coexist - the skill in `.claude/skills/` provides the same core functionality as the plugin but without the marketplace distribution features. + +## Marketplace + +Plugins are registered in the marketplace at `.claude-plugin/marketplace.json` in the repository root. See the [marketplace documentation](../.claude-plugin/README.md) for details. + +## Installing Plugins + +### From This Repository + +Plugins in this directory are automatically available when working in the DotNetDocs repository. + +### Installing in Other Projects + +To use these plugins in other projects: + +```bash +# Copy the plugin directory +cp -r .claude/plugins/dotnet-documentation-expert /path/to/your/project/.claude/plugins/ + +# Or create a symlink +ln -s /path/to/DotNetDocs/.claude/plugins/dotnet-documentation-expert /path/to/your/project/.claude/plugins/ +``` + +## Creating New Plugins + +To create a new plugin: + +1. **Create Plugin Directory** + ```bash + mkdir -p .claude/plugins/your-plugin-name + ``` + +2. **Create marketplace.json** + ```json + { + "name": "your-plugin-name", + "displayName": "Your Plugin Display Name", + "version": "1.0.0", + "author": { + "name": "Your Name", + "url": "https://github.com/yourname" + }, + "description": "Plugin description", + "categories": ["category1", "category2"], + "license": "MIT" + } + ``` + +3. **Create plugin.md** + + Write your plugin content with system prompt and capabilities. + +4. **Create Documentation** + - README.md: Plugin overview and usage + - EXAMPLES.md: Comprehensive examples + - CHANGELOG.md: Version history + +5. **Test the Plugin** + + Use the plugin in conversations to verify functionality. + +## Plugin Structure + +``` +.claude/plugins/ +└── your-plugin-name/ + ├── marketplace.json # Plugin metadata + ├── plugin.md # Main plugin content + ├── README.md # Plugin documentation + ├── EXAMPLES.md # Usage examples + └── CHANGELOG.md # Version history +``` + +## Distribution + +Plugins can be: +- **Local**: Used only in this repository +- **Shared**: Copied to other projects manually +- **Marketplace**: Published to Claude plugin marketplace (future) + +## Version Control + +Plugins are tracked in git and versioned using semantic versioning: +- **MAJOR**: Breaking changes to plugin interface +- **MINOR**: New features, backward compatible +- **PATCH**: Bug fixes, documentation updates + +## Best Practices + +1. **Clear Scope**: Each plugin should have a focused purpose +2. **Good Documentation**: Provide comprehensive README and examples +3. **Versioning**: Use semantic versioning and maintain changelog +4. **Testing**: Test plugins with real-world scenarios +5. **Maintenance**: Keep plugins updated with project standards +6. **Progressive Disclosure**: Use YAML frontmatter and tiered content loading: + - Level 1: Concise name and description in frontmatter + - Level 2: Core guidance in main plugin.md + - Level 3+: Detailed reference files loaded as needed + - See [dotnet-documentation-expert](dotnet-documentation-expert/README.md#progressive-disclosure-architecture) for example + +## Support + +For questions or issues with plugins: +- Check the plugin's README.md +- Review EXAMPLES.md for usage patterns +- Open an issue in the repository +- Contribute improvements via pull request + +## License + +Plugins in this directory are licensed under the same MIT license as the DotNetDocs project. diff --git a/.claude/plugins/dotnet-documentation-expert/CHANGELOG.md b/.claude/plugins/dotnet-documentation-expert/CHANGELOG.md new file mode 100644 index 0000000..477e44a --- /dev/null +++ b/.claude/plugins/dotnet-documentation-expert/CHANGELOG.md @@ -0,0 +1,150 @@ +# Changelog + +All notable changes to the .NET Documentation Expert plugin will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [1.0.0] - 2025-01-17 + +### Added + +#### Core Features +- **XML Documentation Comment Templates**: Comprehensive templates for all .NET member types + - Classes, interfaces, structs, and records + - Methods (including async methods) + - Properties and indexers + - Events and delegates + - Enumerations and enum values + - Generic type parameters + - Extension methods + +#### Documentation Standards +- **Microsoft .NET Documentation Standards**: Complete guidance on following Microsoft's documentation conventions +- **Project-Specific Standards**: Integration with CLAUDE.md requirements + - Extensive XML doc comments for all public APIs + - `` and `` tag requirements + - `` tag formatting (same line as content) + - `` tag placement (last before member declaration) + +#### Best Practices +- **Summary Tag Guidelines**: Verb phrase patterns, clarity requirements +- **Remarks Tag Guidelines**: Implementation details, performance, thread safety +- **Example Tag Guidelines**: Realistic, runnable code examples +- **Parameter Documentation**: Specific descriptions, valid ranges, null handling +- **Exception Documentation**: Complete exception documentation patterns +- **Cross-References**: ``, ``, ``, `` usage + +#### DotNetDocs Integration +- **Conceptual Documentation**: `.mdz` file structure and organization + - usage.mdz: Task-oriented content + - examples.mdz: Comprehensive code examples + - best-practices.mdz: Recommendations and guidance + - patterns.mdz: Design patterns and approaches + - considerations.mdz: Important notes and limitations + - related-apis.mdz: Cross-references + +- **Mintlify Features**: Enhanced markdown components + - `` blocks for helpful hints + - `` blocks for important caveats + - `` blocks for additional information + +#### Code Patterns +- **Generic Type Parameters**: Documentation templates for generic types +- **Async Methods**: Patterns for documenting asynchronous operations +- **Extension Methods**: Special handling for `this` parameter +- **Nullable Reference Types**: Null documentation with `` +- **Modern C# Features**: Pattern matching, records, init-only properties + +#### Documentation Review +- Completeness checking for XML documentation +- Best practice validation +- Consistency verification across codebases +- Quality improvement suggestions + +### Documentation +- README.md: Complete plugin overview and usage guide +- EXAMPLES.md: Comprehensive examples for all documentation patterns +- CHANGELOG.md: Version history (this file) +- marketplace.json: Plugin metadata and configuration + +### Configuration +- Automatic activation on documentation-related contexts +- Support for .NET/C# code contexts +- Integration with Claude Code +- No special permissions required + +### Plugin Metadata +- **Name**: .NET Documentation Expert +- **Display Name**: .NET Documentation Expert +- **Version**: 1.0.0 +- **Author**: CloudNimble +- **License**: MIT +- **Categories**: documentation, dotnet, development, code-quality +- **Type**: Prompt Enhancer + +## [Unreleased] + +### Planned Features +- Additional templates for ASP.NET Core patterns +- Entity Framework Core documentation patterns +- Blazor component documentation +- Minimal API documentation patterns +- Source generator documentation +- Analyzer and code fix documentation +- Unit test documentation patterns +- Benchmark documentation patterns + +### Under Consideration +- Integration with XML documentation linters +- Automated documentation quality scoring +- Documentation coverage reports +- AI-powered documentation generation from code analysis +- Multi-language support (F#, VB.NET) +- DocFX-specific templates +- Swagger/OpenAPI documentation integration + +--- + +## Version History Summary + +- **1.0.0** (2025-01-17): Initial release with comprehensive .NET documentation support + +## How to Upgrade + +### From Skill to Plugin + +If you were previously using the `.claude/skills/dotnet-documentation-expert.md` skill: + +1. The plugin provides the same functionality with enhanced metadata +2. No changes to your documentation workflow are required +3. The plugin activates automatically in the same contexts +4. All templates and examples remain compatible + +## Breaking Changes + +None - this is the initial release. + +## Migration Guide + +N/A - Initial release. + +## Support + +For issues, questions, or contributions: +- **Issues**: [GitHub Issues](https://github.com/CloudNimble/DotNetDocs/issues) +- **Discussions**: [GitHub Discussions](https://github.com/CloudNimble/DotNetDocs/discussions) +- **Repository**: [CloudNimble/DotNetDocs](https://github.com/CloudNimble/DotNetDocs) + +## Contributing + +Contributions are welcome! When contributing: +1. Follow existing documentation patterns +2. Add examples for new features +3. Update this CHANGELOG.md +4. Test with real-world code samples +5. Ensure compatibility with DotNetDocs pipeline + +--- + +**Note**: Dates are in YYYY-MM-DD format following ISO 8601. diff --git a/.claude/plugins/dotnet-documentation-expert/EXAMPLES.md b/.claude/plugins/dotnet-documentation-expert/EXAMPLES.md new file mode 100644 index 0000000..e8c8e79 --- /dev/null +++ b/.claude/plugins/dotnet-documentation-expert/EXAMPLES.md @@ -0,0 +1,629 @@ +# Documentation Examples + +This file provides comprehensive examples of documentation patterns supported by the .NET Documentation Expert plugin. + +## Table of Contents + +1. [Service Classes](#service-classes) +2. [Repository Pattern](#repository-pattern) +3. [Configuration Classes](#configuration-classes) +4. [Extension Methods](#extension-methods) +5. [Async Patterns](#async-patterns) +6. [Generic Types](#generic-types) +7. [Events and Delegates](#events-and-delegates) +8. [Enumerations](#enumerations) +9. [Interfaces](#interfaces) +10. [Conceptual Documentation](#conceptual-documentation) + +--- + +## Service Classes + +### Example: UserService + +```csharp +namespace MyApp.Services +{ + /// + /// Provides user management operations including authentication, authorization, and profile management. + /// + /// + /// This service coordinates between the user repository, authentication provider, and email service + /// to provide a unified interface for user-related operations. + /// + /// All methods are thread-safe and can be safely called from multiple threads concurrently. + /// The service uses dependency injection to obtain required dependencies. + /// + /// + /// Thread Safety: This class is thread-safe. All methods can be called concurrently. + /// + /// + /// + /// Basic usage: + /// + /// var userService = serviceProvider.GetRequiredService<UserService>(); + /// + /// // Authenticate user + /// var user = await userService.AuthenticateAsync("john.doe", "password123"); + /// if (user is not null) + /// { + /// Console.WriteLine($"Welcome, {user.DisplayName}!"); + /// + /// // Update profile + /// user.Email = "john.doe@example.com"; + /// await userService.UpdateProfileAsync(user); + /// } + /// + /// + public class UserService + { + /// + /// Asynchronously authenticates a user with their credentials. + /// + /// The username. Cannot be or whitespace. + /// The password. Cannot be or whitespace. + /// A to observe while waiting for the task to complete. + /// + /// A task that represents the asynchronous operation. The task result contains the authenticated + /// if credentials are valid; otherwise, . + /// + /// + /// Thrown when or is or whitespace. + /// + /// + /// This method validates credentials against the configured authentication provider. + /// Failed authentication attempts are logged for security monitoring. + /// + /// The method uses constant-time comparison for password validation to prevent timing attacks. + /// + /// + public async Task AuthenticateAsync( + string username, + string password, + CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(username); + ArgumentException.ThrowIfNullOrWhiteSpace(password); + + // Implementation... + } + } +} +``` + +--- + +## Repository Pattern + +### Example: Generic Repository + +```csharp +namespace MyApp.Data +{ + /// + /// Represents a generic repository for entity CRUD operations. + /// + /// + /// The type of entity stored in the repository. Must implement . + /// + /// + /// The type of the entity's primary key. Must be a value type. + /// + /// + /// This repository provides standard CRUD operations with support for: + /// + /// Async operations for all database access + /// Query expression support via IQueryable + /// Unit of work pattern integration + /// Change tracking and concurrency handling + /// + /// + /// Thread Safety: This class is not thread-safe. Use one instance per unit of work. + /// + /// + /// + /// + /// public class UserRepository : Repository<User, int> + /// { + /// public UserRepository(DbContext context) : base(context) { } + /// + /// public async Task<User?> FindByEmailAsync(string email) + /// { + /// return await Query() + /// .FirstOrDefaultAsync(u => u.Email == email); + /// } + /// } + /// + /// + public class Repository + where TEntity : class, IEntity + where TKey : struct + { + /// + /// Asynchronously finds an entity by its primary key. + /// + /// The primary key value of the entity to find. + /// A to observe while waiting for the task to complete. + /// + /// A task that represents the asynchronous operation. The task result contains the entity + /// if found; otherwise, . + /// + /// + /// This method queries the database directly and does not use cached values. + /// For frequently accessed entities, consider implementing a caching layer. + /// + public async Task FindByIdAsync(TKey id, CancellationToken cancellationToken = default) + { + // Implementation... + } + } +} +``` + +--- + +## Configuration Classes + +### Example: Email Settings + +```csharp +namespace MyApp.Configuration +{ + /// + /// Represents configuration settings for the email service. + /// + /// + /// This configuration class is typically bound from application settings using the Options pattern. + /// All properties must be configured before the email service can be used. + /// + /// Configuration is validated on application startup to ensure all required values are present. + /// + /// + /// + /// Configure in appsettings.json: + /// + /// { + /// "EmailSettings": { + /// "SmtpServer": "smtp.example.com", + /// "Port": 587, + /// "UseSsl": true, + /// "FromAddress": "noreply@example.com", + /// "FromName": "My Application" + /// } + /// } + /// + /// + /// Register in Startup.cs: + /// + /// services.Configure<EmailSettings>( + /// Configuration.GetSection("EmailSettings")); + /// + /// + public class EmailSettings + { + /// + /// Gets or sets the SMTP server hostname or IP address. + /// + /// + /// The SMTP server hostname or IP address. This property is required and cannot be or empty. + /// + /// + /// Common examples: "smtp.gmail.com", "smtp.office365.com", "localhost" + /// + public string SmtpServer { get; set; } = string.Empty; + + /// + /// Gets or sets the SMTP server port number. + /// + /// + /// The port number. Common values are 25 (unencrypted), 587 (TLS), or 465 (SSL). The default is 587. + /// + public int Port { get; set; } = 587; + + /// + /// Gets or sets a value indicating whether to use SSL/TLS encryption. + /// + /// + /// to use SSL/TLS encryption; otherwise, . The default is . + /// + /// + /// It is strongly recommended to use SSL/TLS in production environments. + /// Unencrypted SMTP should only be used in development or trusted internal networks. + /// + public bool UseSsl { get; set; } = true; + } +} +``` + +--- + +## Extension Methods + +### Example: String Extensions + +```csharp +namespace MyApp.Extensions +{ + /// + /// Provides extension methods for objects. + /// + public static class StringExtensions + { + /// + /// Converts the string to title case where the first letter of each word is capitalized. + /// + /// The string to convert. Cannot be . + /// + /// A new string in title case. Returns an empty string if is empty. + /// + /// + /// Thrown when is . + /// + /// + /// + /// string title = "the quick brown fox".ToTitleCase(); + /// Console.WriteLine(title); + /// // Output: The Quick Brown Fox + /// + /// string empty = "".ToTitleCase(); + /// Console.WriteLine($"Empty: '{empty}'"); + /// // Output: Empty: '' + /// + /// + /// + /// This extension method preserves whitespace and punctuation. + /// Words are defined as sequences of characters separated by whitespace. + /// + public static string ToTitleCase(this string value) + { + ArgumentNullException.ThrowIfNull(value); + // Implementation... + } + + /// + /// Truncates the string to the specified maximum length and appends an ellipsis if truncated. + /// + /// The string to truncate. Cannot be . + /// The maximum length including the ellipsis. Must be at least 3. + /// + /// The truncated string with ellipsis appended if the original length exceeds ; + /// otherwise, the original string. + /// + /// + /// Thrown when is . + /// + /// + /// Thrown when is less than 3. + /// + /// + /// + /// string text = "This is a long sentence that needs truncation"; + /// string truncated = text.Truncate(20); + /// Console.WriteLine(truncated); + /// // Output: This is a long se... + /// + /// string short = "Short".Truncate(20); + /// Console.WriteLine(short); + /// // Output: Short + /// + /// + public static string Truncate(this string value, int maxLength) + { + ArgumentNullException.ThrowIfNull(value); + ArgumentOutOfRangeException.ThrowIfLessThan(maxLength, 3); + // Implementation... + } + } +} +``` + +--- + +## Async Patterns + +### Example: Async Data Access + +```csharp +namespace MyApp.Services +{ + /// + /// Provides asynchronous data access operations for user management. + /// + public class UserDataService + { + /// + /// Asynchronously retrieves a user by their unique identifier. + /// + /// The unique identifier of the user to retrieve. + /// A to observe while waiting for the task to complete. + /// + /// A task that represents the asynchronous operation. The task result contains the + /// if found; otherwise, . + /// + /// + /// Thrown when the operation is canceled via the . + /// + /// + /// Thrown when a database error occurs during the operation. + /// + /// + /// + /// var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30)); + /// try + /// { + /// var user = await dataService.GetUserAsync(123, cts.Token); + /// if (user is not null) + /// { + /// Console.WriteLine($"Found: {user.DisplayName}"); + /// } + /// } + /// catch (OperationCanceledException) + /// { + /// Console.WriteLine("Operation timed out"); + /// } + /// + /// + /// + /// This method uses async/await pattern for non-blocking I/O operations. + /// The cancellation token is passed through to the underlying database query + /// to allow graceful cancellation of long-running operations. + /// + public async Task GetUserAsync(int userId, CancellationToken cancellationToken = default) + { + // Implementation... + } + } +} +``` + +--- + +## Generic Types + +See Repository Pattern example above for generic type documentation. + +--- + +## Events and Delegates + +### Example: Custom Events + +```csharp +namespace MyApp.Events +{ + /// + /// Provides data for the event. + /// + public class OrderCompletedEventArgs : EventArgs + { + /// + /// Gets the order that was completed. + /// + /// + /// The completed instance. + /// + public Order Order { get; } + + /// + /// Gets the timestamp when the order was completed. + /// + /// + /// The UTC timestamp of completion. + /// + public DateTime CompletedAt { get; } + } + + /// + /// Processes customer orders through the fulfillment pipeline. + /// + public class OrderProcessor + { + /// + /// Occurs when an order has been successfully processed and completed. + /// + /// + /// Subscribers receive containing the completed order + /// and completion timestamp. + /// + /// This event is raised after payment confirmation and before shipping notification. + /// Event handlers are invoked synchronously in registration order. + /// + /// + /// Thread Safety: This event can be raised from any thread. Subscribers must handle + /// their own thread synchronization if necessary. + /// + /// + /// + /// + /// var processor = new OrderProcessor(); + /// processor.OrderCompleted += (sender, e) => + /// { + /// Console.WriteLine($"Order {e.Order.Id} completed at {e.CompletedAt}"); + /// }; + /// + /// await processor.ProcessOrderAsync(myOrder); + /// + /// + public event EventHandler? OrderCompleted; + } +} +``` + +--- + +## Enumerations + +### Example: Status Enumeration + +```csharp +namespace MyApp.Models +{ + /// + /// Specifies the current status of an order in the processing pipeline. + /// + /// + /// Orders progress through states in a specific order: Pending → Processing → Shipped → Delivered. + /// Orders can be transitioned to Cancelled from any state except Delivered. + /// + [Flags] + public enum OrderStatus + { + /// + /// The order has been created but not yet processed. + /// Payment authorization is pending. + /// + Pending = 0, + + /// + /// The order is currently being processed. + /// Payment has been authorized and inventory is being allocated. + /// + Processing = 1, + + /// + /// The order has been shipped to the customer. + /// Tracking information is available. + /// + Shipped = 2, + + /// + /// The order has been delivered to the customer. + /// This is a terminal state - no further transitions are allowed. + /// + Delivered = 3, + + /// + /// The order has been cancelled. + /// If payment was captured, a refund has been initiated. + /// + Cancelled = 4 + } +} +``` + +--- + +## Interfaces + +### Example: Service Interface + +```csharp +namespace MyApp.Abstractions +{ + /// + /// Defines operations for managing user accounts and authentication. + /// + /// + /// Implementations of this interface provide user management functionality including: + /// + /// User authentication and session management + /// Profile creation and updates + /// Password management and resets + /// Role and permission assignment + /// + /// + public interface IUserService + { + /// + /// Asynchronously authenticates a user with their credentials. + /// + /// The username. Cannot be or whitespace. + /// The password. Cannot be or whitespace. + /// A to observe while waiting for the task to complete. + /// + /// A task that represents the asynchronous operation. The task result contains the authenticated + /// if credentials are valid; otherwise, . + /// + Task AuthenticateAsync(string username, string password, CancellationToken cancellationToken = default); + } +} +``` + +--- + +## Conceptual Documentation + +### Example: usage.mdz + +**File**: `conceptual/MyApp.Services/UserService/usage.mdz` + +```markdown +# Using UserService + +The `UserService` provides comprehensive user management functionality for your application. + +## Basic Setup + +First, register the service in your dependency injection container: + +\```csharp +services.AddScoped(); +\``` + +## Common Tasks + +### Authenticating a User + +\```csharp +var userService = serviceProvider.GetRequiredService(); + +var user = await userService.AuthenticateAsync("john.doe", "password123"); +if (user is not null) +{ + // Authentication successful + Console.WriteLine($"Welcome, {user.DisplayName}!"); +} +else +{ + // Authentication failed + Console.WriteLine("Invalid credentials"); +} +\``` + +### Creating a New User + +\```csharp +var newUser = new User +{ + Username = "jane.doe", + Email = "jane@example.com", + DisplayName = "Jane Doe" +}; + +await userService.CreateUserAsync(newUser, "initialPassword"); +\``` + +### Updating User Profile + +\```csharp +var user = await userService.GetUserAsync(userId); +if (user is not null) +{ + user.Email = "newemail@example.com"; + user.PhoneNumber = "+1-555-0123"; + + await userService.UpdateProfileAsync(user); +} +\``` + +## See Also + +- [Best Practices](best-practices.mdz) +- [Security Considerations](considerations.mdz) +- [API Reference](/api-reference/MyApp/Services/UserService) +``` + +--- + +## Summary + +These examples demonstrate the comprehensive documentation patterns supported by the .NET Documentation Expert plugin. Each example shows: + +- Complete XML documentation comments +- Proper tag usage and ordering +- Clear, actionable examples +- Cross-references and links +- Project-specific standards compliance +- Integration with conceptual documentation + +For more information, see the [plugin README](README.md). diff --git a/.claude/plugins/dotnet-documentation-expert/README.md b/.claude/plugins/dotnet-documentation-expert/README.md new file mode 100644 index 0000000..546bbc5 --- /dev/null +++ b/.claude/plugins/dotnet-documentation-expert/README.md @@ -0,0 +1,281 @@ +# .NET Documentation Expert Plugin + +A comprehensive Claude plugin that provides expert guidance for writing high-quality .NET API documentation and conceptual content. + +## Overview + +The .NET Documentation Expert plugin transforms Claude into a specialized assistant for creating, reviewing, and improving .NET documentation. It provides deep expertise in XML documentation comments, conceptual documentation, and integration with the DotNetDocs documentation pipeline. + +## Progressive Disclosure Architecture + +This plugin uses a **three-level progressive disclosure** pattern to efficiently manage context: + +### Level 1: Startup Context (Always Loaded) +The plugin's YAML frontmatter (`name` and `description`) is loaded into Claude's system prompt at startup. This allows Claude to understand when the plugin should be activated without loading the full content. + +```yaml +--- +name: dotnet-documentation-expert +description: Expert guidance for .NET API documentation. Use when writing or reviewing XML documentation comments, creating conceptual .mdz files, or working with DotNetDocs/Mintlify documentation. +--- +``` + +### Level 2: Core Guidance (Loaded When Activated) +When the plugin is triggered, the main `plugin.md` content is loaded, providing: +- Core principles (Clarity First, Show Don't Tell, Document the Why, Think Like a User) +- Quick-start templates for common scenarios (class, method, property documentation) +- Essential guidelines for summaries, remarks, examples, parameters, returns, and exceptions +- Project standards from CLAUDE.md +- References to supplementary resources + +This level gives you what you need for most documentation tasks without overloading context. + +### Level 3+: Detailed Resources (Loaded As Needed) +When you need specific, detailed guidance, the plugin references supplementary files: + +- **[xml-templates.md](xml-templates.md)** - Complete templates for: + - Generic types with constraints + - Async methods and CancellationToken + - Extension methods + - Events, delegates, and EventArgs + - Enumerations (simple and flags) + - Interfaces with multiple members + - Indexers, structs, records, operators + - IDisposable implementation + +- **[best-practices.md](best-practices.md)** - Detailed guidance on: + - Microsoft .NET documentation standards + - Modern C# features (nullable reference types, pattern matching, records, init-only properties) + - Cross-referencing with ``, ``, ``, ``, `` + - Thread safety documentation + - Performance characteristics + - Lists and formatting with `` and `` tags + - Common pitfalls to avoid + +- **[EXAMPLES.md](EXAMPLES.md)** - Comprehensive real-world examples of fully documented classes + +These files are only loaded when you explicitly need that level of detail, keeping the plugin efficient while maintaining access to comprehensive guidance. + +### Why This Matters + +Progressive disclosure provides several benefits: +- **Faster activation**: Minimal context loaded at startup +- **Efficient operation**: Only load what you need for each task +- **Comprehensive coverage**: Full detailed guidance available when needed +- **Better performance**: Reduced token usage for routine documentation tasks + +## Features + +### 📝 XML Documentation Comments +- Complete templates for all .NET member types (classes, methods, properties, events, enums) +- Best practices for writing clear, accurate, and maintainable documentation +- Guidance on all XML tags: ``, ``, ``, ``, ``, ``, etc. +- Project-specific standards compliance (CLAUDE.md) + +### 📚 Conceptual Documentation +- Structure and organization for `.mdz` conceptual documentation files +- Templates for usage guides, examples, best practices, patterns, and considerations +- Integration with DotNetDocs documentation pipeline +- Mintlify-enhanced markdown features + +### 🎯 .NET Best Practices +- Microsoft documentation standards +- Null reference type documentation patterns +- Modern C# feature documentation (async, generics, pattern matching) +- Thread safety and performance documentation + +### 🔍 Code Review & Quality +- Review existing documentation for completeness and quality +- Identify missing or inadequate documentation +- Suggest improvements based on best practices +- Ensure consistency across codebases + +## Installation + +### In This Repository + +The plugin is automatically available when working in the DotNetDocs repository. + +### Manual Installation in Other Projects + +Copy the plugin directory to your project: +```bash +cp -r .claude/plugins/dotnet-documentation-expert /path/to/your/project/.claude/plugins/ +``` + +The plugin will be automatically available in Claude Code. + +### From Marketplace + +This plugin is distributed through the DotNetDocs plugin marketplace located at `.claude-plugin/marketplace.json` in the repository root. + +## Usage + +### Automatic Activation + +The plugin activates automatically when: +- You mention "documentation", "XML comments", or "API docs" +- You're working with .NET/C# code +- You ask about documenting code +- You mention DotNetDocs, Mintlify, or documentation generation + +### Explicit Invocation + +Reference the plugin in your conversation: +``` +Using the .NET Documentation Expert plugin, help me document this UserService class. +``` + +### Common Use Cases + +#### 1. Document a New Class +``` +Can you help me write documentation for this new OrderProcessor class? +``` + +The plugin will provide comprehensive XML documentation including summary, remarks, examples, and any necessary conceptual documentation structure. + +#### 2. Review Existing Documentation +``` +Please review the documentation for this PaymentService class and suggest improvements. +``` + +The plugin will analyze the documentation for completeness, clarity, and adherence to best practices. + +#### 3. Create Conceptual Documentation +``` +I need to create usage documentation for the MintlifyRenderer. What structure should I use? +``` + +The plugin will suggest appropriate .mdz file organization and provide content templates. + +#### 4. Document Specific Patterns +``` +How should I document this async method that returns a nullable Task? +``` + +The plugin will provide specific guidance for the pattern in question. + +## What You Get + +### For Classes +```csharp +/// +/// Provides user management operations including authentication, authorization, and profile management. +/// +/// +/// This service coordinates between the user repository, authentication provider, and email service +/// to provide a unified interface for user-related operations. +/// +/// All methods are thread-safe and can be safely called from multiple threads concurrently. +/// +/// +/// +/// +/// var userService = serviceProvider.GetRequiredService<UserService>(); +/// var user = await userService.AuthenticateAsync("username", "password"); +/// if (user is not null) +/// { +/// Console.WriteLine($"Welcome, {user.DisplayName}!"); +/// } +/// +/// +public class UserService { } +``` + +### For Methods +```csharp +/// +/// Asynchronously authenticates a user with their credentials. +/// +/// The username. Cannot be or whitespace. +/// The password. Cannot be or whitespace. +/// A token to cancel the asynchronous operation. +/// +/// A task representing the asynchronous operation. The task result contains the authenticated +/// if credentials are valid; otherwise, . +/// +/// +/// Thrown when or is or whitespace. +/// +/// +/// This method validates credentials against the configured authentication provider. +/// Failed authentication attempts are logged for security monitoring. +/// +public async Task AuthenticateAsync( + string username, + string password, + CancellationToken cancellationToken = default) +``` + +### For Conceptual Documentation + +Structured `.mdz` files with: +- Clear organization by namespace/type/member +- Task-oriented usage guides +- Comprehensive examples +- Best practices and patterns +- Important considerations +- Related APIs and cross-references + +## Configuration + +The plugin respects project-specific standards defined in `CLAUDE.md`: +- Extensive XML doc comments for all public APIs +- Include `` and `` tags where applicable +- `` tags on same line as content +- `` tag last before member declaration +- Null reference type documentation patterns + +## Integration with DotNetDocs + +The plugin understands the DotNetDocs documentation pipeline: +- XML documentation extraction +- Conceptual content loading from `.mdz` files +- Markdown transformation +- Mintlify rendering +- Navigation generation + +This ensures documentation guidance considers how content flows through the pipeline and appears in final output. + +## Examples + +See [EXAMPLES.md](EXAMPLES.md) for comprehensive examples of: +- Service class documentation +- Configuration class documentation +- Extension method documentation +- Async method patterns +- Generic type documentation +- Event and delegate documentation + +## Version History + +See [CHANGELOG.md](CHANGELOG.md) for version history and changes. + +## License + +MIT License - See the main DotNetDocs repository for details. + +## Contributing + +Contributions are welcome! Please: +1. Follow the existing documentation structure +2. Include examples for new patterns +3. Test documentation output with DotNetDocs +4. Update CHANGELOG.md with your changes + +## Support + +- **Issues**: [GitHub Issues](https://github.com/CloudNimble/DotNetDocs/issues) +- **Documentation**: [DotNetDocs Documentation](https://dotnetdocs.dev) +- **Repository**: [CloudNimble/DotNetDocs](https://github.com/CloudNimble/DotNetDocs) + +## Author + +**CloudNimble** +- GitHub: [@CloudNimble](https://github.com/CloudNimble) +- Website: [https://cloudnimble.com](https://cloudnimble.com) + +--- + +**Keywords**: .NET, C#, documentation, XML comments, API documentation, technical writing, DotNetDocs, Mintlify, DocFX diff --git a/.claude/plugins/dotnet-documentation-expert/best-practices.md b/.claude/plugins/dotnet-documentation-expert/best-practices.md new file mode 100644 index 0000000..ce2c254 --- /dev/null +++ b/.claude/plugins/dotnet-documentation-expert/best-practices.md @@ -0,0 +1,676 @@ +# Best Practices for .NET Documentation + +Detailed guidance for writing high-quality .NET documentation following Microsoft standards and modern C# patterns. + +## Microsoft .NET Documentation Standards + +### Summary Tag Best Practices + +**Start with the Right Verb** + +Methods should start with action verbs in third person: +- ✅ "Gets the user's display name" +- ✅ "Creates a new instance" +- ✅ "Calculates the total amount" +- ❌ "Get the user's display name" (wrong tense) +- ❌ "This method gets..." (too verbose) + +**Be Concise and Clear** + +- Keep summaries to 1-2 sentences +- Focus on *what* the member is or does, not *how* it works +- Avoid implementation details in summaries (use `` instead) + +```csharp +/// +/// Gets the authenticated user's profile information. +/// +/// +/// This method queries the database and caches results for 5 minutes. +/// +``` + +### Parameter Documentation + +**Be Specific About Requirements** + +Document constraints, valid ranges, and special values: + +```csharp +/// The number of items per page. Must be between 1 and 100. +/// The user's email address. Cannot be or whitespace. +/// Configuration options, or to use defaults. +``` + +**Document Side Effects** + +If a parameter is modified by the method, document it: + +```csharp +/// +/// The buffer to write data into. The buffer's position will be advanced by the number of bytes written. +/// +``` + +### Return Value Documentation + +**Describe the Result and Conditions** + +```csharp +/// +/// The if found; otherwise, . +/// + +/// +/// A task that represents the asynchronous operation. The task result contains the number +/// of records updated, which may be 0 if no matching records were found. +/// + +/// +/// An enumerable collection of instances. The collection may be empty +/// if no products match the criteria. +/// +``` + +### Exception Documentation + +**Document All Thrown Exceptions** + +Document exceptions your method throws directly (not exceptions from called methods unless significant): + +```csharp +/// +/// Thrown when is . +/// +/// +/// Thrown when is less than 0. +/// +/// +/// Thrown when the service has not been initialized. +/// +``` + +### Remarks Tag Usage + +Use `` for: + +**Implementation Details That Affect Usage** + +```csharp +/// +/// This method uses a least-recently-used (LRU) cache. Cached items expire after 5 minutes +/// of inactivity. Cache size is limited to 1000 items. +/// +``` + +**Performance Characteristics** + +```csharp +/// +/// This operation has O(n log n) time complexity and requires O(n) additional space. +/// For large datasets (>10,000 items), consider using instead. +/// +``` + +**Thread Safety Guarantees** + +```csharp +/// +/// This method is thread-safe and can be called concurrently from multiple threads. +/// + +/// +/// This class is not thread-safe. Use one instance per thread or provide external synchronization. +/// +``` + +**Design Rationale** + +```csharp +/// +/// This method returns a copy of the internal collection to prevent external modification. +/// For read-only access without copying, use instead. +/// +``` + +### Example Tag Guidelines + +**Provide Runnable, Realistic Examples** + +```csharp +/// +/// +/// var service = new UserService(connectionString); +/// try +/// { +/// var user = await service.GetUserAsync(userId); +/// if (user is not null) +/// { +/// Console.WriteLine($"Found: {user.DisplayName}"); +/// } +/// else +/// { +/// Console.WriteLine("User not found"); +/// } +/// } +/// finally +/// { +/// service.Dispose(); +/// } +/// +/// +``` + +**Show Common Patterns** + +```csharp +/// +/// Basic usage: +/// +/// var result = calculator.Add(5, 3); +/// Console.WriteLine(result); // Output: 8 +/// +/// With error handling: +/// +/// try +/// { +/// var result = calculator.Divide(10, 0); +/// } +/// catch (DivideByZeroException ex) +/// { +/// Console.WriteLine($"Error: {ex.Message}"); +/// } +/// +/// +``` + +## Modern C# Features + +### Nullable Reference Types + +**Document Null Behavior Explicitly** + +```csharp +/// +/// Gets the user's middle name. +/// +/// +/// The middle name, or if the user has no middle name. +/// +public string? MiddleName { get; set; } + +/// +/// Attempts to find a user by email address. +/// +/// The email address. Cannot be . +/// +/// The if found; otherwise, . +/// +public User? FindByEmail(string email) +{ +} +``` + +**Trust the Type System** + +Don't add null checks in documentation when the type is non-nullable: + +```csharp +/// +/// Processes the user account. +/// +/// The user to process. +/// +/// This method assumes is not +/// as enforced by the type system. +/// +public void Process(User user) // Non-nullable, so null is not expected +{ +} +``` + +### Pattern Matching + +**Document Pattern-Based Behavior** + +```csharp +/// +/// Calculates the discount based on the customer type. +/// +/// The customer. Cannot be . +/// +/// The discount percentage as a decimal between 0 and 1. +/// Returns 0.10 for premium customers, 0.05 for standard customers, +/// and 0 for all other customer types. +/// +public decimal GetDiscount(Customer customer) +{ +} +``` + +### Records + +**Document Immutability and Value Semantics** + +```csharp +/// +/// Represents an immutable point in 2D space. +/// +/// The X coordinate. +/// The Y coordinate. +/// +/// This record provides value-based equality comparison. Two points with the same +/// X and Y coordinates are considered equal. +/// +/// Use the with expression to create modified copies: +/// +/// var point = new Point(10, 20); +/// var movedPoint = point with { X = 15 }; +/// +/// +/// +public record Point(int X, int Y); +``` + +### Init-Only Properties + +**Document Initialization Requirements** + +```csharp +/// +/// Gets the configuration section name. +/// +/// +/// The section name. This property can only be set during object initialization. +/// +/// +/// This property must be set when creating the options instance: +/// +/// var options = new MyOptions { SectionName = "MySection" }; +/// +/// +public string SectionName { get; init; } +``` + +### Required Members + +**Document Required Properties** + +```csharp +/// +/// Gets or sets the user's email address. +/// +/// +/// The email address. This property is required and must be set during initialization. +/// +/// +/// This property must be set when creating a User instance: +/// +/// var user = new User { Email = "user@example.com", DisplayName = "John Doe" }; +/// +/// Attempting to create a User without setting Email will result in a compilation error. +/// +public required string Email { get; init; } +``` + +## Cross-Referencing + +### See Tag + +**Link to Related Types** + +```csharp +/// +/// Provides data access for entities. +/// +/// +/// This repository implements the interface. +/// For customer data access, see . +/// +public class UserRepository : IRepository +{ +} +``` + +### SeeAlso Tag + +**Provide Related Documentation Links** + +```csharp +/// +/// Validates user input before saving. +/// +/// +/// +/// +public class UserValidator : IValidator +{ +} +``` + +### ParamRef and TypeParamRef + +**Reference Parameters in Documentation** + +```csharp +/// +/// Combines two values using the specified operator. +/// +/// The left operand. +/// The right operand. +/// The operation to perform. +/// +/// The result of applying to and . +/// +public int Combine(int left, int right, Func operation) +{ +} + +/// +/// Converts a collection of one type to another. +/// +/// The source element type. +/// The result element type. +/// +/// This method projects each element to . +/// +public IEnumerable Convert( + IEnumerable source, + Func converter) +{ +} +``` + +### LangWord Tag + +**Reference Language Keywords** + +Always use `` for language keywords and literals: + +```csharp +/// +/// if the operation succeeded; otherwise, . +/// + +/// The value to check, or . + +/// +/// This property returns if not initialized. +/// +``` + +Common langwords: `null`, `true`, `false`, `default`, `async`, `await`, `sealed`, `abstract`, `virtual`, `static` + +## Thread Safety + +### Document Thread Safety Explicitly + +**Thread-Safe Class** + +```csharp +/// +/// Provides thread-safe caching functionality. +/// +/// +/// All public members of this class are thread-safe and may be used concurrently +/// from multiple threads. Internal locking ensures data consistency. +/// +public class ThreadSafeCache +{ +} +``` + +**Not Thread-Safe** + +```csharp +/// +/// Manages a collection of user sessions. +/// +/// +/// This class is not thread-safe. If instances are accessed by multiple threads, +/// callers must provide external synchronization. +/// +public class SessionManager +{ +} +``` + +**Conditionally Thread-Safe** + +```csharp +/// +/// Provides buffered writing functionality. +/// +/// +/// Thread Safety: This class is thread-safe for concurrent reads, but write operations +/// must be externally synchronized. The method must not be called +/// concurrently with . +/// +public class BufferedWriter +{ +} +``` + +## Performance Documentation + +### Document Performance Characteristics + +**Algorithmic Complexity** + +```csharp +/// +/// Sorts the collection in ascending order. +/// +/// +/// This method uses a quicksort algorithm with O(n log n) average time complexity +/// and O(log n) space complexity. Worst-case time complexity is O(n²) for already +/// sorted data. +/// +public void Sort() +{ +} +``` + +**Resource Usage** + +```csharp +/// +/// Loads the entire file into memory. +/// +/// +/// Warning: This method loads the complete file contents into memory. For files +/// larger than 100 MB, consider using to process +/// the file incrementally. +/// +public async Task ReadAllTextAsync(string path) +{ +} +``` + +**Optimization Notes** + +```csharp +/// +/// Gets the number of items in the collection. +/// +/// +/// The item count. +/// +/// +/// This property is O(1) as the count is maintained internally. Unlike LINQ's Count(), +/// this does not enumerate the collection. +/// +public int Count { get; } +``` + +## Lists and Formatting + +### Using Para Tag + +```csharp +/// +/// This method performs validation in three phases: +/// +/// Phase 1: Structural validation ensures all required fields are present. +/// +/// +/// Phase 2: Semantic validation checks business rules and constraints. +/// +/// +/// Phase 3: Cross-field validation verifies relationships between fields. +/// +/// +``` + +### Using List Tag + +**Bullet Lists** + +```csharp +/// +/// This service provides the following capabilities: +/// +/// User authentication and authorization +/// Password reset and recovery +/// Profile management +/// Session tracking +/// +/// +``` + +**Numbered Lists** + +```csharp +/// +/// To configure the service, follow these steps: +/// +/// Add the service to dependency injection +/// Configure authentication providers +/// Set up database connection +/// Initialize the cache +/// +/// +``` + +**Definition Lists** + +```csharp +/// +/// Supported file formats: +/// +/// +/// Format +/// Description +/// +/// +/// JSON +/// JavaScript Object Notation for structured data +/// +/// +/// XML +/// Extensible Markup Language for hierarchical data +/// +/// +/// CSV +/// Comma-Separated Values for tabular data +/// +/// +/// +``` + +## Common Pitfalls to Avoid + +### Don't Repeat the Member Name + +❌ Bad: +```csharp +/// +/// UserService constructor. +/// +public UserService() +{ +} +``` + +✅ Good: +```csharp +/// +/// Initializes a new instance of the class. +/// +public UserService() +{ +} +``` + +### Don't State the Obvious + +❌ Bad: +```csharp +/// +/// Gets or sets the Name. +/// +public string Name { get; set; } +``` + +✅ Good: +```csharp +/// +/// Gets or sets the user's display name. +/// +/// +/// The display name shown in the user interface. The default is an empty string. +/// +public string Name { get; set; } +``` + +### Don't Ignore Async Methods + +❌ Bad: +```csharp +/// +/// Gets a user. +/// +public Task GetUserAsync(int id) +{ +} +``` + +✅ Good: +```csharp +/// +/// Asynchronously retrieves a user by ID. +/// +/// The user's unique identifier. +/// +/// A task that represents the asynchronous operation. The task result contains +/// the if found; otherwise, . +/// +public Task GetUserAsync(int id) +{ +} +``` + +### Don't Forget CancellationToken Documentation + +```csharp +/// +/// Asynchronously processes all pending items. +/// +/// +/// A to observe while waiting for the task to complete. +/// +/// +/// A task that represents the asynchronous operation. The task result contains the +/// number of items processed. +/// +/// +/// Thrown when the operation is canceled via the . +/// +/// +/// The cancellation token is checked before processing each item. Partial results +/// are committed before cancellation. +/// +public async Task ProcessItemsAsync(CancellationToken cancellationToken = default) +{ +} +``` diff --git a/.claude/plugins/dotnet-documentation-expert/plugin.md b/.claude/plugins/dotnet-documentation-expert/plugin.md new file mode 100644 index 0000000..2896abc --- /dev/null +++ b/.claude/plugins/dotnet-documentation-expert/plugin.md @@ -0,0 +1,179 @@ +--- +name: dotnet-documentation-expert +description: Expert guidance for .NET API documentation. Use when writing or reviewing XML documentation comments, creating conceptual .mdz files, or working with DotNetDocs/Mintlify documentation. +--- + +# .NET Documentation Expert + +You are an expert in writing high-quality .NET API documentation and conceptual content. You help developers create comprehensive, clear, and maintainable documentation that follows Microsoft's documentation standards and integrates with DotNetDocs. + +## When to Use This Skill + +Use this skill when: +- Writing XML documentation comments for .NET code +- Reviewing documentation for quality and completeness +- Creating conceptual documentation (.mdz files) +- Working with DotNetDocs or Mintlify +- Need guidance on .NET documentation standards + +## Core Principles + +### Clarity First +Write simple, straightforward documentation. Avoid clever phrasing—users need clarity. + +### Show, Don't Tell +Provide code examples for non-trivial usage. Examples help more than prose alone. + +### Document the "Why" +Explain when to use something and why it exists, not just what it does. + +### Think Like a User +What would someone need to know to use this effectively? + +## Quick Start Templates + +### Class Documentation +```csharp +/// +/// [Provides/Represents/Manages] [what] for [purpose]. +/// +/// +/// [When to use, design decisions, or important details.] +/// +/// +/// +/// var instance = new MyClass(); +/// instance.DoSomething(); +/// +/// +public class MyClass { } +``` + +### Method Documentation +```csharp +/// +/// [Verb phrase describing the action.] +/// +/// The [what it represents]. [Constraints]. +/// +/// The [what is returned]. Returns if [condition]. +/// +/// +/// Thrown when is . +/// +public ReturnType MethodName(ParamType param1) { } +``` + +### Property Documentation +```csharp +/// +/// Gets or sets the [what this represents]. +/// +/// +/// The [description]. The default is [default value]. +/// +public string PropertyName { get; set; } +``` + +## Essential Guidelines + +**Summary Tags** +- Start methods with verbs: "Gets", "Creates", "Calculates" +- Start types with nouns: "Represents", "Provides", "Manages" +- Keep to 1-2 sentences +- Focus on *what* it IS or DOES + +**Remarks Tags** +- Implementation details that affect usage +- Performance characteristics +- Thread safety guarantees +- Design rationale + +**Example Tags** +- Realistic, runnable code +- Common use cases +- Expected output when helpful + +**Parameter & Returns** +- Be specific about what parameters represent +- Mention valid ranges and null handling +- Describe what is returned and when + +**Exceptions** +- Document all exceptions thrown directly by your method + +## Project Standards (CLAUDE.md) + +- Extensive XML doc comments for all public APIs +- Include `` and `` tags where applicable +- `` tags on same line as content +- `` tag last before member declaration +- Use `` for null references +- Document nullable return types explicitly + +## Conceptual Documentation (.mdz Files) + +DotNetDocs supports conceptual docs organized by namespace/type/member: + +``` +conceptual/ +├── MyNamespace/ +│ ├── usage.mdz # How to use +│ ├── examples.mdz # Extended examples +│ ├── best-practices.mdz # Recommendations +│ ├── patterns.mdz # Common patterns +│ └── considerations.mdz # Important notes +``` + +## Supplementary Resources + +For detailed guidance on specific topics, reference these files: + +**xml-templates.md** - Complete templates for: +- Generic types and type parameters +- Async methods and cancellation tokens +- Extension methods +- Events and delegates +- Enumerations + +**best-practices.md** - Detailed guidance on: +- Microsoft .NET documentation standards +- Modern C# features (pattern matching, records) +- Cross-referencing with `` and `` +- Thread safety and performance documentation + +**EXAMPLES.md** - Comprehensive real-world examples: +- Service classes and repositories +- Configuration classes +- Complete conceptual documentation + +## How to Apply This Skill + +When asked to document code: +1. Identify the member type (class, method, property, etc.) +2. Apply the appropriate template +3. Fill in specific details based on the code +4. Add examples for non-trivial cases +5. Check against project standards + +When asked to review documentation: +1. Check for completeness (all required tags present) +2. Verify clarity and accuracy +3. Ensure examples are runnable +4. Validate against project standards +5. Suggest specific improvements + +When asked about .mdz files: +1. Explain the conceptual documentation structure +2. Suggest appropriate file organization +3. Provide content templates +4. Reference EXAMPLES.md for complete examples + +## Progressive Context Loading + +This skill uses progressive disclosure: +- **Level 1** (Always loaded): Name and description (YAML frontmatter) +- **Level 2** (When skill triggered): This core guidance and quick templates +- **Level 3+** (As needed): Reference xml-templates.md, best-practices.md, EXAMPLES.md + +Read supplementary files only when specific detailed guidance is needed for the current task. diff --git a/.claude/plugins/dotnet-documentation-expert/xml-templates.md b/.claude/plugins/dotnet-documentation-expert/xml-templates.md new file mode 100644 index 0000000..1ccc953 --- /dev/null +++ b/.claude/plugins/dotnet-documentation-expert/xml-templates.md @@ -0,0 +1,530 @@ +# XML Documentation Templates + +Complete templates for all .NET member types. Reference this file when you need detailed templates beyond the quick start guide. + +## Generic Types + +### Generic Class with Constraints + +```csharp +/// +/// Represents a generic repository for entity operations. +/// +/// +/// The type of entity stored in the repository. Must implement . +/// +/// +/// The type of the entity's primary key. Must be a value type. +/// +/// +/// This repository provides standard CRUD operations with support for async operations, +/// query expression support, and unit of work pattern integration. +/// +/// Thread Safety: This class is not thread-safe. Use one instance per unit of work. +/// +/// +public class Repository + where TEntity : class, IEntity + where TKey : struct +{ +} +``` + +### Generic Method + +```csharp +/// +/// Converts the collection to a different type using the specified converter function. +/// +/// The type of elements in the source collection. +/// The type of elements in the result collection. +/// The source collection to convert. Cannot be . +/// The function to convert each element. Cannot be . +/// +/// A new collection containing the converted elements. +/// +/// +/// Thrown when or is . +/// +public IEnumerable Convert( + IEnumerable source, + Func converter) +{ +} +``` + +## Async Methods + +### Async Method with CancellationToken + +```csharp +/// +/// Asynchronously retrieves user data from the database. +/// +/// The unique identifier of the user to retrieve. +/// +/// A to observe while waiting for the task to complete. +/// +/// +/// A task that represents the asynchronous operation. The task result contains the +/// if found; otherwise, . +/// +/// +/// Thrown when the operation is canceled via the . +/// +/// +/// Thrown when a database error occurs during the operation. +/// +/// +/// This method uses async/await for non-blocking I/O operations. +/// The cancellation token is propagated to the underlying database query. +/// +/// +/// +/// var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30)); +/// try +/// { +/// var user = await GetUserAsync(123, cts.Token); +/// if (user is not null) +/// { +/// Console.WriteLine($"Found: {user.DisplayName}"); +/// } +/// } +/// catch (OperationCanceledException) +/// { +/// Console.WriteLine("Operation timed out"); +/// } +/// +/// +public async Task GetUserAsync( + int userId, + CancellationToken cancellationToken = default) +{ +} +``` + +### Async Void Method (Event Handlers Only) + +```csharp +/// +/// Handles the button click event asynchronously. +/// +/// The source of the event. +/// The event data. +/// +/// This async void method is acceptable only as an event handler. +/// Exceptions thrown from this method cannot be caught by the caller. +/// +private async void OnButtonClick(object sender, EventArgs e) +{ +} +``` + +## Extension Methods + +### Basic Extension Method + +```csharp +/// +/// Converts the string to title case where the first letter of each word is capitalized. +/// +/// The string to convert. Cannot be . +/// +/// A new string in title case. Returns an empty string if is empty. +/// +/// +/// Thrown when is . +/// +/// +/// This extension method preserves whitespace and punctuation. +/// Words are defined as sequences of characters separated by whitespace. +/// +/// +/// +/// string title = "the quick brown fox".ToTitleCase(); +/// Console.WriteLine(title); +/// // Output: The Quick Brown Fox +/// +/// +public static string ToTitleCase(this string value) +{ +} +``` + +### Extension Method with Additional Parameters + +```csharp +/// +/// Truncates the string to the specified maximum length and appends an ellipsis if truncated. +/// +/// The string to truncate. Cannot be . +/// The maximum length including the ellipsis. Must be at least 3. +/// The ellipsis string to append. Defaults to "...". +/// +/// The truncated string with ellipsis if the original exceeds ; +/// otherwise, the original string. +/// +/// +/// Thrown when or is . +/// +/// +/// Thrown when is less than the ellipsis length. +/// +public static string Truncate( + this string value, + int maxLength, + string ellipsis = "...") +{ +} +``` + +## Events and Delegates + +### Event with Custom EventArgs + +```csharp +/// +/// Occurs when an order has been successfully processed and completed. +/// +/// +/// Subscribers receive containing the completed order +/// and completion timestamp. +/// +/// This event is raised after payment confirmation and before shipping notification. +/// Event handlers are invoked synchronously in registration order. +/// +/// +/// Thread Safety: This event can be raised from any thread. Subscribers must handle +/// their own thread synchronization if necessary. +/// +/// +/// +/// +/// var processor = new OrderProcessor(); +/// processor.OrderCompleted += (sender, e) => +/// { +/// Console.WriteLine($"Order {e.Order.Id} completed at {e.CompletedAt}"); +/// }; +/// +/// await processor.ProcessOrderAsync(myOrder); +/// +/// +public event EventHandler? OrderCompleted; +``` + +### Custom Delegate + +```csharp +/// +/// Represents a method that validates an entity before saving. +/// +/// The type of entity to validate. +/// The entity to validate. +/// +/// if the entity is valid; otherwise, . +/// +/// +/// Validators should not throw exceptions. Return for invalid entities. +/// +public delegate bool EntityValidator(T entity) where T : class; +``` + +## Enumerations + +### Simple Enumeration + +```csharp +/// +/// Specifies the current status of an order in the processing pipeline. +/// +/// +/// Orders progress through states: Pending → Processing → Shipped → Delivered. +/// Orders can transition to Cancelled from any state except Delivered. +/// +public enum OrderStatus +{ + /// + /// The order has been created but not yet processed. + /// Payment authorization is pending. + /// + Pending = 0, + + /// + /// The order is currently being processed. + /// Payment has been authorized and inventory is being allocated. + /// + Processing = 1, + + /// + /// The order has been shipped to the customer. + /// Tracking information is available. + /// + Shipped = 2, + + /// + /// The order has been delivered to the customer. + /// This is a terminal state - no further transitions are allowed. + /// + Delivered = 3, + + /// + /// The order has been cancelled. + /// If payment was captured, a refund has been initiated. + /// + Cancelled = 4 +} +``` + +### Flags Enumeration + +```csharp +/// +/// Specifies the file access permissions that can be combined. +/// +/// +/// This enumeration supports bitwise combination of its member values. +/// Multiple permissions can be combined using the | operator. +/// +/// +/// +/// var permissions = FilePermissions.Read | FilePermissions.Write; +/// if (permissions.HasFlag(FilePermissions.Read)) +/// { +/// Console.WriteLine("Has read permission"); +/// } +/// +/// +[Flags] +public enum FilePermissions +{ + /// + /// No permissions granted. + /// + None = 0, + + /// + /// Permission to read the file. + /// + Read = 1, + + /// + /// Permission to write to the file. + /// + Write = 2, + + /// + /// Permission to execute the file. + /// + Execute = 4, + + /// + /// All permissions (read, write, and execute). + /// + All = Read | Write | Execute +} +``` + +## Interfaces + +### Interface with Multiple Methods + +```csharp +/// +/// Defines operations for managing user accounts and authentication. +/// +/// +/// Implementations of this interface provide user management functionality including: +/// +/// User authentication and session management +/// Profile creation and updates +/// Password management and resets +/// Role and permission assignment +/// +/// +public interface IUserService +{ + /// + /// Asynchronously authenticates a user with their credentials. + /// + /// The username. Cannot be or whitespace. + /// The password. Cannot be or whitespace. + /// + /// A to observe while waiting for the task to complete. + /// + /// + /// A task that represents the asynchronous operation. The task result contains the + /// authenticated if credentials are valid; otherwise, . + /// + Task AuthenticateAsync( + string username, + string password, + CancellationToken cancellationToken = default); +} +``` + +## Indexers + +### Basic Indexer + +```csharp +/// +/// Gets or sets the element at the specified index. +/// +/// The zero-based index of the element to get or set. +/// +/// The element at the specified index. +/// +/// +/// Thrown when is less than 0 or greater than or equal to . +/// +/// +/// This indexer provides direct access to the underlying collection. +/// Modifications through this indexer are immediately reflected in the collection. +/// +public T this[int index] +{ + get { } + set { } +} +``` + +### Multi-Parameter Indexer + +```csharp +/// +/// Gets or sets the value at the specified row and column. +/// +/// The zero-based row index. +/// The zero-based column index. +/// +/// The value at the specified position. +/// +/// +/// Thrown when or is out of range. +/// +public T this[int row, int column] +{ + get { } + set { } +} +``` + +## Structs and Records + +### Struct + +```csharp +/// +/// Represents a point in 2D space with X and Y coordinates. +/// +/// +/// This is a value type and should be passed by value or by readonly reference. +/// The struct is immutable to ensure thread safety and predictable behavior. +/// +/// +/// +/// var point = new Point(10, 20); +/// Console.WriteLine($"X: {point.X}, Y: {point.Y}"); +/// +/// +public readonly struct Point +{ + /// + /// Gets the X coordinate. + /// + /// + /// The X coordinate value. + /// + public int X { get; } + + /// + /// Gets the Y coordinate. + /// + /// + /// The Y coordinate value. + /// + public int Y { get; } + + /// + /// Initializes a new instance of the struct. + /// + /// The X coordinate. + /// The Y coordinate. + public Point(int x, int y) + { + X = x; + Y = y; + } +} +``` + +### Record + +```csharp +/// +/// Represents an immutable user profile with email and display name. +/// +/// The user's email address. Cannot be or whitespace. +/// The user's display name. Cannot be or whitespace. +/// +/// This record provides value-based equality comparison and is immutable by default. +/// Use the with expression to create modified copies. +/// +/// +/// +/// var profile = new UserProfile("user@example.com", "John Doe"); +/// var updated = profile with { DisplayName = "Jane Doe" }; +/// +/// +public record UserProfile(string Email, string DisplayName); +``` + +## Operators + +### Operator Overload + +```csharp +/// +/// Adds two instances. +/// +/// The first vector to add. +/// The second vector to add. +/// +/// A new that is the sum of and . +/// +/// +/// This operator performs component-wise addition of the two vectors. +/// +public static Vector operator +(Vector left, Vector right) +{ +} +``` + +## Finalizers and Dispose + +### IDisposable Implementation + +```csharp +/// +/// Releases all resources used by this instance. +/// +/// +/// This method should be called when you are finished using this object. +/// After calling this method, the object should not be used again. +/// +/// This method can be called multiple times safely. Subsequent calls have no effect. +/// +/// +/// +/// +/// using (var resource = new MyResource()) +/// { +/// // Use the resource +/// } +/// // Dispose is called automatically at the end of the using block +/// +/// +public void Dispose() +{ +} +``` diff --git a/.claude/settings.local.json b/.claude/settings.local.json index c937651..c3e5581 100644 --- a/.claude/settings.local.json +++ b/.claude/settings.local.json @@ -37,7 +37,12 @@ "WebFetch(domain:stackoverflow.com)", "WebFetch(domain:www.nuget.org)", "Bash(git fetch:*)", - "Bash(ls:*)" + "Bash(ls:*)", + "WebFetch(domain:www.anthropic.com)", + "WebFetch(domain:mintlify.com)", + "Bash(cmd /c \"dir C:\\Users\\RobertMcLaws\\.nuget\\packages\\dotnetdocs.sdk\")", + "Bash(cmd /c \"dir C:\\Users\\RobertMcLaws\\.nuget\\packages\\dotnetdocs.sdk\\ 2>&1\")", + "Bash(powershell:*)" ], "deny": [], "ask": [], diff --git a/.github/dependabot.yml b/.github/dependabot.yml index de1b4a2..1c0b884 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -30,6 +30,7 @@ updates: prefix: "chore" include: "scope" ignore: - # Don't update Microsoft.Build.NoTargets as it's pinned for SDK compatibility - - dependency-name: "Microsoft.Build.NoTargets" - update-types: ["version-update:semver-major", "version-update:semver-minor"] \ No newline at end of file + # Don't update FluentAssertions + - dependency-name: "FluentAssertions" + # Don't update Microsoft.Build.* packages as they're pinned for SDK compatibility + - dependency-name: "Microsoft.Build.*" \ No newline at end of file diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 11d50ae..0b668f5 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -32,7 +32,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v6 with: fetch-depth: 0 # Full history for versioning @@ -199,7 +199,7 @@ jobs: run: dotnet pack ${{ env.SOLUTION_FILE }} --configuration Release --no-build --output ./artifacts /p:PackageVersion=${{ steps.version.outputs.VERSION }} - name: Upload artifacts - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v6 with: name: nuget-packages path: ./artifacts/*.nupkg @@ -217,7 +217,7 @@ jobs: uses: actions/checkout@v5 - name: Download artifacts - uses: actions/download-artifact@v5 + uses: actions/download-artifact@v7 with: name: nuget-packages path: ./artifacts @@ -371,7 +371,7 @@ jobs: uses: actions/checkout@v5 - name: Download artifacts - uses: actions/download-artifact@v5 + uses: actions/download-artifact@v7 with: name: nuget-packages path: ./artifacts diff --git a/.github/workflows/pr-validation.yml b/.github/workflows/pr-validation.yml index 92c46d5..f34591e 100644 --- a/.github/workflows/pr-validation.yml +++ b/.github/workflows/pr-validation.yml @@ -24,7 +24,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v6 with: fetch-depth: 0 # Full history for versioning @@ -155,7 +155,7 @@ jobs: run: dotnet pack ${{ env.SOLUTION_FILE }} --configuration Release --no-build --output ./artifacts /p:PackageVersion=${{ steps.version.outputs.VERSION }} - name: Upload artifacts - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v6 with: name: nuget-packages-pr path: ./artifacts/*.nupkg diff --git a/rebuild-docs.ps1 b/rebuild-docs.ps1 index f4ef6cc..e08be67 100644 --- a/rebuild-docs.ps1 +++ b/rebuild-docs.ps1 @@ -75,7 +75,7 @@ Write-Host "" Write-Host "Step 2: Cleaning up build artifacts..." -ForegroundColor Yellow try { # Check if EasyAF.Tools is installed - $easyAfCheck = & dotnet tool list --global | Select-String "easyaf.tools" + $easyAfCheck = & dotnet tool list --global | Select-String "easyaf" if ($easyAfCheck) { Write-Host " Running dotnet easyaf cleanup..." -ForegroundColor Gray & dotnet easyaf cleanup diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection.slnx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection.slnx new file mode 100644 index 0000000..9b9d216 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection.slnx @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/CloudNimble.DotNetDocs.Reference.Collection.docsproj b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/CloudNimble.DotNetDocs.Reference.Collection.docsproj new file mode 100644 index 0000000..3ef4a51 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/CloudNimble.DotNetDocs.Reference.Collection.docsproj @@ -0,0 +1,36 @@ + + + + Mintlify + true + Folder + true + + false + false + + + Collection Test + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + + + + index;quickstart + + + + + + + + + + + + \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/assembly-list.txt b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/assembly-list.txt new file mode 100644 index 0000000..e69de29 diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/docs.json b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/docs.json new file mode 100644 index 0000000..af90120 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/docs.json @@ -0,0 +1,349 @@ +{ + "colors": { + "dark": "#3CD0E2", + "light": "#419AC5", + "primary": "#419AC5" + }, + "name": "Collection Test", + "navigation": { + "tabs": [ + { + "tab": "Home", + "pages": [ + { + "group": "Getting Started", + "icon": "stars", + "pages": [ + "index", + "quickstart" + ] + }, + { + "group": "Guides", + "pages": [ + "guides/index" + ] + } + ] + }, + { + "tab": "Test Collection", + "href": "test", + "pages": [ + { + "group": "Getting Started", + "icon": "stars", + "pages": [ + "test/index", + "test/why-dotnetdocs", + "test/quickstart" + ] + }, + { + "group": "Guides", + "icon": "dog-leashed", + "pages": [ + "test/guides/index", + "test/guides/pipeline", + "test/guides/conceptual-docs", + "test/guides/deployment", + "test/guides/cli-reference", + "test/guides/collections", + "test/guides/docsproj", + "test/guides/path-rewriting-test" + ] + }, + { + "group": "Providers", + "icon": "books", + "pages": [ + "test/providers/index", + { + "group": "Mintlify", + "tag": "PARTNER", + "icon": "/images/icons/mintlify.svg", + "pages": [ + "test/providers/mintlify/index", + "test/providers/mintlify/navigation", + "test/providers/mintlify/dotnet-library" + ] + } + ] + }, + { + "group": "Plugins", + "icon": "outlet", + "pages": [ + "test/plugins/index" + ] + }, + { + "group": "Learnings", + "icon": "chalkboard-user", + "pages": [ + "test/learnings/bridge-assemblies", + "test/learnings/sdk-packaging", + "test/learnings/converter-infinite-recursion" + ] + }, + { + "group": "API Reference", + "icon": "code", + "pages": [ + { + "group": "CloudNimble", + "icon": "folder-tree", + "pages": [ + { + "group": "DotNetDocs", + "icon": "folder-tree", + "pages": [ + { + "group": "Core", + "icon": "folder-tree", + "pages": [ + "test/api-reference/CloudNimble/DotNetDocs/Core/index", + "test/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager", + "test/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocConstants", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocEnum", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocException", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocMember", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocParameter", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocReference", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocType", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager", + "test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference", + "test/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher", + "test/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler", + "test/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer", + "test/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer", + "test/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler", + "test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext", + "test/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType", + { + "group": "Configuration", + "icon": "folder-tree", + "pages": [ + "test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/index", + "test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder", + "test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions", + "test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode", + "test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType", + "test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType" + ] + }, + { + "group": "Renderers", + "icon": "folder-tree", + "pages": [ + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/index", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer", + { + "group": "YamlConverters", + "icon": "folder-tree", + "pages": [ + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/index", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter", + "test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter" + ] + } + ] + }, + { + "group": "Transformers", + "icon": "folder-tree", + "pages": [ + "test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/index", + "test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer" + ] + } + ] + }, + { + "group": "Mintlify", + "icon": "folder-tree", + "pages": [ + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/index", + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig", + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler", + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons", + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer", + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions", + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode", + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType", + { + "group": "Transformers", + "icon": "folder-tree", + "pages": [ + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/index", + "test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer" + ] + } + ] + } + ] + } + ] + }, + { + "group": "Microsoft", + "icon": "folder-tree", + "pages": [ + { + "group": "Extensions", + "icon": "folder-tree", + "pages": [ + { + "group": "DependencyInjection", + "icon": "folder-tree", + "pages": [ + "test/api-reference/Microsoft/Extensions/DependencyInjection/index", + "test/api-reference/Microsoft/Extensions/DependencyInjection/IServiceCollection" + ] + } + ] + } + ] + }, + { + "group": "Mintlify", + "icon": "folder-tree", + "pages": [ + { + "group": "Core", + "icon": "folder-tree", + "pages": [ + "test/api-reference/Mintlify/Core/index", + "test/api-reference/Mintlify/Core/DocsJsonManager", + "test/api-reference/Mintlify/Core/DocsJsonValidator", + "test/api-reference/Mintlify/Core/MintlifyConstants", + "test/api-reference/Mintlify/Core/MintlifyOptions", + { + "group": "Converters", + "icon": "folder-tree", + "pages": [ + "test/api-reference/Mintlify/Core/Converters/index", + "test/api-reference/Mintlify/Core/Converters/ApiConfigConverter", + "test/api-reference/Mintlify/Core/Converters/BackgroundImageConverter", + "test/api-reference/Mintlify/Core/Converters/ColorConverter", + "test/api-reference/Mintlify/Core/Converters/IconConverter", + "test/api-reference/Mintlify/Core/Converters/NavigationJsonConverter", + "test/api-reference/Mintlify/Core/Converters/NavigationPageConverter", + "test/api-reference/Mintlify/Core/Converters/NavigationPageListConverter", + "test/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter", + "test/api-reference/Mintlify/Core/Converters/ServerConfigConverter" + ] + }, + { + "group": "Models", + "icon": "folder-tree", + "pages": [ + "test/api-reference/Mintlify/Core/Models/index", + "test/api-reference/Mintlify/Core/Models/AnchorConfig", + "test/api-reference/Mintlify/Core/Models/ApiConfig", + "test/api-reference/Mintlify/Core/Models/ApiExamplesConfig", + "test/api-reference/Mintlify/Core/Models/ApiParamsConfig", + "test/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig", + "test/api-reference/Mintlify/Core/Models/ApiSpecConfig", + "test/api-reference/Mintlify/Core/Models/AppearanceConfig", + "test/api-reference/Mintlify/Core/Models/BackgroundConfig", + "test/api-reference/Mintlify/Core/Models/BackgroundImageConfig", + "test/api-reference/Mintlify/Core/Models/BannerConfig", + "test/api-reference/Mintlify/Core/Models/ColorConfig", + "test/api-reference/Mintlify/Core/Models/ColorPairConfig", + "test/api-reference/Mintlify/Core/Models/ColorsConfig", + "test/api-reference/Mintlify/Core/Models/ContextualConfig", + "test/api-reference/Mintlify/Core/Models/DocsJsonConfig", + "test/api-reference/Mintlify/Core/Models/DropdownConfig", + "test/api-reference/Mintlify/Core/Models/Error404Config", + "test/api-reference/Mintlify/Core/Models/ErrorsConfig", + "test/api-reference/Mintlify/Core/Models/FaviconConfig", + "test/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter", + "test/api-reference/Mintlify/Core/Models/FontsConfig", + "test/api-reference/Mintlify/Core/Models/FooterConfig", + "test/api-reference/Mintlify/Core/Models/FooterLink", + "test/api-reference/Mintlify/Core/Models/FooterLinkGroup", + "test/api-reference/Mintlify/Core/Models/FrontMatterConfig", + "test/api-reference/Mintlify/Core/Models/GlobalAnchorConfig", + "test/api-reference/Mintlify/Core/Models/GlobalDropdownConfig", + "test/api-reference/Mintlify/Core/Models/GlobalLanguageConfig", + "test/api-reference/Mintlify/Core/Models/GlobalNavigationConfig", + "test/api-reference/Mintlify/Core/Models/GlobalTabConfig", + "test/api-reference/Mintlify/Core/Models/GlobalVersionConfig", + "test/api-reference/Mintlify/Core/Models/GroupConfig", + "test/api-reference/Mintlify/Core/Models/IconConfig", + "test/api-reference/Mintlify/Core/Models/IconsConfig", + "test/api-reference/Mintlify/Core/Models/IntegrationsConfig", + "test/api-reference/Mintlify/Core/Models/InteractionConfig", + "test/api-reference/Mintlify/Core/Models/LanguageConfig", + "test/api-reference/Mintlify/Core/Models/LogoConfig", + "test/api-reference/Mintlify/Core/Models/MdxAuthConfig", + "test/api-reference/Mintlify/Core/Models/MdxConfig", + "test/api-reference/Mintlify/Core/Models/MenuConfig", + "test/api-reference/Mintlify/Core/Models/MergeOptions", + "test/api-reference/Mintlify/Core/Models/NavbarConfig", + "test/api-reference/Mintlify/Core/Models/NavbarLink", + "test/api-reference/Mintlify/Core/Models/NavigationConfig", + "test/api-reference/Mintlify/Core/Models/NavigationContainerBase", + "test/api-reference/Mintlify/Core/Models/NavigationItemBase", + "test/api-reference/Mintlify/Core/Models/NavigationSectionBase", + "test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig", + "test/api-reference/Mintlify/Core/Models/ProductConfig", + "test/api-reference/Mintlify/Core/Models/RedirectConfig", + "test/api-reference/Mintlify/Core/Models/SearchConfig", + "test/api-reference/Mintlify/Core/Models/SeoConfig", + "test/api-reference/Mintlify/Core/Models/ServerConfig", + "test/api-reference/Mintlify/Core/Models/StylingConfig", + "test/api-reference/Mintlify/Core/Models/TabConfig", + "test/api-reference/Mintlify/Core/Models/VersionConfig", + { + "group": "Integrations", + "icon": "folder-tree", + "pages": [ + "test/api-reference/Mintlify/Core/Models/Integrations/index", + "test/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/FathomConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config", + "test/api-reference/Mintlify/Core/Models/Integrations/GtmConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/HeapConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/PirschConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig", + "test/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig" + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + }, + "$schema": "https://mintlify.com/docs.json", + "theme": "maple" +} \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/guides/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/guides/index.mdx new file mode 100644 index 0000000..e69de29 diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/hero-banner.png b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/hero-banner.png new file mode 100644 index 0000000..f3eac3c Binary files /dev/null and b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/hero-banner.png differ diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon-96x96.png b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon-96x96.png new file mode 100644 index 0000000..950afb2 Binary files /dev/null and b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon-96x96.png differ diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon.ico b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon.ico new file mode 100644 index 0000000..b9846c7 Binary files /dev/null and b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon.ico differ diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon.svg new file mode 100644 index 0000000..acfb87b --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/favicon.svg @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/mintlify.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/mintlify.svg new file mode 100644 index 0000000..c3d4030 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/icons/mintlify.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/cloudnimble.dark.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/cloudnimble.dark.svg new file mode 100644 index 0000000..db664aa --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/cloudnimble.dark.svg @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.dark.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.dark.svg new file mode 100644 index 0000000..ad43572 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.dark.svg @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.light.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.light.svg new file mode 100644 index 0000000..ea8ef85 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.light.svg @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.sticker.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.sticker.svg new file mode 100644 index 0000000..957930a --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/dotnetdocs.sticker.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/mintlify.dark.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/mintlify.dark.svg new file mode 100644 index 0000000..130211b --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/mintlify.dark.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/sustainment.dark.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/sustainment.dark.svg new file mode 100644 index 0000000..f0dbf88 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/logos/sustainment.dark.svg @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/mintlify-bg.svg b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/mintlify-bg.svg new file mode 100644 index 0000000..23cb213 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/mintlify-bg.svg @@ -0,0 +1,4701 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/screenshots/pipeline-output.png b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/screenshots/pipeline-output.png new file mode 100644 index 0000000..f3eac3c Binary files /dev/null and b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/images/test/screenshots/pipeline-output.png differ diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/index.mdx new file mode 100644 index 0000000..80a01a7 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/index.mdx @@ -0,0 +1,38 @@ +--- +title: CloudNimble.DotNetDocs Documentation +sidebarTitle: Home +description: Welcome to the CloudNimble.DotNetDocs documentation +icon: house +--- + +# CloudNimble.DotNetDocs + +Welcome to the CloudNimble.DotNetDocs documentation. This documentation is automatically generated from XML comments in the source code and kept up-to-date with every build. + +## Getting Started + + + + Learn about the motivation and design philosophy behind CloudNimble.DotNetDocs + + + Get up and running with CloudNimble.DotNetDocs in minutes + + + +## Features + +- Feature 1: Description +- Feature 2: Description +- Feature 3: Description + +## Documentation Sections + + + + Complete API documentation for all public types and members + + + Step-by-step guides and tutorials + + \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/quickstart.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/quickstart.mdx new file mode 100644 index 0000000..d18d37c --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/quickstart.mdx @@ -0,0 +1,74 @@ +--- +title: Getting Started with CloudNimble.DotNetDocs +sidebarTitle: Quickstart +description: Get up and running with CloudNimble.DotNetDocs in minutes +icon: play +--- + + + + + ### Install CloudNimble.DotNetDocs + + Install the NuGet package: + + ```bash + dotnet add package CloudNimble.DotNetDocs + ``` + + Or use the Package Manager Console: + + ```powershell + Install-Package CloudNimble.DotNetDocs + ``` + + + + + + ### Configure your application + + Add CloudNimble.DotNetDocs to your application's service collection: + + ```csharp + using CloudNimble.DotNetDocs; + + // In your Program.cs or Startup.cs + services.AddCloudNimbleDotNetDocs(); + ``` + + + Customize the configuration based on your needs. See the [Configuration Guide](/guides/configuration) for more options. + + + + + + + ### Start using CloudNimble.DotNetDocs + + Basic usage example: + + ```csharp + // Example code showing how to use CloudNimble.DotNetDocs + var service = serviceProvider.GetRequiredService(); + var result = await service.DoSomethingAsync(); + ``` + + + You're now ready to start using CloudNimble.DotNetDocs! Check out the [API Reference](/api-reference) for more details. + + + + + +## Next Steps + + + + Explore the complete API documentation + + + Learn more with detailed guides and tutorials + + \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/CTASection.jsx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/CTASection.jsx new file mode 100644 index 0000000..46e8680 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/CTASection.jsx @@ -0,0 +1,92 @@ +export const CTASection = () => { + const [animationsStarted, setAnimationsStarted] = React.useState(false); + + React.useEffect(() => { + setAnimationsStarted(true); + }, []); + + return ( +
+
+

+ Ready to Ship Better Docs? +

+
+ Start building beautiful docs in less than 5 minutes. +
+ + + {/* Quick install */} +
+

+ Quick Install +

+ + dotnet tool install DotNetDocs --global + +
+
+
+ ); +}; \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/FeatureShowcase.jsx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/FeatureShowcase.jsx new file mode 100644 index 0000000..a57bee5 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/FeatureShowcase.jsx @@ -0,0 +1,221 @@ +export const FeatureShowcase = () => { + const [animationsStarted, setAnimationsStarted] = React.useState(false); + + React.useEffect(() => { + setAnimationsStarted(true); + }, []); + + const features = [ + { + icon: 'layer-group', + iconType: 'duotone', + title: 'Integrated Conceptual Docs', + description: 'Weave in generated & written docs without losing your work', + color: '#3CD0E2', + details: 'Content on how to use an API, best practices, and more do not belong in your code files. Expertly weave your API & Conceptual docs and regenerate without losing your hard work.' + }, + { + icon: 'gears', + iconType: 'duotone', + title: 'Native MSBuild Integration', + description: 'Automatically updates your Docs every time you compile', + color: '#3CD0E2', + details: 'Your docs are always up-to-date, whether you compile in VS, with `dotnet build` or in your CI/CD pipeline. No external tools required.' + }, + { + icon: 'pipe-valve', + iconType: 'duotone', + title: 'Pluggable Pipeline', + description: 'Easily generate, merge, enrich, transform, and render your docs', + color: '#3CD0E2', + details: 'DotNetDocs is the last documentation system you\'ll ever need. Our modern pipeline is designed for the future with full extensibility.' + } + ]; + + return ( +
+ {/* Background decoration */} +
+ +
+ {/* Header with competitive edge */} +
+
+ Beyond DocFX +
+ +

+ + Features DocFX Can't Handle + +

+

+ While DocFX generates static API docs, DotNetDocs brings modern workflows, multiple output formats, and true integration with your development process +

+
+ + {/* Features Grid */} +
+ {features.map((feature, index) => ( +
+
+ +
+ +

+ {feature.title} +

+ +
+ {feature.description} +
+ +
+ {feature.details} +
+
+ ))} +
+ + {/* CTA */} + +
+ + +
+ ); +}; \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/MintlifyPartnership.jsx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/MintlifyPartnership.jsx new file mode 100644 index 0000000..ffd8566 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/MintlifyPartnership.jsx @@ -0,0 +1,425 @@ +export const MintlifyPartnership = () => { + const [animationsStarted, setAnimationsStarted] = React.useState(false); + + React.useEffect(() => { + setAnimationsStarted(true); + }, []); + + return ( +
+ {/* Mintlify aurora background */} +
+ +
+ {/* Partnership Badge */} +
+
+ + Official Partner +
+
+ + {/* Hero Title */} +
+

+ Better with Mintlify +

+

+ Why settle for static markdown when you can have interactive API docs, AI-powered search, custom components, and enterprise analytics? + Give your users the same experience as Coinbase, Vercel, Anthropic, and more. +

+
+ + {/* Main Content Grid */} +
+ {/* Left: Why Mintlify */} +
+
+
+ Mintlify +

+ Why Mintlify? +

+
+ +

+ GitHub Pages, Jekyll, and Hugo can't do this. +

+
+ +
+ {[ + { icon: 'robot', title: 'Built for People and AI', text: 'AI search, LLMS.txt, MCP support, and AI agents for writing' }, + { icon: 'code', title: 'OpenAPI Integration', text: 'Interactive REST API docs with live SDK examples and testing' }, + { icon: 'chart-line', title: 'Analytics & Insights', text: 'Track usage, search behavior, and user feedback' }, + { icon: 'shield-check', title: 'Enterprise Compliance', text: 'SOC 2, GDPR, and ISO 27001 certified for security teams' }, + { icon: 'lock', title: 'Granular Access Control', text: 'Secure access and provisioning with enterprise authentication' } + ].map((item, index) => ( +
+
+ +
+
+
+ {item.title} +
+
+ {item.text} +
+
+
+ ))} +
+
+ + {/* Right: DotNetDocs + Mintlify */} +
+
+

+ DotNetDocs + + DotNetDocs + Mintlify = Awesome + +

+ +

+ The magical duo for modern .NET documentation. +

+
+ +
+ {[ + { icon: 'file-code', title: 'MDX with Frontmatter', text: 'Auto-generated frontmatter w/ icons, tags, SEO metadata, & keywords' }, + { icon: 'diagram-project', title: 'Rich Components', text: 'Custom React components, Mermaid diagrams, interactive elements' }, + { icon: 'sitemap', title: 'Smart Navigation', text: 'Auto-generated docs.json w/ hierarchical namespace navigation' }, + { icon: 'icons', title: 'Context-Aware Icons', text: 'FontAwesome icons for all object types' }, + { icon: 'magnifying-glass', title: 'Enhanced Discoverability', text: 'SEO-optimized descriptions, keywords, and wide mode' }, + ].map((item, index) => ( +
+
+ +
+
+
+ {item.title} +
+
+ {item.text} +
+
+
+ ))} +
+
+
+ + {/* Logos */} +
+

+ Trusted by innovative teams +

+
+ {['Anthropic', 'Vercel', 'PayPal', 'Coinbase', 'LinkedIn', 'X'].map((company, index) => ( +
+ {company} +
+ ))} +
+
+ + {/* CTA */} + +
+ + +
+ ); +}; diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/SaaSHero.jsx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/SaaSHero.jsx new file mode 100644 index 0000000..3e43c2d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/SaaSHero.jsx @@ -0,0 +1,399 @@ +export const SaaSHero = () => { + const [animationsStarted, setAnimationsStarted] = React.useState(false); + + React.useEffect(() => { + setAnimationsStarted(true); + }, []); + + return ( +
+ {/* Animated gradient orbs */} +
+ +
+ + {/* Grid pattern */} +
+ + {/* Content */} +
+
+ {/* Left content */} +
+ {/* Logo */} +
+ DotNetDocs +
+ + + + {/*https://codepen.io/alvarotrigo/pen/KKLqPqL*/} +

+ Documentation + + That  + + Lives + Builds + Ships + + + With Your Code +

+ +
+

+ Turn your amazing .NET projects into stunning AI-ready documentation sites.  + Zero config. Full control. Built for developers. +

+
+ + + + {/* Created By & Sponsors */} + +
+ + {/* Right content - Interactive demo */} +
+ {/* Code window */} +
+
+
+
+
+
+
+ MyProject.cs +
+ +
+
/// <summary>
+
/// Processes payment transactions
+
/// </summary>
+
+ /// <param + name + = + "amount" + >The transaction amount to process</param> +
+
+ /// <returns>A <see + cref + = + "PaymentResult" + /> indicating success or failure</returns> +
+
+ public + async + Task + < + PaymentResult + > + ProcessPayment + ( + decimal + amount + ) +
+
{'{'}
+
+ return + await + _processor + . + Execute + ( + amount + ); +
+
{'}'}
+
+
+ + {/* Floating badges */} +
+ AI-Ready Docs +
+ +
+ Zero Config +
+
+
+
+
+ ); +}; \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/ValueProposition.jsx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/ValueProposition.jsx new file mode 100644 index 0000000..c475c84 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/snippets/test/ValueProposition.jsx @@ -0,0 +1,497 @@ +export const ValueProposition = ({ minimal = false, minCardWidth = 360, gap = 40 }) => { + const [animationsStarted, setAnimationsStarted] = React.useState(false); + + React.useEffect(() => { + setAnimationsStarted(true); + }, []); + + const values = [ + { + icon: 'sidebar-flip', + iconType: 'duotone', + number: '01', + title: 'Bring any docs into Visual Studio', + description: 'The new .docsproj Projects + the DotNetDocs.Sdk bring your docs for Mintlify, DocFX, MkDocs, Jekyll, Hugo, and more right into your VS and VSCode solutions.', + gradient: 'linear-gradient(135deg, #3CD0E2, #2BA8C7)' + }, + { + icon: 'file-code', + iconType: 'duotone', + number: '02', + title: 'Add real-time API reference docs', + description: 'Automatically transform your .NET XML Documentation Comments into beautiful, searchable API reference docs that stay in sync with every build.', + gradient: 'linear-gradient(135deg, #419AC5, #2D7BA8)' + }, + { + icon: 'rocket-launch', + iconType: 'duotone', + number: '03', + title: 'Build & deploy anywhere', + description: 'Your docs, your way. Deploy to Mintlify, GitHub Pages, Netlify, Vercel, or any static hosting. Full MSBuild integration means your CI/CD pipeline is already ready.', + gradient: 'linear-gradient(135deg, #3CD0E2, #419AC5)' + } + ]; + + // Value prop cards (reused in both modes) + const valueCards = ( +
+ {values.map((value, index) => ( +
+ {/* Card background (gradient + mesh + grid) - only in minimal mode */} + {minimal && ( +
+ {/* Linear gradient */} +
+ + {/* Mesh gradient */} +
+ + {/* Animated grid */} +
+
+ )} + + {/* Animated border gradient */} +
+ + {/* Card background glow */} +
+ + {/* Number badge */} +
+ {value.number} +
+ +
+ {/* Icon */} +
+ +
+ + {/* Title */} +

+ {value.title} +

+ + {/* Description */} +

+ {value.description} +

+
+
+ ))} +
+ ); + + // Minimal mode: just the cards + if (minimal) { + return ( + <> + {valueCards} + + + ); + } + + // Full marketing mode: background, header, cards, footer + return ( +
+ {/* Dramatic mesh gradient background */} +
+ + {/* Animated grid pattern */} +
+ + {/* Floating orbs */} +
+
+ +
+ {/* Header with dramatic typography */} +
+
+ Why DotNetDocs +
+ +

+ + Make Documentation a Joy + + + Not a Chore + +

+ +
+ + {/* Value propositions with stunning cards */} + {valueCards} + + {/* Bottom tagline */} +
+
+ +

+ Give devs the experience they deserve. +

+

+ No more context switching. No more outdated docs. Just seamless, integrated documentation that grows with your codebase. +

+
+
+ + +
+ ); +}; diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/style.css b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/style.css new file mode 100644 index 0000000..20de4da --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/style.css @@ -0,0 +1,57 @@ +/* Custom styles for your documentation site */ + +/* Fix rendering in headers */ +h1 > span.cursor-pointer > svg.icon.inline, +h2 > span.cursor-pointer > svg.icon.inline, +h3 > span.cursor-pointer > svg.icon.inline { + padding-right: 8px; + vertical-align: top !important; +} + +/* Custom scrollbar styling */ +::-webkit-scrollbar { + width: 8px; +} + + ::-webkit-scrollbar:horizontal { + height: 8px; + } + +::-webkit-scrollbar-track { + background: #0A1628; +} + +::-webkit-scrollbar-thumb { + background: linear-gradient(180deg, #3CD0E2, #419AC5); + border-radius: 6px; +} + + ::-webkit-scrollbar-thumb:hover { + background: linear-gradient(180deg, #419AC5, #3CD0E2); + } + +/* Smooth scrolling */ +html { + scroll-behavior: smooth; +} + +/* Animation keyframes */ +@keyframes fadeIn { + from { + opacity: 0; + transform: translateY(10px); + } + + to { + opacity: 1; + transform: translateY(0); + } +} + +code, kbd, pre, samp { + font-family: "Cascadia Code",var(--font-jetbrains-mono),ui-monospace,SFMono-Regular,Menlo,Monaco,"Liberation Mono","Courier New",monospace; + font-feature-settings: normal; + font-variation-settings: normal; + font-size: 1em; + line-height: 1.5em; +} \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager.mdx new file mode 100644 index 0000000..9b57f9b --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager.mdx @@ -0,0 +1,332 @@ +--- +title: AssemblyManager +description: "Manages assembly metadata extraction using Roslyn for API documentation generation." +icon: file-brackets-curly +keywords: ['AssemblyManager', 'CloudNimble.DotNetDocs.Core.AssemblyManager', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object', 'System.IDisposable'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.AssemblyManager +``` + +## Summary + +Manages assembly metadata extraction using Roslyn for API documentation generation. + +## Remarks + +Extracts metadata from a single .NET assembly and its XML documentation file, building an in-memory model + ([DocAssembly](/test/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly)) with interconnected types, members, and parameters. Supports conceptual content + loading from a specified folder. Designed for multi-targeting .NET 10.0, 9.0, and 8.0. One instance per assembly + is required, with paths specified at construction for incremental build support. Implements [IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable) + to release memory used by the compilation and model. + +## Examples + +```csharp +using var manager = new AssemblyManager("MyLib.dll", "MyLib.xml"); +var context = new ProjectContext("ref1.dll", "ref2.dll") { ConceptualPath = "conceptual" }; +var model = await manager.DocumentAsync(context); +``` + +## Constructors + +### .ctor + +Initializes a new instance of [AssemblyManager](/test/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager) for a specific assembly. + +#### Syntax + +```csharp +public AssemblyManager(string assemblyPath, string xmlPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `assemblyPath` | `string` | Path to the assembly DLL file. | +| `xmlPath` | `string` | Path to the XML documentation file. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when *assemblyPath* or *xmlPath* is null. | +| `ArgumentException` | Thrown when *assemblyPath* or *xmlPath* is empty or whitespace. | +| `FileNotFoundException` | Thrown when *assemblyPath* does not exist. | + +#### Remarks + +If the XML documentation file does not exist, processing will continue without XML documentation. + A warning will be added to the Errors collection. + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AssemblyName + +Gets the name of the assembly (without extension). + +#### Syntax + +```csharp +public string AssemblyName { get; init; } +``` + +#### Property Value + +Type: `string` + +### AssemblyPath + +Gets the path to the assembly DLL file. + +#### Syntax + +```csharp +public string AssemblyPath { get; init; } +``` + +#### Property Value + +Type: `string` + +### Document + +Gets the current documentation model for the processed assembly. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.DocAssembly Document { get; private set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.DocAssembly?` + +### Errors + +Gets the collection of errors that occurred during Since processing. + +#### Syntax + +```csharp +public System.Collections.Generic.List Errors { get; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` + +#### Remarks + +Includes warnings about inaccessible internal members when requested but not available. + +### LastModified + +Gets the last modified timestamp of the assembly file for incremental builds. + +#### Syntax + +```csharp +public System.DateTime LastModified { get; private set; } +``` + +#### Property Value + +Type: `System.DateTime` + +### XmlPath + +Gets the path to the XML documentation file. + +#### Syntax + +```csharp +public string XmlPath { get; init; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +May be null if no XML documentation file is available. + +## Methods + +### Dispose + +Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + +#### Syntax + +```csharp +public void Dispose() +``` + +### DocumentAsync + +Documents the assembly asynchronously, building or rebuilding an in-memory model with metadata and documentation if necessary. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task DocumentAsync(CloudNimble.DotNetDocs.Core.ProjectContext projectContext = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `projectContext` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | Optional project context for referenced assemblies and conceptual content path. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous operation, containing the [DocAssembly](/test/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly) model. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- System.IDisposable + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder.mdx new file mode 100644 index 0000000..3f2f720 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder.mdx @@ -0,0 +1,576 @@ +--- +title: DotNetDocsBuilder +description: "Builder for configuring the DotNetDocs documentation pipeline." +icon: file-brackets-curly +keywords: ['DotNetDocsBuilder', 'CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Configuration + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder +``` + +## Summary + +Builder for configuring the DotNetDocs documentation pipeline. + +## Remarks + +Provides a fluent API for registering renderers, enrichers, transformers, + and configuring the documentation pipeline context. + +## Constructors + +### .ctor + +Initializes a new instance of the [DotNetDocsBuilder](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder) class. + +#### Syntax + +```csharp +public DotNetDocsBuilder(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection to configure. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when services is null. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### AddEnricher + +Adds a custom enricher to the pipeline. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder AddEnricher() where TEnricher : class, CloudNimble.DotNetDocs.Core.IDocEnricher +``` + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TEnricher` - The type of enricher to add. + +#### Examples + +```csharp +pipeline.AddEnricher<ConceptualContentEnricher>(); +``` + +#### Remarks + +Enrichers add conceptual content to documentation entities. + +### AddRenderer + +Adds a custom renderer to the pipeline. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder AddRenderer() where TRenderer : class, CloudNimble.DotNetDocs.Core.IDocRenderer +``` + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TRenderer` - The type of renderer to add. + +#### Examples + +```csharp +pipeline.AddRenderer<MyCustomRenderer>(); +``` + +#### Remarks + +Renderers generate output in specific formats (e.g., Markdown, JSON, YAML). + +### AddTransformer + +Adds a custom transformer to the pipeline. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder AddTransformer() where TTransformer : class, CloudNimble.DotNetDocs.Core.IDocTransformer +``` + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TTransformer` - The type of transformer to add. + +#### Examples + +```csharp +pipeline.AddTransformer<InheritDocTransformer>(); +``` + +#### Remarks + +Transformers modify the documentation model before rendering. + +### ConfigureContext + +Configures the ProjectContext for the pipeline. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder ConfigureContext(System.Action configure) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `configure` | `System.Action` | Action to configure the ProjectContext. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +pipeline.ConfigureContext(ctx => +{ + ctx.OutputPath = "docs/api"; + ctx.ShowPlaceholders = false; +}); +``` + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### UseJsonRenderer + +Adds the JSON renderer to the pipeline. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseJsonRenderer(System.Action configure = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `configure` | `System.Action?` | Optional action to configure JsonRendererOptions. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +pipeline.UseJsonRenderer(options => +{ + options.WriteIndented = true; + options.IncludeNullValues = false; +}); +``` + +### UseMarkdownRenderer + +Adds the Markdown renderer to the pipeline. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMarkdownRenderer() +``` + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +pipeline.UseMarkdownRenderer(); +``` + +#### Remarks + +Also registers MarkdownXmlTransformer to process XML documentation tags. + +### UseMintlifyRenderer Extension + +Extension method from `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions` + +Adds the Mintlify renderer to the documentation pipeline. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer() + .ConfigureContext(ctx => ctx.OutputPath = "docs/api"); +}); +``` + +#### Remarks + + + +This method registers: + + + + +### UseMintlifyRenderer Extension + +Extension method from `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions` + +Adds the Mintlify renderer to the documentation pipeline with configuration options. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder, System.Action configureMintlify) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer(options => + { + options.GenerateDocsJson = true; + options.IncludeIcons = true; + }) + .ConfigureContext(ctx => ctx.OutputPath = "docs/api"); +}); +``` + +#### Remarks + + + +This method registers: + + + + +### UseMintlifyRenderer Extension + +Extension method from `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions` + +Adds a custom Mintlify renderer implementation to the documentation pipeline. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer<CustomMintlifyRenderer>() + .ConfigureContext(ctx => ctx.OutputPath = "docs"); +}); +``` + +#### Remarks + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + +### UseMintlifyRenderer Extension + +Extension method from `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions` + +Adds a custom Mintlify renderer implementation to the documentation pipeline with configuration options. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder, System.Action configureMintlify) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer<CustomMintlifyRenderer>(options => + { + options.GenerateDocsJson = true; + }) + .ConfigureContext(ctx => ctx.OutputPath = "docs"); +}); +``` + +#### Remarks + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + +### UseYamlRenderer + +Adds the YAML renderer to the pipeline. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseYamlRenderer() +``` + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +pipeline.UseYamlRenderer(); +``` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsMintlify_DotNetDocsBuilderExtensions.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsMintlify_DotNetDocsBuilderExtensions.mdx new file mode 100644 index 0000000..2ad963d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsMintlify_DotNetDocsBuilderExtensions.mdx @@ -0,0 +1,218 @@ +--- +title: DotNetDocsMintlify_DotNetDocsBuilderExtensions +description: "Extension methods for adding Mintlify support to the DotNetDocs pipeline builder." +icon: bolt +sidebarTitle: DotNetDocsMintlify_DotNetDocsBuilderExtensions +tag: "STATIC" +keywords: ['DotNetDocsMintlify_DotNetDocsBuilderExtensions', 'CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Configuration + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions +``` + +## Summary + +Extension methods for adding Mintlify support to the DotNetDocs pipeline builder. + +## Methods + +### UseMintlifyRenderer + +Adds the Mintlify renderer to the documentation pipeline. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer() + .ConfigureContext(ctx => ctx.OutputPath = "docs/api"); +}); +``` + +#### Remarks + + + +This method registers: + + + + +### UseMintlifyRenderer + +Adds the Mintlify renderer to the documentation pipeline with configuration options. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder, System.Action configureMintlify) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer(options => + { + options.GenerateDocsJson = true; + options.IncludeIcons = true; + }) + .ConfigureContext(ctx => ctx.OutputPath = "docs/api"); +}); +``` + +#### Remarks + + + +This method registers: + + + + +### UseMintlifyRenderer + +Adds a custom Mintlify renderer implementation to the documentation pipeline. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer<CustomMintlifyRenderer>() + .ConfigureContext(ctx => ctx.OutputPath = "docs"); +}); +``` + +#### Remarks + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + +### UseMintlifyRenderer + +Adds a custom Mintlify renderer implementation to the documentation pipeline with configuration options. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder, System.Action configureMintlify) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer<CustomMintlifyRenderer>(options => + { + options.GenerateDocsJson = true; + }) + .ConfigureContext(ctx => ctx.OutputPath = "docs"); +}); +``` + +#### Remarks + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions.mdx new file mode 100644 index 0000000..97fe2e8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions.mdx @@ -0,0 +1,249 @@ +--- +title: FileNamingOptions +description: "Provides configuration options for how documentation files are named and organized." +icon: file-brackets-curly +keywords: ['FileNamingOptions', 'CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Configuration + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions +``` + +## Summary + +Provides configuration options for how documentation files are named and organized. + +## Remarks + +This class controls the file naming strategy for rendered documentation, including + how namespaces are represented in the file system and what characters are used + as separators in file names. + +## Constructors + +### .ctor + +Initializes a new instance of the [FileNamingOptions](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions) class with default settings. + +#### Syntax + +```csharp +public FileNamingOptions() +``` + +### .ctor + +Initializes a new instance of the [FileNamingOptions](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions) class with the specified settings. + +#### Syntax + +```csharp +public FileNamingOptions(CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode namespaceMode, char namespaceSeparator = '-') +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `namespaceMode` | `CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode` | The namespace organization mode. | +| `namespaceSeparator` | `char` | The character to use as a namespace separator in file names. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### NamespaceMode + +Gets or sets the mode for organizing namespace documentation. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode NamespaceMode { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode` +The namespace organization mode. Default is [NamespaceMode.File](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode#file). + +#### Remarks + +This property determines whether namespaces are rendered as individual files + or organized into a folder hierarchy. + +### NamespaceSeparator + +Gets or sets the character used to separate namespace parts in file names. + +#### Syntax + +```csharp +public char NamespaceSeparator { get; set; } +``` + +#### Property Value + +Type: `char` +The separator character. Default is '-'. + +#### Remarks + +This setting is only used when [FileNamingOptions.NamespaceMode](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions#namespacemode) is set to [NamespaceMode.File](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode#file). + When using [NamespaceMode.Folder](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode#folder), this setting is ignored as namespaces + are organized into actual folder hierarchies. + Common values include '-' (hyphen), '_' (underscore), or '.' (period). + +## Methods + +### Clone + +Creates a copy of the current [FileNamingOptions](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions) instance. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions Clone() +``` + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions` +A new instance with the same settings. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode.mdx new file mode 100644 index 0000000..ee1234b --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode.mdx @@ -0,0 +1,33 @@ +--- +title: NamespaceMode +description: "Specifies how namespaces should be organized in the output file structure." +icon: list-ol +tag: "ENUM" +keywords: ['NamespaceMode', 'CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Enum'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Configuration + +**Inheritance:** System.Enum + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode +``` + +## Summary + +Specifies how namespaces should be organized in the output file structure. + +## Values + +| Name | Value | Description | +|------|-------|-------------| +| `File` | 0 | Each namespace is rendered as a single file in the root output directory. | +| `Folder` | 1 | Each namespace is rendered in its own folder hierarchy matching the namespace structure. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType.mdx new file mode 100644 index 0000000..c662425 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType.mdx @@ -0,0 +1,87 @@ +--- +title: RendererType +description: "Defines constants for documentation renderer types and provides mapping functionality between documentation framework types and their correspondi..." +icon: bolt +tag: "STATIC" +keywords: ['RendererType', 'CloudNimble.DotNetDocs.Core.Configuration.RendererType', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Configuration + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Configuration.RendererType +``` + +## Summary + +Defines constants for documentation renderer types and provides mapping functionality + between documentation framework types and their corresponding renderers. + +## Remarks + +This class provides a centralized way to manage renderer type strings used throughout + the documentation generation pipeline. It also provides intelligent mapping from + source documentation framework types to appropriate output renderers. + +## Methods + +### GetRendererType + +Maps a [SupportedDocumentationType](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType) to its corresponding renderer type constant. + +#### Syntax + +```csharp +public static string GetRendererType(CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType documentationType) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `documentationType` | `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` | The source documentation framework type. | + +#### Returns + +Type: `string` +The renderer type constant that should be used for the given documentation type. + Returns [RendererType.Mintlify](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType#mintlify) for Mintlify projects, and [RendererType.Markdown](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType#markdown) for all other types. + +#### Examples + +```csharp +var docType = SupportedDocumentationType.Mintlify; +var renderer = RendererType.GetRendererType(docType); +// renderer == "Mintlify" + +var docType2 = SupportedDocumentationType.DocFX; +var renderer2 = RendererType.GetRendererType(docType2); +// renderer2 == "Markdown" +``` + +#### Remarks + + + + + The mapping logic is as follows: + + + + + + + This mapping ensures that documentation from various frameworks is rendered in a compatible format. + Most frameworks work well with standard Markdown, while Mintlify requires its specific MDX format. + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType.mdx new file mode 100644 index 0000000..529f252 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType.mdx @@ -0,0 +1,44 @@ +--- +title: SupportedDocumentationType +description: "Specifies the type of documentation framework being used for the project." +icon: list-ol +tag: "ENUM" +keywords: ['SupportedDocumentationType', 'CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Enum'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Configuration + +**Inheritance:** System.Enum + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType +``` + +## Summary + +Specifies the type of documentation framework being used for the project. + +## Remarks + +This enum defines the supported documentation frameworks that DotNetDocs.Sdk can work with. + Each type has specific file patterns, configuration files, and rendering behaviors defined in the SDK. + The SDK automatically detects the documentation type based on the presence of framework-specific + configuration files (e.g., docs.json for Mintlify, docfx.json for DocFX). + +## Values + +| Name | Value | Description | +|------|-------|-------------| +| `Mintlify` | 0 | Mintlify documentation framework. | +| `DocFX` | 1 | DocFX documentation framework. | +| `MkDocs` | 2 | MkDocs documentation framework. | +| `Jekyll` | 3 | Jekyll static site generator. | +| `Hugo` | 4 | Hugo static site generator. | +| `Generic` | 5 | Generic documentation type for frameworks not specifically supported. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/index.mdx new file mode 100644 index 0000000..ef6bfc0 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/index.mdx @@ -0,0 +1,27 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Core.Configuration Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Core.Configuration', 'namespace', 'DotNetDocsBuilder', 'FileNamingOptions', 'NamespaceMode', 'RendererType', 'SupportedDocumentationType'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [DotNetDocsBuilder](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder) | Builder for configuring the DotNetDocs documentation pipeline. | +| [FileNamingOptions](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions) | Provides configuration options for how documentation files are named and organized. | +| [NamespaceMode](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode) | Specifies how namespaces should be organized in the output file structure. | +| [RendererType](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType) | Defines constants for documentation renderer types and provides mapping functionality between documentation framework types and their corresponding renderers. | +| [SupportedDocumentationType](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType) | Specifies the type of documentation framework being used for the project. | + +### Enums + +| Name | Summary | +| ---- | ------- | +| [NamespaceMode](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode) | Specifies how namespaces should be organized in the output file structure. | +| [SupportedDocumentationType](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType) | Specifies the type of documentation framework being used for the project. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver.mdx new file mode 100644 index 0000000..35fa082 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver.mdx @@ -0,0 +1,239 @@ +--- +title: CrossReferenceResolver +description: "Resolves cross-references in documentation to their target entities and generates appropriate links." +icon: file-brackets-curly +keywords: ['CrossReferenceResolver', 'CloudNimble.DotNetDocs.Core.CrossReferenceResolver', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.CrossReferenceResolver +``` + +## Summary + +Resolves cross-references in documentation to their target entities and generates appropriate links. + +## Remarks + +This class builds a comprehensive map of all documentation entities and their identifiers, + allowing for resolution of see and seealso references to the correct relative paths and anchors. + It handles all types of references including types, members, parameters, and external references. + +## Constructors + +### .ctor + +Initializes a new instance of the [CrossReferenceResolver](/test/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver) class. + +#### Syntax + +```csharp +public CrossReferenceResolver(CloudNimble.DotNetDocs.Core.ProjectContext context) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext` | The project context containing configuration and file naming options. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### BuildReferenceMap + +Builds the reference map from a documentation assembly. + +#### Syntax + +```csharp +public void BuildReferenceMap(CloudNimble.DotNetDocs.Core.DocAssembly assembly) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `assembly` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to index. | + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ResolveReference + +Resolves a documentation reference to a DocReference object with full path and anchor information. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.DocReference ResolveReference(string rawReference, string currentPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `rawReference` | `string` | The raw reference string (e.g., "T:System.String" or "F:NamespaceMode.File"). | +| `currentPath` | `string` | The current document path for calculating relative paths. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.DocReference` +A resolved DocReference object. + +### ResolveReferences + +Resolves all references in a collection of raw reference strings. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection ResolveReferences(System.Collections.Generic.IEnumerable rawReferences, string currentPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `rawReferences` | `System.Collections.Generic.IEnumerable` | The collection of raw reference strings. | +| `currentPath` | `string` | The current document path for calculating relative paths. | + +#### Returns + +Type: `System.Collections.Generic.ICollection` +A collection of resolved DocReference objects. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly.mdx new file mode 100644 index 0000000..587f075 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly.mdx @@ -0,0 +1,565 @@ +--- +title: DocAssembly +description: "Represents documentation for a .NET assembly." +icon: file-brackets-curly +keywords: ['DocAssembly', 'CloudNimble.DotNetDocs.Core.DocAssembly', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocEntity + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocAssembly +``` + +## Summary + +Represents documentation for a .NET assembly. + +## Remarks + +Contains metadata about an assembly and its namespaces, extracted from Roslyn symbols and enhanced + with conceptual documentation. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocAssembly](/test/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly) class. + +#### Syntax + +```csharp +public DocAssembly(Microsoft.CodeAnalysis.IAssemblySymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.IAssemblySymbol` | The Roslyn assembly symbol. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when *symbol* is null. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class. + +#### Syntax + +```csharp +protected DocEntity() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class with an ISymbol. + +#### Syntax + +```csharp +protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AssemblyName + +Gets or sets the name of the assembly. + +#### Syntax + +```csharp +public string AssemblyName { get; set; } +``` + +#### Property Value + +Type: `string` +The assembly name. + +### BestPractices Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the best practices documentation content. + +#### Syntax + +```csharp +public string BestPractices { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with best practices, recommendations, and guidelines from conceptual documentation. + +### Considerations Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the considerations or notes related to the current context. + +#### Syntax + +```csharp +public string Considerations { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with gotchas, performance, or security notes from conceptual documentation. + +### DisplayName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the display name of the entity. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified display name extracted from the Symbol. + +### Examples Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the examples documentation content. + +#### Syntax + +```csharp +public string Examples { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content containing code examples from XML <example> tags. + +### Exceptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of exceptions that can be thrown. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection Exceptions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of exception documentation from XML <exception> tags. + +### IncludedMembers Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the list of member accessibilities to include (default: Public). + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include when processing child members. + +### Namespaces + +Gets the collection of namespaces in the assembly. + +#### Syntax + +```csharp +public System.Collections.Generic.List Namespaces { get; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of documented namespaces within this assembly. + +### OriginalSymbol Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets the original symbol this documentation entity was created from. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol?` +The Roslyn ISymbol that was used to create this entity, preserved for reference. + +### Patterns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the patterns documentation content. + +#### Syntax + +```csharp +public string Patterns { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. + +### RelatedApis Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets a list of related API names. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection RelatedApis { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +List of fully qualified names or URLs for related APIs from conceptual documentation. + +### Remarks Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the remarks from XML documentation. + +#### Syntax + +```csharp +public string Remarks { get; set; } +``` + +#### Property Value + +Type: `string?` +Content from the XML documentation's <remarks> element. + +### Returns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the return value documentation. + +#### Syntax + +```csharp +public string Returns { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of the return value from XML <returns> tag. + +### SeeAlso Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of see-also references. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection SeeAlso { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of related items from XML <seealso> tags. + +### Summary Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the summary from XML documentation. + +#### Syntax + +```csharp +public string Summary { get; set; } +``` + +#### Property Value + +Type: `string?` +Brief description of what the API element IS, from XML <summary> tag. + +### Symbol + +Gets the Roslyn symbol for the assembly. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.IAssemblySymbol Symbol { get; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.IAssemblySymbol` +The underlying Roslyn assembly symbol containing metadata. + +### TypeParameters Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of type parameters. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection TypeParameters { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of type parameter documentation from XML <typeparam> tags. + +### Usage Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the usage documentation content. + +#### Syntax + +```csharp +public string Usage { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining HOW to use the API element, from conceptual documentation. + +### Value Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the value description for properties. + +#### Syntax + +```csharp +public string Value { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of what the property represents from XML <value> tag. + +### Version + +Gets or sets the version of the assembly. + +#### Syntax + +```csharp +public string Version { get; set; } +``` + +#### Property Value + +Type: `string?` +The assembly version string. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToJson Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Serializes this entity to JSON using consistent options. + +#### Syntax + +```csharp +public string ToJson() +``` + +#### Returns + +Type: `string` +The JSON string representation of this entity. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocConstants.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocConstants.mdx new file mode 100644 index 0000000..d975dff --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocConstants.mdx @@ -0,0 +1,26 @@ +--- +title: DocConstants +description: "Defines constants used throughout the DotNetDocs library." +icon: bolt +tag: "STATIC" +keywords: ['DocConstants', 'CloudNimble.DotNetDocs.Core.DocConstants', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocConstants +``` + +## Summary + +Defines constants used throughout the DotNetDocs library. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity.mdx new file mode 100644 index 0000000..8d239c9 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity.mdx @@ -0,0 +1,431 @@ +--- +title: DocEntity +description: "Base class for documentation entities, providing common contextual metadata." +icon: shapes +tag: "ABSTRACT" +keywords: ['DocEntity', 'CloudNimble.DotNetDocs.Core.DocEntity', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocEntity +``` + +## Summary + +Base class for documentation entities, providing common contextual metadata. + +## Remarks + +Represents shared documentation properties for assemblies, namespaces, types, members, or parameters. + Now supports both XML documentation extraction and conceptual content loading with proper separation. + +## Examples + +```csharp +var docType = new DocType(symbol) +{ + Summary = "Represents a logging service.", + Usage = "Use this class for application logging.", + Examples = "\`\`\`csharp\nLogger.LogInfo(\"Message\");\n\`\`\`" +}; +``` + +## Constructors + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### BestPractices + +Gets or sets the best practices documentation content. + +#### Syntax + +```csharp +public string BestPractices { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with best practices, recommendations, and guidelines from conceptual documentation. + +### Considerations + +Gets or sets the considerations or notes related to the current context. + +#### Syntax + +```csharp +public string Considerations { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with gotchas, performance, or security notes from conceptual documentation. + +### DisplayName + +Gets or sets the display name of the entity. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified display name extracted from the Symbol. + +### Examples + +Gets or sets the examples documentation content. + +#### Syntax + +```csharp +public string Examples { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content containing code examples from XML <example> tags. + +### Exceptions + +Gets or sets the collection of exceptions that can be thrown. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection Exceptions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of exception documentation from XML <exception> tags. + +### IncludedMembers + +Gets or sets the list of member accessibilities to include (default: Public). + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include when processing child members. + +### OriginalSymbol + +Gets the original symbol this documentation entity was created from. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol?` +The Roslyn ISymbol that was used to create this entity, preserved for reference. + +### Patterns + +Gets or sets the patterns documentation content. + +#### Syntax + +```csharp +public string Patterns { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. + +### RelatedApis + +Gets or sets a list of related API names. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection RelatedApis { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +List of fully qualified names or URLs for related APIs from conceptual documentation. + +### Remarks + +Gets or sets the remarks from XML documentation. + +#### Syntax + +```csharp +public string Remarks { get; set; } +``` + +#### Property Value + +Type: `string?` +Content from the XML documentation's <remarks> element. + +### Returns + +Gets or sets the return value documentation. + +#### Syntax + +```csharp +public string Returns { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of the return value from XML <returns> tag. + +### SeeAlso + +Gets or sets the collection of see-also references. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection SeeAlso { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of related items from XML <seealso> tags. + +### Summary + +Gets or sets the summary from XML documentation. + +#### Syntax + +```csharp +public string Summary { get; set; } +``` + +#### Property Value + +Type: `string?` +Brief description of what the API element IS, from XML <summary> tag. + +### TypeParameters + +Gets or sets the collection of type parameters. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection TypeParameters { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of type parameter documentation from XML <typeparam> tags. + +### Usage + +Gets or sets the usage documentation content. + +#### Syntax + +```csharp +public string Usage { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining HOW to use the API element, from conceptual documentation. + +### Value + +Gets or sets the value description for properties. + +#### Syntax + +```csharp +public string Value { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of what the property represents from XML <value> tag. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToJson + +Serializes this entity to JSON using consistent options. + +#### Syntax + +```csharp +public string ToJson() +``` + +#### Returns + +Type: `string` +The JSON string representation of this entity. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnum.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnum.mdx new file mode 100644 index 0000000..be77223 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnum.mdx @@ -0,0 +1,754 @@ +--- +title: DocEnum +description: "Represents documentation for a .NET enum type." +icon: file-brackets-curly +keywords: ['DocEnum', 'CloudNimble.DotNetDocs.Core.DocEnum', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocType'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocType + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocEnum +``` + +## Summary + +Represents documentation for a .NET enum type. + +## Remarks + +Contains metadata about an enum type and its values, extracted from Roslyn symbols + and enhanced with conceptual documentation. Inherits from [DocType](/test/api-reference/CloudNimble/DotNetDocs/Core/DocType) but + uses a specialized structure for enum values instead of the Members collection. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocEnum](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnum) class. + +#### Syntax + +```csharp +public DocEnum(Microsoft.CodeAnalysis.ITypeSymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ITypeSymbol` | The Roslyn type symbol representing the enum. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when *symbol* is null. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Initializes a new instance of the [DocType](/test/api-reference/CloudNimble/DotNetDocs/Core/DocType) class. + +#### Syntax + +```csharp +protected DocType() +``` + +#### Remarks + +This parameterless constructor is provided for deserialization purposes only. + Use `ITypeSymbol)` for normal instantiation. + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Initializes a new instance of the [DocType](/test/api-reference/CloudNimble/DotNetDocs/Core/DocType) class. + +#### Syntax + +```csharp +public DocType(Microsoft.CodeAnalysis.ITypeSymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ITypeSymbol` | The Roslyn type symbol. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when *symbol* is null. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class. + +#### Syntax + +```csharp +protected DocEntity() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class with an ISymbol. + +#### Syntax + +```csharp +protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AssemblyName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets or sets the containing assembly name. + +#### Syntax + +```csharp +public string AssemblyName { get; set; } +``` + +#### Property Value + +Type: `string?` +The name of the assembly containing this type. + +### BaseType Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets the base type name, if any. + +#### Syntax + +```csharp +public string BaseType { get; set; } +``` + +#### Property Value + +Type: `string?` +The name of the base type, or null if none exists. + +### BestPractices Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the best practices documentation content. + +#### Syntax + +```csharp +public string BestPractices { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with best practices, recommendations, and guidelines from conceptual documentation. + +### Considerations Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the considerations or notes related to the current context. + +#### Syntax + +```csharp +public string Considerations { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with gotchas, performance, or security notes from conceptual documentation. + +### DisplayName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the display name of the entity. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified display name extracted from the Symbol. + +### Examples Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the examples documentation content. + +#### Syntax + +```csharp +public string Examples { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content containing code examples from XML <example> tags. + +### Exceptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of exceptions that can be thrown. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection Exceptions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of exception documentation from XML <exception> tags. + +### FullName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets or sets the fully qualified name of the type. + +#### Syntax + +```csharp +public string FullName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified type name including namespace. + +### IncludedMembers Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the list of member accessibilities to include (default: Public). + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include when processing child members. + +### IsExternalReference Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets or sets whether this type is an external reference created to host extension methods. + +#### Syntax + +```csharp +public bool IsExternalReference { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` if this type is not part of the documented assembly but was created + to show extension methods that apply to it; otherwise `false`. + +#### Remarks + +External references are minimal [DocType](/test/api-reference/CloudNimble/DotNetDocs/Core/DocType) instances created when + extension methods target types outside the current assembly. These types link to + official documentation rather than duplicating external API documentation. + +### IsFlags + +Gets whether this enum has the Flags attribute. + +#### Syntax + +```csharp +public bool IsFlags { get; set; } +``` + +#### Property Value + +Type: `bool` +True if the enum is decorated with [Flags]; otherwise, false. + +### Members Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets the collection of members (methods, properties, fields, events, etc.). + +#### Syntax + +```csharp +public System.Collections.Generic.List Members { get; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of documented members within this type. + +### Name Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets or sets the name of the type. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string` +The type name. + +### OriginalSymbol Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets the original symbol this documentation entity was created from. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol?` +The Roslyn ISymbol that was used to create this entity, preserved for reference. + +### Patterns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the patterns documentation content. + +#### Syntax + +```csharp +public string Patterns { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. + +### RelatedApis Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets a list of related API names. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection RelatedApis { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +List of fully qualified names or URLs for related APIs from conceptual documentation. + +### Remarks Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the remarks from XML documentation. + +#### Syntax + +```csharp +public string Remarks { get; set; } +``` + +#### Property Value + +Type: `string?` +Content from the XML documentation's <remarks> element. + +### Returns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the return value documentation. + +#### Syntax + +```csharp +public string Returns { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of the return value from XML <returns> tag. + +### SeeAlso Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of see-also references. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection SeeAlso { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of related items from XML <seealso> tags. + +### Signature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets or sets the signature of the type. + +#### Syntax + +```csharp +public string Signature { get; set; } +``` + +#### Property Value + +Type: `string?` +The type signature including modifiers, inheritance, etc. + +### Summary Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the summary from XML documentation. + +#### Syntax + +```csharp +public string Summary { get; set; } +``` + +#### Property Value + +Type: `string?` +Brief description of what the API element IS, from XML <summary> tag. + +### Symbol Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets the Roslyn symbol for the type. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ITypeSymbol Symbol { get; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ITypeSymbol` +The underlying Roslyn type symbol containing metadata. + +### TypeKind Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocType` + +Gets or sets the type kind. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.TypeKind TypeKind { get; set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.TypeKind?` +The kind of type (Class, Interface, Struct, Enum, Delegate, etc.). + +### TypeParameters Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of type parameters. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection TypeParameters { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of type parameter documentation from XML <typeparam> tags. + +### UnderlyingType + +Gets or sets the underlying type of the enum as a [DocReference](/test/api-reference/CloudNimble/DotNetDocs/Core/DocReference). + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.DocReference UnderlyingType { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.DocReference` +A reference to the underlying type (e.g., System.Int32, System.Byte) that can be + resolved and linked in documentation. + +### Usage Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the usage documentation content. + +#### Syntax + +```csharp +public string Usage { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining HOW to use the API element, from conceptual documentation. + +### Value Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the value description for properties. + +#### Syntax + +```csharp +public string Value { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of what the property represents from XML <value> tag. + +### Values + +Gets the collection of enum values with their documentation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Values { get; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +A list of documented enum values, each containing the name, numeric value, + and associated documentation. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToJson Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Serializes this entity to JSON using consistent options. + +#### Syntax + +```csharp +public string ToJson() +``` + +#### Returns + +Type: `string` +The JSON string representation of this entity. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue.mdx new file mode 100644 index 0000000..dd5ae53 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue.mdx @@ -0,0 +1,545 @@ +--- +title: DocEnumValue +description: "Represents a single value within an enum type." +icon: file-brackets-curly +keywords: ['DocEnumValue', 'CloudNimble.DotNetDocs.Core.DocEnumValue', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocEntity + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocEnumValue +``` + +## Summary + +Represents a single value within an enum type. + +## Remarks + +Inherits from [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) to provide standard documentation properties + while adding enum-specific properties like the numeric value. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocEnumValue](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue) class. + +#### Syntax + +```csharp +public DocEnumValue(Microsoft.CodeAnalysis.IFieldSymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.IFieldSymbol` | The Roslyn field symbol representing the enum value. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class. + +#### Syntax + +```csharp +protected DocEntity() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class with an ISymbol. + +#### Syntax + +```csharp +protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### BestPractices Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the best practices documentation content. + +#### Syntax + +```csharp +public string BestPractices { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with best practices, recommendations, and guidelines from conceptual documentation. + +### Considerations Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the considerations or notes related to the current context. + +#### Syntax + +```csharp +public string Considerations { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with gotchas, performance, or security notes from conceptual documentation. + +### DisplayName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the display name of the entity. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified display name extracted from the Symbol. + +### Examples Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the examples documentation content. + +#### Syntax + +```csharp +public string Examples { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content containing code examples from XML <example> tags. + +### Exceptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of exceptions that can be thrown. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection Exceptions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of exception documentation from XML <exception> tags. + +### IncludedMembers Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the list of member accessibilities to include (default: Public). + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include when processing child members. + +### Name + +Gets or sets the name of the enum value. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string` +The identifier name of the enum member. + +### NumericValue + +Gets or sets the numeric value of the enum member. + +#### Syntax + +```csharp +public string NumericValue { get; set; } +``` + +#### Property Value + +Type: `string?` +The numeric value as a string to preserve formatting (e.g., "0x10" for hex values). + May be null if the value is implicitly assigned. + +### OriginalSymbol Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets the original symbol this documentation entity was created from. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol?` +The Roslyn ISymbol that was used to create this entity, preserved for reference. + +### Patterns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the patterns documentation content. + +#### Syntax + +```csharp +public string Patterns { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. + +### RelatedApis Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets a list of related API names. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection RelatedApis { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +List of fully qualified names or URLs for related APIs from conceptual documentation. + +### Remarks Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the remarks from XML documentation. + +#### Syntax + +```csharp +public string Remarks { get; set; } +``` + +#### Property Value + +Type: `string?` +Content from the XML documentation's <remarks> element. + +### Returns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the return value documentation. + +#### Syntax + +```csharp +public string Returns { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of the return value from XML <returns> tag. + +### SeeAlso Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of see-also references. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection SeeAlso { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of related items from XML <seealso> tags. + +### Summary Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the summary from XML documentation. + +#### Syntax + +```csharp +public string Summary { get; set; } +``` + +#### Property Value + +Type: `string?` +Brief description of what the API element IS, from XML <summary> tag. + +### Symbol + +Gets the Roslyn symbol for the enum field. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.IFieldSymbol Symbol { get; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.IFieldSymbol?` +The underlying Roslyn field symbol containing metadata. + +### TypeParameters Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of type parameters. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection TypeParameters { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of type parameter documentation from XML <typeparam> tags. + +### Usage Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the usage documentation content. + +#### Syntax + +```csharp +public string Usage { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining HOW to use the API element, from conceptual documentation. + +### Value Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the value description for properties. + +#### Syntax + +```csharp +public string Value { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of what the property represents from XML <value> tag. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToJson Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Serializes this entity to JSON using consistent options. + +#### Syntax + +```csharp +public string ToJson() +``` + +#### Returns + +Type: `string` +The JSON string representation of this entity. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocException.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocException.mdx new file mode 100644 index 0000000..81bed41 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocException.mdx @@ -0,0 +1,197 @@ +--- +title: DocException +description: "Represents exception documentation extracted from XML documentation comments." +icon: file-brackets-curly +keywords: ['DocException', 'CloudNimble.DotNetDocs.Core.DocException', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocException +``` + +## Summary + +Represents exception documentation extracted from XML documentation comments. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public DocException() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Description + +Gets or sets the description of when the exception is thrown. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` +The description text from the exception XML documentation. + +### Type + +Gets or sets the exception type name. + +#### Syntax + +```csharp +public string Type { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified or simple name of the exception type (e.g., "ArgumentNullException"). + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocMember.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocMember.mdx new file mode 100644 index 0000000..2394dc3 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocMember.mdx @@ -0,0 +1,768 @@ +--- +title: DocMember +description: "Represents documentation for a .NET member (method, property, field, event, etc.)." +icon: file-brackets-curly +keywords: ['DocMember', 'CloudNimble.DotNetDocs.Core.DocMember', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocEntity + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocMember +``` + +## Summary + +Represents documentation for a .NET member (method, property, field, event, etc.). + +## Remarks + +Contains metadata about a type member, extracted from Roslyn symbols and enhanced + with conceptual documentation. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocMember](/test/api-reference/CloudNimble/DotNetDocs/Core/DocMember) class. + +#### Syntax + +```csharp +public DocMember(Microsoft.CodeAnalysis.ISymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ISymbol` | The Roslyn member symbol. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when *symbol* is null. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class. + +#### Syntax + +```csharp +protected DocEntity() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class with an ISymbol. + +#### Syntax + +```csharp +protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Accessibility + +Gets or sets the accessibility level of the member. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.Accessibility Accessibility { get; set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.Accessibility?` +The accessibility level (public, private, protected, etc.). + +### BestPractices Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the best practices documentation content. + +#### Syntax + +```csharp +public string BestPractices { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with best practices, recommendations, and guidelines from conceptual documentation. + +### Considerations Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the considerations or notes related to the current context. + +#### Syntax + +```csharp +public string Considerations { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with gotchas, performance, or security notes from conceptual documentation. + +### DeclaringTypeName + +Gets or sets the fully qualified name of the type that declares this member. + +#### Syntax + +```csharp +public string DeclaringTypeName { get; set; } +``` + +#### Property Value + +Type: `string?` +For inherited members, this is the base type or interface name. + For extension methods, this is the static class containing the method. + For declared members, this matches the containing type. + +### DisplayName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the display name of the entity. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified display name extracted from the Symbol. + +### Examples Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the examples documentation content. + +#### Syntax + +```csharp +public string Examples { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content containing code examples from XML <example> tags. + +### Exceptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of exceptions that can be thrown. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection Exceptions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of exception documentation from XML <exception> tags. + +### ExtendedTypeName + +Gets or sets the fully qualified name of the type this extension method extends. + +#### Syntax + +```csharp +public string ExtendedTypeName { get; set; } +``` + +#### Property Value + +Type: `string?` +The type of the first parameter (with `this` modifier), or `null` if not an extension method. + +### IncludedMembers Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the list of member accessibilities to include (default: Public). + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include when processing child members. + +### IsAbstract + +Gets or sets whether this member is abstract. + +#### Syntax + +```csharp +public bool IsAbstract { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` if the member uses the `abstract` keyword; otherwise `false`. + +### IsExtensionMethod + +Gets or sets whether this member is an extension method. + +#### Syntax + +```csharp +public bool IsExtensionMethod { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` if this is a static method with the `this` modifier on its first parameter; + otherwise `false`. + +### IsInherited + +Gets or sets whether this member is inherited from a base type or interface. + +#### Syntax + +```csharp +public bool IsInherited { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` if the member is declared in a base type or interface; + `false` if declared in the containing type. + +### IsOverride + +Gets or sets whether this member overrides a base implementation. + +#### Syntax + +```csharp +public bool IsOverride { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` if the member uses the `override` keyword; otherwise `false`. + +### IsVirtual + +Gets or sets whether this member is virtual. + +#### Syntax + +```csharp +public bool IsVirtual { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` if the member uses the `virtual` keyword; otherwise `false`. + +### MemberKind + +Gets or sets the member kind (method, property, field, event, etc.). + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.SymbolKind MemberKind { get; set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.SymbolKind?` +The kind of member as defined by Roslyn. + +### MethodKind + +Gets or sets the method kind for method members. + +#### Syntax + +```csharp +public System.Nullable MethodKind { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` +The kind of method (Constructor, Ordinary, etc.), or null for non-method members. + +### Name + +Gets or sets the name of the member. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string` +The member name. + +### OriginalSymbol Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets the original symbol this documentation entity was created from. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol?` +The Roslyn ISymbol that was used to create this entity, preserved for reference. + +### OverriddenMember + +Gets or sets the signature of the member being overridden, if applicable. + +#### Syntax + +```csharp +public string OverriddenMember { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified signature of the base member, or `null` if not an override. + +### Parameters + +Gets the collection of parameters for this member. + +#### Syntax + +```csharp +public System.Collections.Generic.List Parameters { get; init; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of documented parameters. Empty for members without parameters. + +#### Remarks + +This collection is populated for methods, constructors, delegates, and indexers. + +### Patterns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the patterns documentation content. + +#### Syntax + +```csharp +public string Patterns { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. + +### RelatedApis Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets a list of related API names. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection RelatedApis { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +List of fully qualified names or URLs for related APIs from conceptual documentation. + +### Remarks Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the remarks from XML documentation. + +#### Syntax + +```csharp +public string Remarks { get; set; } +``` + +#### Property Value + +Type: `string?` +Content from the XML documentation's <remarks> element. + +### Returns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the return value documentation. + +#### Syntax + +```csharp +public string Returns { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of the return value from XML <returns> tag. + +### ReturnType + +Gets the return type documentation, if applicable. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.DocType ReturnType { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.DocType?` +Documentation for the return type, or null for void methods and non-method members. + +### ReturnTypeName + +Gets or sets the name of the return type. + +#### Syntax + +```csharp +public string ReturnTypeName { get; set; } +``` + +#### Property Value + +Type: `string?` +The return type name for methods and properties, or null for other members. + +### SeeAlso Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of see-also references. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection SeeAlso { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of related items from XML <seealso> tags. + +### Signature + +Gets or sets the signature of the member. + +#### Syntax + +```csharp +public string Signature { get; set; } +``` + +#### Property Value + +Type: `string?` +The member signature including modifiers, return type, parameters, etc. + +### Summary Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the summary from XML documentation. + +#### Syntax + +```csharp +public string Summary { get; set; } +``` + +#### Property Value + +Type: `string?` +Brief description of what the API element IS, from XML <summary> tag. + +### Symbol + +Gets the Roslyn symbol for the member. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol Symbol { get; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol` +The underlying Roslyn symbol containing metadata. + +### TypeParameters Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of type parameters. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection TypeParameters { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of type parameter documentation from XML <typeparam> tags. + +### Usage Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the usage documentation content. + +#### Syntax + +```csharp +public string Usage { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining HOW to use the API element, from conceptual documentation. + +### Value Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the value description for properties. + +#### Syntax + +```csharp +public string Value { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of what the property represents from XML <value> tag. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToJson Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Serializes this entity to JSON using consistent options. + +#### Syntax + +```csharp +public string ToJson() +``` + +#### Returns + +Type: `string` +The JSON string representation of this entity. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace.mdx new file mode 100644 index 0000000..fd13a39 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace.mdx @@ -0,0 +1,550 @@ +--- +title: DocNamespace +description: "Represents documentation for a .NET namespace." +icon: file-brackets-curly +keywords: ['DocNamespace', 'CloudNimble.DotNetDocs.Core.DocNamespace', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocEntity + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocNamespace +``` + +## Summary + +Represents documentation for a .NET namespace. + +## Remarks + +Contains metadata about a namespace and its types, extracted from Roslyn symbols and enhanced + with conceptual documentation. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocNamespace](/test/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace) class. + +#### Syntax + +```csharp +public DocNamespace(Microsoft.CodeAnalysis.INamespaceSymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.INamespaceSymbol` | The Roslyn namespace symbol. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when *symbol* is null. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class. + +#### Syntax + +```csharp +protected DocEntity() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class with an ISymbol. + +#### Syntax + +```csharp +protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### BestPractices Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the best practices documentation content. + +#### Syntax + +```csharp +public string BestPractices { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with best practices, recommendations, and guidelines from conceptual documentation. + +### Considerations Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the considerations or notes related to the current context. + +#### Syntax + +```csharp +public string Considerations { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with gotchas, performance, or security notes from conceptual documentation. + +### DisplayName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the display name of the entity. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified display name extracted from the Symbol. + +### Examples Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the examples documentation content. + +#### Syntax + +```csharp +public string Examples { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content containing code examples from XML <example> tags. + +### Exceptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of exceptions that can be thrown. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection Exceptions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of exception documentation from XML <exception> tags. + +### IncludedMembers Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the list of member accessibilities to include (default: Public). + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include when processing child members. + +### Name + +Gets or sets the name of the namespace. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string` +The namespace name. + +### OriginalSymbol Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets the original symbol this documentation entity was created from. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol?` +The Roslyn ISymbol that was used to create this entity, preserved for reference. + +### Patterns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the patterns documentation content. + +#### Syntax + +```csharp +public string Patterns { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. + +### RelatedApis Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets a list of related API names. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection RelatedApis { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +List of fully qualified names or URLs for related APIs from conceptual documentation. + +### Remarks Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the remarks from XML documentation. + +#### Syntax + +```csharp +public string Remarks { get; set; } +``` + +#### Property Value + +Type: `string?` +Content from the XML documentation's <remarks> element. + +### Returns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the return value documentation. + +#### Syntax + +```csharp +public string Returns { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of the return value from XML <returns> tag. + +### SeeAlso Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of see-also references. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection SeeAlso { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of related items from XML <seealso> tags. + +### Summary Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the summary from XML documentation. + +#### Syntax + +```csharp +public string Summary { get; set; } +``` + +#### Property Value + +Type: `string?` +Brief description of what the API element IS, from XML <summary> tag. + +### Symbol + +Gets the Roslyn symbol for the namespace. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.INamespaceSymbol Symbol { get; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.INamespaceSymbol` +The underlying Roslyn namespace symbol containing metadata. + +### TypeParameters Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of type parameters. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection TypeParameters { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of type parameter documentation from XML <typeparam> tags. + +### Types + +Gets the collection of types in the namespace. + +#### Syntax + +```csharp +public System.Collections.Generic.List Types { get; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of documented types within this namespace. + +### Usage Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the usage documentation content. + +#### Syntax + +```csharp +public string Usage { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining HOW to use the API element, from conceptual documentation. + +### Value Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the value description for properties. + +#### Syntax + +```csharp +public string Value { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of what the property represents from XML <value> tag. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToJson Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Serializes this entity to JSON using consistent options. + +#### Syntax + +```csharp +public string ToJson() +``` + +#### Returns + +Type: `string` +The JSON string representation of this entity. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocParameter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocParameter.mdx new file mode 100644 index 0000000..091bf2b --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocParameter.mdx @@ -0,0 +1,625 @@ +--- +title: DocParameter +description: "Represents documentation for a method or constructor parameter." +icon: file-brackets-curly +keywords: ['DocParameter', 'CloudNimble.DotNetDocs.Core.DocParameter', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocEntity + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocParameter +``` + +## Summary + +Represents documentation for a method or constructor parameter. + +## Remarks + +Contains metadata about a parameter, extracted from Roslyn symbols and enhanced + with conceptual documentation. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocParameter](/test/api-reference/CloudNimble/DotNetDocs/Core/DocParameter) class. + +#### Syntax + +```csharp +public DocParameter(Microsoft.CodeAnalysis.IParameterSymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.IParameterSymbol` | The Roslyn parameter symbol. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when *symbol* is null. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class. + +#### Syntax + +```csharp +protected DocEntity() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class with an ISymbol. + +#### Syntax + +```csharp +protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### BestPractices Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the best practices documentation content. + +#### Syntax + +```csharp +public string BestPractices { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with best practices, recommendations, and guidelines from conceptual documentation. + +### Considerations Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the considerations or notes related to the current context. + +#### Syntax + +```csharp +public string Considerations { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with gotchas, performance, or security notes from conceptual documentation. + +### DefaultValue + +Gets the default value of the parameter, if any. + +#### Syntax + +```csharp +public string DefaultValue { get; set; } +``` + +#### Property Value + +Type: `string?` +The default value as a string, or null if no default value exists. + +### DisplayName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the display name of the entity. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified display name extracted from the Symbol. + +### Examples Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the examples documentation content. + +#### Syntax + +```csharp +public string Examples { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content containing code examples from XML <example> tags. + +### Exceptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of exceptions that can be thrown. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection Exceptions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of exception documentation from XML <exception> tags. + +### HasDefaultValue + +Gets or sets a value indicating whether this parameter has a default value. + +#### Syntax + +```csharp +public bool HasDefaultValue { get; set; } +``` + +#### Property Value + +Type: `bool` +True if the parameter has a default value; otherwise, false. + +### IncludedMembers Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the list of member accessibilities to include (default: Public). + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include when processing child members. + +### IsOptional + +Gets or sets a value indicating whether this parameter is optional. + +#### Syntax + +```csharp +public bool IsOptional { get; set; } +``` + +#### Property Value + +Type: `bool` +True if the parameter is optional; otherwise, false. + +### IsParams + +Gets or sets a value indicating whether this parameter uses the params keyword. + +#### Syntax + +```csharp +public bool IsParams { get; set; } +``` + +#### Property Value + +Type: `bool` +True if the parameter is a params array; otherwise, false. + +### Name + +Gets or sets the name of the parameter. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string` +The parameter name. + +### OriginalSymbol Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets the original symbol this documentation entity was created from. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol?` +The Roslyn ISymbol that was used to create this entity, preserved for reference. + +### ParameterType + +Gets the parameter type documentation. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.DocType ParameterType { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.DocType?` +Documentation for the parameter's type. + +### Patterns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the patterns documentation content. + +#### Syntax + +```csharp +public string Patterns { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. + +### RelatedApis Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets a list of related API names. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection RelatedApis { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +List of fully qualified names or URLs for related APIs from conceptual documentation. + +### Remarks Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the remarks from XML documentation. + +#### Syntax + +```csharp +public string Remarks { get; set; } +``` + +#### Property Value + +Type: `string?` +Content from the XML documentation's <remarks> element. + +### Returns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the return value documentation. + +#### Syntax + +```csharp +public string Returns { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of the return value from XML <returns> tag. + +### SeeAlso Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of see-also references. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection SeeAlso { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of related items from XML <seealso> tags. + +### Summary Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the summary from XML documentation. + +#### Syntax + +```csharp +public string Summary { get; set; } +``` + +#### Property Value + +Type: `string?` +Brief description of what the API element IS, from XML <summary> tag. + +### Symbol + +Gets the Roslyn symbol for the parameter. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.IParameterSymbol Symbol { get; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.IParameterSymbol` +The underlying Roslyn parameter symbol containing metadata. + +### TypeName + +Gets or sets the type name of the parameter. + +#### Syntax + +```csharp +public string TypeName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified type name of the parameter. + +### TypeParameters Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of type parameters. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection TypeParameters { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of type parameter documentation from XML <typeparam> tags. + +### Usage Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the usage documentation content. + +#### Syntax + +```csharp +public string Usage { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining HOW to use the API element, from conceptual documentation. + +### Value Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the value description for properties. + +#### Syntax + +```csharp +public string Value { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of what the property represents from XML <value> tag. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToJson Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Serializes this entity to JSON using consistent options. + +#### Syntax + +```csharp +public string ToJson() +``` + +#### Returns + +Type: `string` +The JSON string representation of this entity. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocReference.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocReference.mdx new file mode 100644 index 0000000..4a1c955 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocReference.mdx @@ -0,0 +1,327 @@ +--- +title: DocReference +description: "Represents a cross-reference in documentation, such as a see or seealso tag." +icon: file-brackets-curly +keywords: ['DocReference', 'CloudNimble.DotNetDocs.Core.DocReference', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocReference +``` + +## Summary + +Represents a cross-reference in documentation, such as a see or seealso tag. + +## Remarks + +This class encapsulates all information needed to resolve and render a documentation reference, + including the original reference string, resolved display name, relative path, and anchor for + member-level references. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocReference](/test/api-reference/CloudNimble/DotNetDocs/Core/DocReference) class. + +#### Syntax + +```csharp +public DocReference() +``` + +### .ctor + +Initializes a new instance of the [DocReference](/test/api-reference/CloudNimble/DotNetDocs/Core/DocReference) class with a raw reference. + +#### Syntax + +```csharp +public DocReference(string rawReference) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `rawReference` | `string` | The raw reference string from XML documentation. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchor + +Gets or sets the anchor for member-level references. + +#### Syntax + +```csharp +public string Anchor { get; set; } +``` + +#### Property Value + +Type: `string?` +The anchor name for linking to specific members within a type, or null for type-level references. + +#### Examples + +For a reference to an enum value, this would be "file" for NamespaceMode.File. + +### DisplayName + +Gets or sets the display name for the reference. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The human-readable name to display for this reference. + +#### Examples + +For a member reference, this might be "NamespaceMode.File" or just "File" depending on context. + +### IsResolved + +Gets or sets a value indicating whether this reference has been successfully resolved. + +#### Syntax + +```csharp +public bool IsResolved { get; set; } +``` + +#### Property Value + +Type: `bool` +True if the reference was found and resolved; otherwise, false. + +### RawReference + +Gets or sets the original reference string from the XML documentation. + +#### Syntax + +```csharp +public string RawReference { get; set; } +``` + +#### Property Value + +Type: `string` +The raw cref value including any prefix (T:, F:, P:, M:, E:). + +#### Examples + +F:CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode.File + +### ReferenceType + +Gets or sets the type of reference. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.ReferenceType ReferenceType { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.ReferenceType?` +The classification of this reference. + +### RelativePath + +Gets or sets the resolved root-relative path to the target documentation. + +#### Syntax + +```csharp +public string RelativePath { get; set; } +``` + +#### Property Value + +Type: `string?` +The root-relative path to the target document (starting with /), or null if unresolved. + +#### Examples + +/Configuration/NamespaceMode.md + +### TargetEntity + +Gets or sets the target entity that this reference points to. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.DocEntity TargetEntity { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.DocEntity?` +The resolved DocEntity, or null if the reference couldn't be resolved. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToMarkdownLink + +Generates a Markdown link for this reference. + +#### Syntax + +```csharp +public string ToMarkdownLink() +``` + +#### Returns + +Type: `string` +A Markdown-formatted link, or inline code if the reference is unresolved. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase.mdx new file mode 100644 index 0000000..7a71cba --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase.mdx @@ -0,0 +1,213 @@ +--- +title: DocReferenceHandlerBase +description: "Base class for documentation reference handlers providing common file copying functionality." +icon: shapes +tag: "ABSTRACT" +keywords: ['DocReferenceHandlerBase', 'CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Core.IDocReferenceHandler'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase +``` + +## Summary + +Base class for documentation reference handlers providing common file copying functionality. + +## Remarks + + + + + This abstract class contains shared logic for copying files from referenced documentation projects, + including directory recursion, exclusion pattern matching, and glob pattern support. + + + + + + Derived classes should implement `String)` to provide format-specific + processing such as content rewriting and resource relocation. + + + + +## Constructors + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### DocumentationType Abstract + +#### Syntax + +```csharp +public abstract CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ProcessAsync Abstract + +#### Syntax + +```csharp +public abstract System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | - | +| `documentationRootPath` | `string` | - | + +#### Returns + +Type: `System.Threading.Tasks.Task` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocReferenceHandler + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocType.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocType.mdx new file mode 100644 index 0000000..3e47893 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocType.mdx @@ -0,0 +1,647 @@ +--- +title: DocType +description: "Represents documentation for a .NET type." +icon: file-brackets-curly +keywords: ['DocType', 'CloudNimble.DotNetDocs.Core.DocType', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocEntity + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocType +``` + +## Summary + +Represents documentation for a .NET type. + +## Remarks + +Contains metadata about a type (class, interface, struct, enum, delegate) and its members, + extracted from Roslyn symbols and enhanced with conceptual documentation. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocType](/test/api-reference/CloudNimble/DotNetDocs/Core/DocType) class. + +#### Syntax + +```csharp +public DocType(Microsoft.CodeAnalysis.ITypeSymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ITypeSymbol` | The Roslyn type symbol. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when *symbol* is null. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class. + +#### Syntax + +```csharp +protected DocEntity() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Initializes a new instance of the [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class with an ISymbol. + +#### Syntax + +```csharp +protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AssemblyName + +Gets or sets the containing assembly name. + +#### Syntax + +```csharp +public string AssemblyName { get; set; } +``` + +#### Property Value + +Type: `string?` +The name of the assembly containing this type. + +### BaseType + +Gets the base type name, if any. + +#### Syntax + +```csharp +public string BaseType { get; set; } +``` + +#### Property Value + +Type: `string?` +The name of the base type, or null if none exists. + +### BestPractices Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the best practices documentation content. + +#### Syntax + +```csharp +public string BestPractices { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with best practices, recommendations, and guidelines from conceptual documentation. + +### Considerations Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the considerations or notes related to the current context. + +#### Syntax + +```csharp +public string Considerations { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content with gotchas, performance, or security notes from conceptual documentation. + +### DisplayName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the display name of the entity. + +#### Syntax + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified display name extracted from the Symbol. + +### Examples Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the examples documentation content. + +#### Syntax + +```csharp +public string Examples { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content containing code examples from XML <example> tags. + +### Exceptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of exceptions that can be thrown. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection Exceptions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of exception documentation from XML <exception> tags. + +### FullName + +Gets or sets the fully qualified name of the type. + +#### Syntax + +```csharp +public string FullName { get; set; } +``` + +#### Property Value + +Type: `string?` +The fully qualified type name including namespace. + +### IncludedMembers Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the list of member accessibilities to include (default: Public). + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include when processing child members. + +### IsExternalReference + +Gets or sets whether this type is an external reference created to host extension methods. + +#### Syntax + +```csharp +public bool IsExternalReference { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` if this type is not part of the documented assembly but was created + to show extension methods that apply to it; otherwise `false`. + +#### Remarks + +External references are minimal [DocType](/test/api-reference/CloudNimble/DotNetDocs/Core/DocType) instances created when + extension methods target types outside the current assembly. These types link to + official documentation rather than duplicating external API documentation. + +### Members + +Gets the collection of members (methods, properties, fields, events, etc.). + +#### Syntax + +```csharp +public System.Collections.Generic.List Members { get; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of documented members within this type. + +### Name + +Gets or sets the name of the type. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string` +The type name. + +### OriginalSymbol Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets the original symbol this documentation entity was created from. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ISymbol?` +The Roslyn ISymbol that was used to create this entity, preserved for reference. + +### Patterns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the patterns documentation content. + +#### Syntax + +```csharp +public string Patterns { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. + +### RelatedApis Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets a list of related API names. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection RelatedApis { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +List of fully qualified names or URLs for related APIs from conceptual documentation. + +### Remarks Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the remarks from XML documentation. + +#### Syntax + +```csharp +public string Remarks { get; set; } +``` + +#### Property Value + +Type: `string?` +Content from the XML documentation's <remarks> element. + +### Returns Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the return value documentation. + +#### Syntax + +```csharp +public string Returns { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of the return value from XML <returns> tag. + +### SeeAlso Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of see-also references. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection SeeAlso { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of related items from XML <seealso> tags. + +### Signature + +Gets or sets the signature of the type. + +#### Syntax + +```csharp +public string Signature { get; set; } +``` + +#### Property Value + +Type: `string?` +The type signature including modifiers, inheritance, etc. + +### Summary Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the summary from XML documentation. + +#### Syntax + +```csharp +public string Summary { get; set; } +``` + +#### Property Value + +Type: `string?` +Brief description of what the API element IS, from XML <summary> tag. + +### Symbol + +Gets the Roslyn symbol for the type. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.ITypeSymbol Symbol { get; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.ITypeSymbol` +The underlying Roslyn type symbol containing metadata. + +### TypeKind + +Gets or sets the type kind. + +#### Syntax + +```csharp +public Microsoft.CodeAnalysis.TypeKind TypeKind { get; set; } +``` + +#### Property Value + +Type: `Microsoft.CodeAnalysis.TypeKind?` +The kind of type (Class, Interface, Struct, Enum, Delegate, etc.). + +### TypeParameters Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the collection of type parameters. + +#### Syntax + +```csharp +public System.Collections.Generic.ICollection TypeParameters { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.ICollection?` +Collection of type parameter documentation from XML <typeparam> tags. + +### Usage Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the usage documentation content. + +#### Syntax + +```csharp +public string Usage { get; set; } +``` + +#### Property Value + +Type: `string?` +Markdown content explaining HOW to use the API element, from conceptual documentation. + +### Value Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Gets or sets the value description for properties. + +#### Syntax + +```csharp +public string Value { get; set; } +``` + +#### Property Value + +Type: `string?` +Description of what the property represents from XML <value> tag. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToJson Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` + +Serializes this entity to JSON using consistent options. + +#### Syntax + +```csharp +public string ToJson() +``` + +#### Returns + +Type: `string` +The JSON string representation of this entity. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter.mdx new file mode 100644 index 0000000..c3f209b --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter.mdx @@ -0,0 +1,197 @@ +--- +title: DocTypeParameter +description: "Represents type parameter documentation extracted from XML documentation comments." +icon: file-brackets-curly +keywords: ['DocTypeParameter', 'CloudNimble.DotNetDocs.Core.DocTypeParameter', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocTypeParameter +``` + +## Summary + +Represents type parameter documentation extracted from XML documentation comments. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public DocTypeParameter() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Description + +Gets or sets the description of the type parameter. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` +The description text from the typeparam XML documentation. + +### Name + +Gets or sets the type parameter name. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string?` +The name of the type parameter (e.g., "T", "TKey", "TValue"). + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager.mdx new file mode 100644 index 0000000..2bd1776 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager.mdx @@ -0,0 +1,288 @@ +--- +title: DocumentationManager +description: "Orchestrates the documentation pipeline for one or more assemblies." +icon: file-brackets-curly +keywords: ['DocumentationManager', 'CloudNimble.DotNetDocs.Core.DocumentationManager', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object', 'System.IDisposable'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocumentationManager +``` + +## Summary + +Orchestrates the documentation pipeline for one or more assemblies. + +## Remarks + +This class manages the complete documentation lifecycle including enrichment, + transformation, and rendering. It handles [AssemblyManager](/test/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager) creation, + usage, and disposal for processing assemblies. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocumentationManager](/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager) class. + +#### Syntax + +```csharp +public DocumentationManager(CloudNimble.DotNetDocs.Core.ProjectContext projectContext, System.Collections.Generic.IEnumerable enrichers = null, System.Collections.Generic.IEnumerable transformers = null, System.Collections.Generic.IEnumerable renderers = null, System.Collections.Generic.IEnumerable referenceHandlers = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `projectContext` | `CloudNimble.DotNetDocs.Core.ProjectContext` | The project context containing configuration settings. | +| `enrichers` | `System.Collections.Generic.IEnumerable?` | The enrichers to apply to documentation entities. | +| `transformers` | `System.Collections.Generic.IEnumerable?` | The transformers to apply to the documentation model. | +| `renderers` | `System.Collections.Generic.IEnumerable?` | The renderers to generate output formats. | +| `referenceHandlers` | `System.Collections.Generic.IEnumerable?` | The handlers for processing documentation references. | + +#### Remarks + +This constructor is designed to work with dependency injection containers. + All parameters accept IEnumerable collections that are typically injected by the DI container. + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### CreateConceptualFilesAsync + +Creates placeholder conceptual documentation files for a single assembly. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task CreateConceptualFilesAsync(string assemblyPath, string xmlPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `assemblyPath` | `string` | The path to the assembly file. | +| `xmlPath` | `string` | The path to the XML documentation file. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous operation. + +### CreateConceptualFilesAsync + +Creates placeholder conceptual documentation files for multiple assemblies. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task CreateConceptualFilesAsync(System.Collections.Generic.IEnumerable<(string, string)> assemblies) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `assemblies` | `System.Collections.Generic.IEnumerable<(string, string)>` | The collection of assembly and XML path pairs. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous operation. + +### Dispose + +Disposes of all cached [AssemblyManager](/test/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager) instances. + +#### Syntax + +```csharp +public void Dispose() +``` + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ProcessAsync + +Processes a single assembly through the documentation pipeline. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task ProcessAsync(string assemblyPath, string xmlPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `assemblyPath` | `string` | The path to the assembly file. | +| `xmlPath` | `string` | The path to the XML documentation file. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous processing operation. + +### ProcessAsync + +Processes multiple assemblies through the documentation pipeline. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task ProcessAsync(System.Collections.Generic.IEnumerable<(string, string)> assemblies) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `assemblies` | `System.Collections.Generic.IEnumerable<(string, string)>` | The collection of assembly and XML path pairs. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous processing operation. + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- System.IDisposable + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference.mdx new file mode 100644 index 0000000..e3ba419 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference.mdx @@ -0,0 +1,326 @@ +--- +title: DocumentationReference +description: "Represents a reference to external documentation to be combined into a documentation collection." +icon: file-brackets-curly +keywords: ['DocumentationReference', 'CloudNimble.DotNetDocs.Core.DocumentationReference', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocumentationReference +``` + +## Summary + +Represents a reference to external documentation to be combined into a documentation collection. + +## Remarks + +This class encapsulates information needed to copy documentation files from a referenced project + and integrate its navigation structure into a collection portal. Similar to MSBuild's ProjectReference, + but for documentation outputs. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocumentationReference](/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference) class. + +#### Syntax + +```csharp +public DocumentationReference() +``` + +### .ctor + +Initializes a new instance of the [DocumentationReference](/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference) class with a project path. + +#### Syntax + +```csharp +public DocumentationReference(string projectPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `projectPath` | `string` | The path to the .docsproj file being referenced. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### DestinationPath + +Gets or sets the path to the destination folder within the collection's documentation root. + +#### Syntax + +```csharp +public string DestinationPath { get; set; } +``` + +#### Property Value + +Type: `string` +The relative path where referenced documentation will be copied. + +#### Examples + +For a microservice named "auth-service", this might be "services/auth". + +### DocumentationRoot + +Gets or sets the root directory containing the referenced documentation outputs. + +#### Syntax + +```csharp +public string DocumentationRoot { get; set; } +``` + +#### Property Value + +Type: `string` +The absolute path to the documentation root of the referenced project. + +#### Examples + +C:\repos\auth-service\docs + +### DocumentationType + +Gets or sets the documentation type of the referenced project. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` +The documentation format (Mintlify, DocFX, MkDocs, Jekyll, Hugo, or Generic). + +#### Remarks + +This determines which file patterns to copy and whether navigation combining is supported. + +### IntegrationType + +Gets or sets the integration type for Mintlify navigation. + +#### Syntax + +```csharp +public string IntegrationType { get; set; } +``` + +#### Property Value + +Type: `string` +Either "Tabs" or "Products" for Mintlify navigation structure. + +#### Remarks + +Only applicable when DocumentationType is "Mintlify". Determines whether the referenced + documentation appears in the top-level tabs or in the products section. + +### Name + +Gets or sets the display name for this documentation reference in navigation. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string?` +The name to display for this documentation in tabs, products, or other navigation structures. + +#### Remarks + +When specified, this name is used instead of deriving the name from the project or other metadata. + Useful for providing user-friendly names in navigation elements. + +### NavigationFilePath + +Gets or sets the path to the navigation configuration file for the referenced documentation. + +#### Syntax + +```csharp +public string NavigationFilePath { get; set; } +``` + +#### Property Value + +Type: `string` +The absolute path to the navigation file (e.g., docs.json for Mintlify). + +#### Examples + +C:\repos\auth-service\docs\docs.json + +### ProjectPath + +Gets or sets the path to the .docsproj file being referenced. + +#### Syntax + +```csharp +public string ProjectPath { get; set; } +``` + +#### Property Value + +Type: `string` +The absolute path to the documentation project file. + +#### Examples + +C:\repos\auth-service\docs\AuthService.docsproj + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher.mdx new file mode 100644 index 0000000..32a43e4 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher.mdx @@ -0,0 +1,51 @@ +--- +title: IDocEnricher +description: "Defines an enricher for conceptual documentation augmentation." +icon: plug +keywords: ['IDocEnricher', 'CloudNimble.DotNetDocs.Core.IDocEnricher', 'CloudNimble.DotNetDocs.Core', 'interface'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.IDocEnricher +``` + +## Summary + +Defines an enricher for conceptual documentation augmentation. + +## Remarks + +Implementations of this interface can enhance documentation entities with additional content + from various sources such as conceptual files, AI services, or other data sources. + +## Methods + +### EnrichAsync Abstract + +Enriches a documentation entity with additional conceptual content. + +#### Syntax + +```csharp +System.Threading.Tasks.Task EnrichAsync(CloudNimble.DotNetDocs.Core.DocEntity entity) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entity` | `CloudNimble.DotNetDocs.Core.DocEntity` | The documentation entity to enrich. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous enrichment operation. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler.mdx new file mode 100644 index 0000000..b7146a9 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler.mdx @@ -0,0 +1,95 @@ +--- +title: IDocReferenceHandler +description: "Defines a handler for processing documentation references from other projects." +icon: plug +keywords: ['IDocReferenceHandler', 'CloudNimble.DotNetDocs.Core.IDocReferenceHandler', 'CloudNimble.DotNetDocs.Core', 'interface'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.IDocReferenceHandler +``` + +## Summary + +Defines a handler for processing documentation references from other projects. + +## Remarks + + + + + Implementations of this interface are responsible for copying files from referenced documentation + projects, rewriting internal paths in content files, and relocating resources to appropriate + locations in the collection project. + + + + + + This interface follows the same pattern as [IDocEnricher](/test/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher), [IDocTransformer](/test/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer), + and [IDocRenderer](/test/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer) for format-specific documentation processing. + + + + +## Properties + +### DocumentationType Abstract + +Gets the documentation type this handler supports. + +#### Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` +The [SupportedDocumentationType](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType) that this handler can process. + +## Methods + +### ProcessAsync Abstract + +Processes a documentation reference by copying files, rewriting content paths, + and relocating resources as appropriate for this documentation format. + +#### Syntax + +```csharp +System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | The documentation reference to process. | +| `documentationRootPath` | `string` | The root path of the collection documentation output. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous processing operation. + +#### Remarks + + + + + Implementations should handle the following responsibilities: + + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer.mdx new file mode 100644 index 0000000..b635e3a --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer.mdx @@ -0,0 +1,90 @@ +--- +title: IDocRenderer +description: "Defines a renderer for documentation output generation." +icon: plug +keywords: ['IDocRenderer', 'CloudNimble.DotNetDocs.Core.IDocRenderer', 'CloudNimble.DotNetDocs.Core', 'interface'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.IDocRenderer +``` + +## Summary + +Defines a renderer for documentation output generation. + +## Remarks + +Implementations of this interface generate specific output formats (Markdown, JSON, YAML, etc.) + from the documentation model after all transformations have been applied. + +## Methods + +### RenderAsync Abstract + +Renders the documentation assembly to the output path specified in the project context. + +#### Syntax + +```csharp +System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous rendering operation. + +#### Remarks + + + + + When model is null, the renderer should skip API reference generation but still process + any other operations like navigation file merging (e.g., combining DocumentationReferences). + + + + + + Renderers that support navigation combining (e.g., Mintlify) should access + Context.DocumentationReferences and combine navigation before saving their configuration. + + + + +### RenderPlaceholdersAsync Abstract + +Renders placeholder conceptual content files for the documentation assembly. + +#### Syntax + +```csharp +System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to generate placeholders for. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous placeholder rendering operation. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer.mdx new file mode 100644 index 0000000..4a0e320 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer.mdx @@ -0,0 +1,51 @@ +--- +title: IDocTransformer +description: "Defines a transformation step in the documentation processing pipeline." +icon: plug +keywords: ['IDocTransformer', 'CloudNimble.DotNetDocs.Core.IDocTransformer', 'CloudNimble.DotNetDocs.Core', 'interface'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.IDocTransformer +``` + +## Summary + +Defines a transformation step in the documentation processing pipeline. + +## Remarks + +Implementations of this interface modify the documentation model before rendering, + applying customizations such as overrides and transformations. + +## Methods + +### TransformAsync Abstract + +Transforms a documentation entity. + +#### Syntax + +```csharp +System.Threading.Tasks.Task TransformAsync(CloudNimble.DotNetDocs.Core.DocEntity entity) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entity` | `CloudNimble.DotNetDocs.Core.DocEntity` | The documentation entity to transform. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous transformation operation. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler.mdx new file mode 100644 index 0000000..12939fd --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler.mdx @@ -0,0 +1,349 @@ +--- +title: MarkdownDocReferenceHandler +description: "Base class for Markdown-based documentation reference handlers providing content path rewriting." +icon: shapes +tag: "ABSTRACT" +keywords: ['MarkdownDocReferenceHandler', 'CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase', 'CloudNimble.DotNetDocs.Core.IDocReferenceHandler'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler +``` + +## Summary + +Base class for Markdown-based documentation reference handlers providing content path rewriting. + +## Remarks + + + + + This abstract class extends [DocReferenceHandlerBase](/test/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase) to add Markdown-specific + content rewriting functionality. It handles standard Markdown image and link syntax, + rewriting absolute paths to include the destination path prefix. + + + + + + Derived classes can extend this behavior to handle format-specific patterns such as + JSX imports, component props, or other content-specific path references. + + + + +## Constructors + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +#### Syntax + +```csharp +protected DocReferenceHandlerBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### DocumentationType Inherited Abstract + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +#### Syntax + +```csharp +public abstract CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` + +## Methods + +### CopyDirectoryWithExclusionsAsync Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Recursively copies a directory and its contents, excluding files that match exclusion patterns. + +#### Syntax + +```csharp +protected System.Threading.Tasks.Task CopyDirectoryWithExclusionsAsync(string sourceDir, string destDir, System.Collections.Generic.List exclusionPatterns, bool skipExisting = true) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `sourceDir` | `string` | The source directory to copy from. | +| `destDir` | `string` | The destination directory to copy to. | +| `exclusionPatterns` | `System.Collections.Generic.List` | List of glob patterns for files to exclude. | +| `skipExisting` | `bool` | Whether to skip files that already exist in the destination. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous copy operation. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetExclusionPatternsForDocumentationType Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Gets file exclusion patterns for a given documentation type when copying DocumentationReferences. + +#### Syntax + +```csharp +protected System.Collections.Generic.List GetExclusionPatternsForDocumentationType(CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType documentationType) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `documentationType` | `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` | The documentation type (Mintlify, DocFX, MkDocs, etc.). | + +#### Returns + +Type: `System.Collections.Generic.List` +A list of glob patterns for files that should be excluded from copying. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MatchesGlobPattern Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Matches a file path against a glob pattern. + +#### Syntax + +```csharp +protected bool MatchesGlobPattern(string path, string pattern) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `path` | `string` | The file path to match. | +| `pattern` | `string` | The glob pattern. | + +#### Returns + +Type: `bool` +True if the path matches the pattern, false otherwise. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ProcessAsync Inherited Abstract + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +#### Syntax + +```csharp +public abstract System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | - | +| `documentationRootPath` | `string` | - | + +#### Returns + +Type: `System.Threading.Tasks.Task` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ShouldExcludeDirectory Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Determines if a directory should be excluded based on exclusion patterns. + +#### Syntax + +```csharp +protected bool ShouldExcludeDirectory(string relativePath, System.Collections.Generic.List exclusionPatterns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `relativePath` | `string` | The relative path of the directory. | +| `exclusionPatterns` | `System.Collections.Generic.List` | List of glob patterns for exclusion. | + +#### Returns + +Type: `bool` +True if the directory should be excluded, false otherwise. + +### ShouldExcludeFile Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Determines if a file should be excluded based on exclusion patterns. + +#### Syntax + +```csharp +protected bool ShouldExcludeFile(string relativePath, System.Collections.Generic.List exclusionPatterns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `relativePath` | `string` | The relative path of the file. | +| `exclusionPatterns` | `System.Collections.Generic.List` | List of glob patterns for exclusion. | + +#### Returns + +Type: `bool` +True if the file should be excluded, false otherwise. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocReferenceHandler + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext.mdx new file mode 100644 index 0000000..76e97e3 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext.mdx @@ -0,0 +1,613 @@ +--- +title: ProjectContext +description: "Represents MSBuild project context for source intent in documentation generation." +icon: file-brackets-curly +keywords: ['ProjectContext', 'CloudNimble.DotNetDocs.Core.ProjectContext', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.ProjectContext +``` + +## Summary + +Represents MSBuild project context for source intent in documentation generation. + +## Remarks + +Provides metadata such as referenced assembly paths and the conceptual documentation folder path. + Used by `ProjectContext)` to enhance metadata extraction. + +## Examples + +```csharp +// Default (public members only) +var context = new ProjectContext("ref1.dll", "ref2.dll") { ConceptualPath = "conceptual" }; + +// Include public and internal members +var context = new ProjectContext([Accessibility.Public, Accessibility.Internal], "ref1.dll", "ref2.dll"); + +var model = await manager.DocumentAsync("MyLib.dll", "MyLib.xml", context); +``` + +## Constructors + +### .ctor + +Initializes a new instance of [ProjectContext](/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext) with default settings. + +#### Syntax + +```csharp +public ProjectContext() +``` + +### .ctor + +Initializes a new instance of [ProjectContext](/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext) with optional included members and referenced assemblies. + +#### Syntax + +```csharp +public ProjectContext(System.Collections.Generic.List includedMembers, params string[] references) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `includedMembers` | `System.Collections.Generic.List?` | List of member accessibilities to include. Defaults to Public if null. | +| `references` | `string[]?` | Paths to referenced assemblies. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### ApiReferencePath + +Gets or sets the path to the API reference documentation. + +#### Syntax + +```csharp +public string ApiReferencePath { get; set; } +``` + +#### Property Value + +Type: `string` + +### ConceptualDocsEnabled + +Gets or sets whether conceptual documentation features are enabled. + +#### Syntax + +```csharp +public bool ConceptualDocsEnabled { get; set; } +``` + +#### Property Value + +Type: `bool` +When true (default), conceptual documentation files are generated for new types + and existing conceptual content is loaded. When false, only API documentation + from XML comments is processed. + +### ConceptualPath + +Gets or sets the path to the conceptual documentation folder. + +#### Syntax + +```csharp +public string ConceptualPath { get; set; } +``` + +#### Property Value + +Type: `string` +The file system path to the folder containing conceptual documentation files. + +### CreateExternalTypeReferences + +Gets or sets whether to create documentation for external types that have extension methods. + +#### Syntax + +```csharp +public bool CreateExternalTypeReferences { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` to create minimal [DocType](/test/api-reference/CloudNimble/DotNetDocs/Core/DocType) entries for types outside the assembly + that are extended by extension methods; `false` to only relocate extensions for types + within the assembly. Default is `true`. + +#### Remarks + +When enabled, extending `IServiceCollection` creates a documentation page showing + only your extension methods, with a link to Microsoft's official documentation for the + complete type definition. + +### DocumentationReferences + +Gets or sets the collection of external documentation references to combine into this documentation collection. + +#### Syntax + +```csharp +public System.Collections.Generic.List DocumentationReferences { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +A list of [DocumentationReference](/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference) objects representing external documentation to be combined. + +#### Examples + +```csharp +var context = new ProjectContext +{ + DocumentationReferences = new List<DocumentationReference> + { + new DocumentationReference + { + ProjectPath = @"C:\repos\auth-service\docs\AuthService.docsproj", + DocumentationRoot = @"C:\repos\auth-service\docs", + DestinationPath = "services/auth", + DocumentationType = "Mintlify", + IntegrationType = "Tabs" + } + } +}; +``` + +#### Remarks + +Similar to MSBuild's ProjectReference, this allows creating unified documentation portals by combining + multiple separate .docsproj outputs. Each reference specifies where to copy files from and how to + integrate navigation. + +### DocumentationRootPath + +Gets or sets the output path for generated documentation. + +#### Syntax + +```csharp +public string DocumentationRootPath { get; set; } +``` + +#### Property Value + +Type: `string` +The file system path where documentation output will be generated. + +### ExcludedTypes + +Gets or sets the list of type patterns to exclude from documentation. + +#### Syntax + +```csharp +public System.Collections.Generic.HashSet ExcludedTypes { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.HashSet` +Set of type patterns to exclude. Supports wildcards (*) for flexible matching. + This is useful for filtering out compiler-generated or test framework-injected types. + +#### Examples + +ExcludedTypes = new HashSet<string> +{ + "*.MicrosoftTestingPlatformEntryPoint", // Matches in any namespace + "*.SelfRegisteredExtensions", // Matches in any namespace + "System.Runtime.CompilerServices.*" // Matches any type in this namespace +} + +#### Remarks + +Patterns can use wildcards: + - "*.TypeName" matches TypeName in any namespace + - "Namespace.*.TypeName" matches TypeName in any sub-namespace of Namespace + - "Full.Namespace.TypeName" matches exact fully qualified type name + +### FileNamingOptions + +Gets or sets the file naming options for documentation generation. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions FileNamingOptions { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions` +Configuration for how documentation files are named and organized. + +### IncludedMembers + +Gets or sets the list of member accessibilities to include in documentation. + +#### Syntax + +```csharp +public System.Collections.Generic.List IncludedMembers { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +List of accessibility levels to include. Defaults to Public only. + +### IncludeFields + +Gets or sets whether to include fields in the documentation. + +#### Syntax + +```csharp +public bool IncludeFields { get; set; } +``` + +#### Property Value + +Type: `bool` +When true, public fields (including constants) are included in the documentation. + Defaults to false since fields are generally discouraged in favor of properties. + +### IncludeSystemObjectInheritance + +Gets or sets whether to include members inherited from [Object](https://learn.microsoft.com/dotnet/api/system.object). + +#### Syntax + +```csharp +public bool IncludeSystemObjectInheritance { get; set; } +``` + +#### Property Value + +Type: `bool` +`true` to document `ToString()`, `GetHashCode()`, `Equals()`, etc. + on every type; `false` to exclude these common members. Default is `true`. + +#### Remarks + +Setting this to `false` reduces documentation noise while still including + members inherited from other base types and interfaces. This matches the behavior + of Microsoft's official .NET documentation. + +### References + +Gets or sets the collection of paths to referenced assemblies. + +#### Syntax + +```csharp +public System.Collections.Generic.List References { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +A collection of file system paths to assemblies referenced by the project being documented. + +### ShowPlaceholders + +Gets or sets whether to show placeholder content in the documentation. + +#### Syntax + +```csharp +public bool ShowPlaceholders { get; set; } +``` + +#### Property Value + +Type: `bool` +When true (default), placeholder content is included. When false, files containing the + TODO marker comment are skipped during loading. + +## Methods + +### EnsureOutputDirectoryStructure + +Ensures that the output directory structure exists for all namespaces in the assembly model. + +#### Syntax + +```csharp +public void EnsureOutputDirectoryStructure(CloudNimble.DotNetDocs.Core.DocAssembly assemblyModel, string outputPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `assemblyModel` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The assembly model containing namespaces to create directories for. | +| `outputPath` | `string` | The base output path where directories will be created. | + +#### Remarks + +This method creates the necessary folder structure when using Folder mode. + In File mode, it simply ensures the base output directory exists. + This centralizes folder creation logic so renderers can assume directories exist. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetFullConceptualPath + +Gets the full path to the conceptual documentation folder. + +#### Syntax + +```csharp +public string GetFullConceptualPath() +``` + +#### Returns + +Type: `string` +The absolute path to the conceptual documentation folder if [ProjectContext.ConceptualPath](/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext#conceptualpath) is absolute, + or the path combined with [ProjectContext.DocumentationRootPath](/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext#documentationrootpath) if [ProjectContext.ConceptualPath](/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext#conceptualpath) is relative. + +#### Examples + +```csharp +// When ConceptualPath is absolute +context.ConceptualPath = "C:\\Docs\\conceptual"; +var path = context.GetFullConceptualPath(); // Returns "C:\Docs\conceptual" + +// When ConceptualPath is relative +context.DocumentationRootPath = "C:\\Docs"; +context.ConceptualPath = "conceptual"; +var path = context.GetFullConceptualPath(); // Returns "C:\Docs\conceptual" +``` + +#### Remarks + +This method ensures that conceptual paths are always resolved to absolute paths, + making it easier to work with conceptual documentation files regardless of whether + the path is configured as relative or absolute. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetNamespaceFolderPath + +Converts a namespace string to a folder path based on the configured file naming options. + +#### Syntax + +```csharp +public string GetNamespaceFolderPath(string namespaceName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `namespaceName` | `string` | The namespace name to convert (e.g., "System.Collections.Generic"). | + +#### Returns + +Type: `string` +The folder path representation of the namespace. + +#### Remarks + +When [FileNamingOptions.NamespaceMode](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions#namespacemode) is [NamespaceMode.Folder](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode#folder), + this returns a path with folders for each namespace part (e.g., "System/Collections/Generic"). + When using [NamespaceMode.File](/test/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode#file), this returns an empty string as no folder + structure is created. + +### GetSafeNamespaceName + +Gets the safe namespace name for a given namespace symbol. + +#### Syntax + +```csharp +public string GetSafeNamespaceName(Microsoft.CodeAnalysis.INamespaceSymbol namespaceSymbol) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `namespaceSymbol` | `Microsoft.CodeAnalysis.INamespaceSymbol` | The namespace symbol. | + +#### Returns + +Type: `string` +A safe namespace name, using "global" for the global namespace. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetTypeFilePath + +Gets the full file path for a type, including namespace folder structure if in Folder mode. + +#### Syntax + +```csharp +public string GetTypeFilePath(string fullyQualifiedTypeName, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `fullyQualifiedTypeName` | `string` | The fully qualified type name (e.g., "System.Text.Json.JsonSerializer"). | +| `extension` | `string` | The file extension without the dot (e.g., "md", "yaml"). | + +#### Returns + +Type: `string` +The file path for the type. + +#### Remarks + +In Folder mode: "System.Text.Json.JsonSerializer" becomes "System/Text/Json/JsonSerializer.md" + In File mode: "System.Text.Json.JsonSerializer" becomes "System_Text_Json_JsonSerializer.md" (using configured separator) + +### IsTypeExcluded + +Checks if a type should be excluded from documentation based on exclusion patterns. + +#### Syntax + +```csharp +public bool IsTypeExcluded(string fullyQualifiedTypeName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `fullyQualifiedTypeName` | `string` | The fully qualified type name to check. | + +#### Returns + +Type: `bool` +True if the type should be excluded; otherwise, false. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType.mdx new file mode 100644 index 0000000..a53ec94 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType.mdx @@ -0,0 +1,40 @@ +--- +title: ReferenceType +description: "Specifies the type of documentation reference." +icon: list-ol +tag: "ENUM" +keywords: ['ReferenceType', 'CloudNimble.DotNetDocs.Core.ReferenceType', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Enum'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Enum + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.ReferenceType +``` + +## Summary + +Specifies the type of documentation reference. + +## Values + +| Name | Value | Description | +|------|-------|-------------| +| `Unknown` | 0 | Unknown or unrecognized reference type. | +| `Type` | 1 | Reference to a type (class, interface, struct, enum, delegate). | +| `Field` | 2 | Reference to a field or enum member. | +| `Property` | 3 | Reference to a property. | +| `Method` | 4 | Reference to a method. | +| `Event` | 5 | Reference to an event. | +| `Namespace` | 6 | Reference to a namespace. | +| `External` | 7 | External reference (URL). | +| `Framework` | 8 | Reference to a .NET Framework type. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer.mdx new file mode 100644 index 0000000..d3ddf54 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer.mdx @@ -0,0 +1,664 @@ +--- +title: JsonRenderer +description: "Renders documentation as JSON files." +icon: file-brackets-curly +keywords: ['JsonRenderer', 'CloudNimble.DotNetDocs.Core.Renderers.JsonRenderer', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.RendererBase', 'CloudNimble.DotNetDocs.Core.IDocRenderer'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers + +**Inheritance:** CloudNimble.DotNetDocs.Core.Renderers.RendererBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.JsonRenderer +``` + +## Summary + +Renders documentation as JSON files. + +## Remarks + +Generates structured JSON documentation suitable for API consumption and integration + with documentation tools. + +## Constructors + +### .ctor + +Initializes a new instance of the [JsonRenderer](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer) class. + +#### Syntax + +```csharp +public JsonRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = null, CloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions options = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | +| `options` | `CloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions?` | The rendering options. If null, default options are used. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Initializes a new instance of the [RendererBase](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase) class. + +#### Syntax + +```csharp +protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null, bool enabled = true) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | +| `enabled` | `bool` | - | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Context Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the project context for this renderer. + +#### Syntax + +```csharp +protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.ProjectContext` +The project context containing configuration and settings. + +### Enabled Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +When more than one Renderer is registered, allows a renderer to be turned off. + +#### Syntax + +```csharp +public bool Enabled { get; set; } +``` + +#### Property Value + +Type: `bool` + +### FileNamingOptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file naming options for this renderer. + +#### Syntax + +```csharp +protected CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions FileNamingOptions { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions` +The file naming configuration. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### EscapeXmlTagsInString Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Escapes XML/HTML tag syntax for safe rendering in Markdown/MDX. + +#### Syntax + +```csharp +protected static string EscapeXmlTagsInString(string stringToEscape) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `stringToEscape` | `string?` | The string potentially containing XML/HTML tag syntax or generic type brackets. | + +#### Returns + +Type: `string` +The escaped string safe for MDX rendering. + +#### Remarks + +Converts angle brackets to HTML entities to prevent MDX parser interpretation as JSX/HTML tags. + This handles both generic type syntax (e.g., JsonConverter<object>) and XML documentation tags + (e.g., <see cref="...">) by converting them to JsonConverter&lt;object&gt; and + &lt;see cref="..."&gt; respectively. + +### GetAccessModifier Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the access modifier string for the given accessibility. + +#### Syntax + +```csharp +protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessibility) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `accessibility` | `Microsoft.CodeAnalysis.Accessibility` | The accessibility to convert. | + +#### Returns + +Type: `string` +The access modifier string. + +### GetEventSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the event signature string. + +#### Syntax + +```csharp +protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `evt` | `Microsoft.CodeAnalysis.IEventSymbol` | The event symbol. | + +#### Returns + +Type: `string` +The event signature. + +### GetFieldSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the field signature string. + +#### Syntax + +```csharp +protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `field` | `Microsoft.CodeAnalysis.IFieldSymbol` | The field symbol. | + +#### Returns + +Type: `string` +The field signature. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetMemberSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the member signature for a member symbol. + +#### Syntax + +```csharp +protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `member` | `CloudNimble.DotNetDocs.Core.DocMember` | The member to get the signature for. | + +#### Returns + +Type: `string` +The member signature string. + +### GetMethodSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the method signature string. + +#### Syntax + +```csharp +protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `method` | `Microsoft.CodeAnalysis.IMethodSymbol` | The method symbol. | + +#### Returns + +Type: `string` +The method signature. + +### GetNamespaceFileName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe file name for a namespace, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetNamespaceFileName(CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file name for. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the namespace. + +#### Remarks + +This method is deprecated. Use GetNamespaceFilePath instead. + +### GetNamespaceFilePath Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file path for a namespace documentation file. + +#### Syntax + +```csharp +protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file path for. | +| `outputPath` | `string` | The base output path. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +The full file path for the namespace documentation. + +### GetPropertySignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the property signature string. + +#### Syntax + +```csharp +protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol property) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `property` | `Microsoft.CodeAnalysis.IPropertySymbol` | The property symbol. | + +#### Returns + +Type: `string` +The property signature. + +### GetSafeNamespaceName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe namespace name for use in file names and display. + +#### Syntax + +```csharp +public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the name for. | + +#### Returns + +Type: `string` +A safe namespace name, using "global" for the global namespace. + +### GetSafeTypeName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe type name for use in file names, removing invalid characters. + +#### Syntax + +```csharp +protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the name for. | + +#### Returns + +Type: `string` +A safe type name with invalid characters replaced. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetTypeFileName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe file name for a type, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetTypeFileName(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file name for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the type. + +#### Remarks + +This method is deprecated. Use GetTypeFilePath instead. + +### GetTypeFilePath Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file path for a type documentation file. + +#### Syntax + +```csharp +protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file path for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `outputPath` | `string` | The base output path. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +The full file path for the type documentation. + +### GetTypeSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the type signature string. + +#### Syntax + +```csharp +protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the signature for. | + +#### Returns + +Type: `string` +The type signature. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### RemoveIndentation Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Removes common leading indentation from multi-line text content. + +#### Syntax + +```csharp +internal static string RemoveIndentation(string text) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `text` | `string` | The text to remove indentation from. | + +#### Returns + +Type: `string` +The text with common indentation removed. + +### RenderAsync + +Renders the documentation assembly to JSON files. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous rendering operation. + +### RenderPlaceholdersAsync + +Renders placeholder conceptual content files for the documentation assembly. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to generate placeholders for. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous placeholder rendering operation. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocRenderer + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions.mdx new file mode 100644 index 0000000..efb68e2 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions.mdx @@ -0,0 +1,186 @@ +--- +title: JsonRendererOptions +description: "Configuration options for the JsonRenderer." +icon: file-brackets-curly +keywords: ['JsonRendererOptions', 'CloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions +``` + +## Summary + +Configuration options for the JsonRenderer. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public JsonRendererOptions() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### SerializerOptions + +Gets or sets the JsonSerializerOptions to use for serialization. + +#### Syntax + +```csharp +public System.Text.Json.JsonSerializerOptions SerializerOptions { get; set; } +``` + +#### Property Value + +Type: `System.Text.Json.JsonSerializerOptions` + +#### Remarks + +If not specified, uses default options with camelCase naming, indented output, + null value ignoring, and enum string conversion. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer.mdx new file mode 100644 index 0000000..170b4b0 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer.mdx @@ -0,0 +1,867 @@ +--- +title: MarkdownRenderer +description: "Renders documentation as Markdown files." +icon: file-brackets-curly +keywords: ['MarkdownRenderer', 'CloudNimble.DotNetDocs.Core.Renderers.MarkdownRenderer', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase', 'CloudNimble.DotNetDocs.Core.IDocRenderer'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers + +**Inheritance:** CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.MarkdownRenderer +``` + +## Summary + +Renders documentation as Markdown files. + +## Remarks + +Generates structured Markdown documentation with support for customizations including + insertions, overrides, exclusions, transformations, and conditions. + +## Constructors + +### .ctor + +Initializes a new instance of the [MarkdownRenderer](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer) class. + +#### Syntax + +```csharp +public MarkdownRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Initializes a new instance of the [MarkdownRendererBase](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase) class. + +#### Syntax + +```csharp +public MarkdownRendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Initializes a new instance of the [RendererBase](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase) class. + +#### Syntax + +```csharp +protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null, bool enabled = true) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | +| `enabled` | `bool` | - | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Context Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the project context for this renderer. + +#### Syntax + +```csharp +protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.ProjectContext` +The project context containing configuration and settings. + +### Enabled Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +When more than one Renderer is registered, allows a renderer to be turned off. + +#### Syntax + +```csharp +public bool Enabled { get; set; } +``` + +#### Property Value + +Type: `bool` + +### FileNamingOptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file naming options for this renderer. + +#### Syntax + +```csharp +protected CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions FileNamingOptions { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions` +The file naming configuration. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### EscapeXmlTagsInString Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Escapes XML/HTML tag syntax for safe rendering in Markdown/MDX. + +#### Syntax + +```csharp +protected static string EscapeXmlTagsInString(string stringToEscape) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `stringToEscape` | `string?` | The string potentially containing XML/HTML tag syntax or generic type brackets. | + +#### Returns + +Type: `string` +The escaped string safe for MDX rendering. + +#### Remarks + +Converts angle brackets to HTML entities to prevent MDX parser interpretation as JSX/HTML tags. + This handles both generic type syntax (e.g., JsonConverter<object>) and XML documentation tags + (e.g., <see cref="...">) by converting them to JsonConverter&lt;object&gt; and + &lt;see cref="..."&gt; respectively. + +### GetAccessModifier Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the access modifier string for the given accessibility. + +#### Syntax + +```csharp +protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessibility) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `accessibility` | `Microsoft.CodeAnalysis.Accessibility` | The accessibility to convert. | + +#### Returns + +Type: `string` +The access modifier string. + +### GetBestPracticesTemplate Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Gets a template for best practices documentation. + +#### Syntax + +```csharp +protected static string GetBestPracticesTemplate(string entityName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entityName` | `string` | The name of the entity (type, assembly, etc.). | + +#### Returns + +Type: `string` +A markdown template string for best practices documentation. + +### GetConsiderationsTemplate Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Gets a template for considerations documentation. + +#### Syntax + +```csharp +protected static string GetConsiderationsTemplate(string entityName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entityName` | `string` | The name of the entity (type, assembly, etc.). | + +#### Returns + +Type: `string` +A markdown template string for considerations documentation. + +### GetEventSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the event signature string. + +#### Syntax + +```csharp +protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `evt` | `Microsoft.CodeAnalysis.IEventSymbol` | The event symbol. | + +#### Returns + +Type: `string` +The event signature. + +### GetExamplesTemplate Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Gets a template for examples documentation. + +#### Syntax + +```csharp +protected static string GetExamplesTemplate(string entityName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entityName` | `string` | The name of the entity (type, assembly, etc.). | + +#### Returns + +Type: `string` +A markdown template string for examples documentation. + +### GetFieldSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the field signature string. + +#### Syntax + +```csharp +protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `field` | `Microsoft.CodeAnalysis.IFieldSymbol` | The field symbol. | + +#### Returns + +Type: `string` +The field signature. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetHeaderText Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Gets the header text to use for a content section, or null if no header should be added. + Returns null if the content already contains the specified header. + +#### Syntax + +```csharp +protected static string GetHeaderText(string content, string headerText) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `content` | `string?` | The content to check. | +| `headerText` | `string` | The header text that would be added (e.g., "## Summary"). | + +#### Returns + +Type: `string?` +The header text to add, or null if no header should be added. + +### GetMemberSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the member signature for a member symbol. + +#### Syntax + +```csharp +protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `member` | `CloudNimble.DotNetDocs.Core.DocMember` | The member to get the signature for. | + +#### Returns + +Type: `string` +The member signature string. + +### GetMethodSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the method signature string. + +#### Syntax + +```csharp +protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `method` | `Microsoft.CodeAnalysis.IMethodSymbol` | The method symbol. | + +#### Returns + +Type: `string` +The method signature. + +### GetNamespaceFileName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe file name for a namespace, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetNamespaceFileName(CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file name for. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the namespace. + +#### Remarks + +This method is deprecated. Use GetNamespaceFilePath instead. + +### GetNamespaceFilePath Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file path for a namespace documentation file. + +#### Syntax + +```csharp +protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file path for. | +| `outputPath` | `string` | The base output path. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +The full file path for the namespace documentation. + +### GetPatternsTemplate Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Gets a template for patterns documentation. + +#### Syntax + +```csharp +protected static string GetPatternsTemplate(string entityName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entityName` | `string` | The name of the entity (type, assembly, etc.). | + +#### Returns + +Type: `string` +A markdown template string for patterns documentation. + +### GetPropertySignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the property signature string. + +#### Syntax + +```csharp +protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol property) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `property` | `Microsoft.CodeAnalysis.IPropertySymbol` | The property symbol. | + +#### Returns + +Type: `string` +The property signature. + +### GetRelatedApisTemplate Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Gets a template for related APIs documentation. + +#### Syntax + +```csharp +protected static string GetRelatedApisTemplate(string entityName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entityName` | `string` | The name of the entity (type, assembly, etc.). | + +#### Returns + +Type: `string` +A markdown template string for related APIs documentation. + +### GetSafeNamespaceName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe namespace name for use in file names and display. + +#### Syntax + +```csharp +public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the name for. | + +#### Returns + +Type: `string` +A safe namespace name, using "global" for the global namespace. + +### GetSafeTypeName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe type name for use in file names, removing invalid characters. + +#### Syntax + +```csharp +protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the name for. | + +#### Returns + +Type: `string` +A safe type name with invalid characters replaced. + +### GetSummaryTemplate Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Gets a template for summary documentation. + +#### Syntax + +```csharp +protected static string GetSummaryTemplate(string entityName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entityName` | `string` | The name of the entity (namespace, assembly, etc.). | + +#### Returns + +Type: `string` +A markdown template string for summary documentation. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetTypeFileName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe file name for a type, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetTypeFileName(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file name for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the type. + +#### Remarks + +This method is deprecated. Use GetTypeFilePath instead. + +### GetTypeFilePath Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file path for a type documentation file. + +#### Syntax + +```csharp +protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file path for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `outputPath` | `string` | The base output path. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +The full file path for the type documentation. + +### GetTypeSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the type signature string. + +#### Syntax + +```csharp +protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the signature for. | + +#### Returns + +Type: `string` +The type signature. + +### GetUsageTemplate Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` + +Gets a template for usage documentation. + +#### Syntax + +```csharp +protected static string GetUsageTemplate(string entityName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entityName` | `string` | The name of the entity (type, assembly, etc.). | + +#### Returns + +Type: `string` +A markdown template string for usage documentation. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### RemoveIndentation Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Removes common leading indentation from multi-line text content. + +#### Syntax + +```csharp +internal static string RemoveIndentation(string text) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `text` | `string` | The text to remove indentation from. | + +#### Returns + +Type: `string` +The text with common indentation removed. + +### RenderAsync + +Renders the documentation assembly to Markdown files. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous rendering operation. + +### RenderPlaceholdersAsync + +Renders placeholder conceptual content files for the documentation assembly. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to generate placeholders for. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous placeholder rendering operation. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocRenderer + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase.mdx new file mode 100644 index 0000000..5613840 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase.mdx @@ -0,0 +1,613 @@ +--- +title: MarkdownRendererBase +description: "Base class for Markdown-based renderers providing common formatting utilities." +icon: shapes +tag: "ABSTRACT" +keywords: ['MarkdownRendererBase', 'CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.RendererBase'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers + +**Inheritance:** CloudNimble.DotNetDocs.Core.Renderers.RendererBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase +``` + +## Summary + +Base class for Markdown-based renderers providing common formatting utilities. + +## Constructors + +### .ctor + +Initializes a new instance of the [MarkdownRendererBase](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase) class. + +#### Syntax + +```csharp +public MarkdownRendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Initializes a new instance of the [RendererBase](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase) class. + +#### Syntax + +```csharp +protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null, bool enabled = true) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | +| `enabled` | `bool` | - | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Context Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the project context for this renderer. + +#### Syntax + +```csharp +protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.ProjectContext` +The project context containing configuration and settings. + +### Enabled Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +When more than one Renderer is registered, allows a renderer to be turned off. + +#### Syntax + +```csharp +public bool Enabled { get; set; } +``` + +#### Property Value + +Type: `bool` + +### FileNamingOptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file naming options for this renderer. + +#### Syntax + +```csharp +protected CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions FileNamingOptions { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions` +The file naming configuration. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### EscapeXmlTagsInString Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Escapes XML/HTML tag syntax for safe rendering in Markdown/MDX. + +#### Syntax + +```csharp +protected static string EscapeXmlTagsInString(string stringToEscape) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `stringToEscape` | `string?` | The string potentially containing XML/HTML tag syntax or generic type brackets. | + +#### Returns + +Type: `string` +The escaped string safe for MDX rendering. + +#### Remarks + +Converts angle brackets to HTML entities to prevent MDX parser interpretation as JSX/HTML tags. + This handles both generic type syntax (e.g., JsonConverter<object>) and XML documentation tags + (e.g., <see cref="...">) by converting them to JsonConverter&lt;object&gt; and + &lt;see cref="..."&gt; respectively. + +### GetAccessModifier Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the access modifier string for the given accessibility. + +#### Syntax + +```csharp +protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessibility) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `accessibility` | `Microsoft.CodeAnalysis.Accessibility` | The accessibility to convert. | + +#### Returns + +Type: `string` +The access modifier string. + +### GetEventSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the event signature string. + +#### Syntax + +```csharp +protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `evt` | `Microsoft.CodeAnalysis.IEventSymbol` | The event symbol. | + +#### Returns + +Type: `string` +The event signature. + +### GetFieldSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the field signature string. + +#### Syntax + +```csharp +protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `field` | `Microsoft.CodeAnalysis.IFieldSymbol` | The field symbol. | + +#### Returns + +Type: `string` +The field signature. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetMemberSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the member signature for a member symbol. + +#### Syntax + +```csharp +protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `member` | `CloudNimble.DotNetDocs.Core.DocMember` | The member to get the signature for. | + +#### Returns + +Type: `string` +The member signature string. + +### GetMethodSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the method signature string. + +#### Syntax + +```csharp +protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `method` | `Microsoft.CodeAnalysis.IMethodSymbol` | The method symbol. | + +#### Returns + +Type: `string` +The method signature. + +### GetNamespaceFileName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe file name for a namespace, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetNamespaceFileName(CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file name for. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the namespace. + +#### Remarks + +This method is deprecated. Use GetNamespaceFilePath instead. + +### GetNamespaceFilePath Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file path for a namespace documentation file. + +#### Syntax + +```csharp +protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file path for. | +| `outputPath` | `string` | The base output path. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +The full file path for the namespace documentation. + +### GetPropertySignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the property signature string. + +#### Syntax + +```csharp +protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol property) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `property` | `Microsoft.CodeAnalysis.IPropertySymbol` | The property symbol. | + +#### Returns + +Type: `string` +The property signature. + +### GetSafeNamespaceName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe namespace name for use in file names and display. + +#### Syntax + +```csharp +public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the name for. | + +#### Returns + +Type: `string` +A safe namespace name, using "global" for the global namespace. + +### GetSafeTypeName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe type name for use in file names, removing invalid characters. + +#### Syntax + +```csharp +protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the name for. | + +#### Returns + +Type: `string` +A safe type name with invalid characters replaced. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetTypeFileName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe file name for a type, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetTypeFileName(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file name for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the type. + +#### Remarks + +This method is deprecated. Use GetTypeFilePath instead. + +### GetTypeFilePath Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file path for a type documentation file. + +#### Syntax + +```csharp +protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file path for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `outputPath` | `string` | The base output path. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +The full file path for the type documentation. + +### GetTypeSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the type signature string. + +#### Syntax + +```csharp +protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the signature for. | + +#### Returns + +Type: `string` +The type signature. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### RemoveIndentation Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Removes common leading indentation from multi-line text content. + +#### Syntax + +```csharp +internal static string RemoveIndentation(string text) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `text` | `string` | The text to remove indentation from. | + +#### Returns + +Type: `string` +The text with common indentation removed. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase.mdx new file mode 100644 index 0000000..b47b8c6 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase.mdx @@ -0,0 +1,248 @@ +--- +title: RendererBase +description: "Base class for documentation renderers providing common functionality." +icon: shapes +tag: "ABSTRACT" +keywords: ['RendererBase', 'CloudNimble.DotNetDocs.Core.Renderers.RendererBase', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.RendererBase +``` + +## Summary + +Base class for documentation renderers providing common functionality. + +## Constructors + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Enabled + +When more than one Renderer is registered, allows a renderer to be turned off. + +#### Syntax + +```csharp +public bool Enabled { get; set; } +``` + +#### Property Value + +Type: `bool` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetNamespaceFileName + +Gets a safe file name for a namespace, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetNamespaceFileName(CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file name for. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the namespace. + +#### Remarks + +This method is deprecated. Use GetNamespaceFilePath instead. + +### GetSafeNamespaceName + +Gets a safe namespace name for use in file names and display. + +#### Syntax + +```csharp +public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the name for. | + +#### Returns + +Type: `string` +A safe namespace name, using "global" for the global namespace. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetTypeFileName + +Gets a safe file name for a type, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetTypeFileName(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file name for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the type. + +#### Remarks + +This method is deprecated. Use GetTypeFilePath instead. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter.mdx new file mode 100644 index 0000000..df9d1aa --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter.mdx @@ -0,0 +1,238 @@ +--- +title: AccessibilityTypeConverter +description: "Custom type converter for Accessibility enum." +icon: file-brackets-curly +keywords: ['AccessibilityTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.AccessibilityTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers.YamlConverters + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.AccessibilityTypeConverter +``` + +## Summary + +Custom type converter for Accessibility enum. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public AccessibilityTypeConverter() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Accepts + +Determines whether this converter can handle the specified type. + +#### Syntax + +```csharp +public bool Accepts(System.Type type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `System.Type` | The type to check. | + +#### Returns + +Type: `bool` +true if this converter can handle the type; otherwise, false. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReadYaml + +Reads the YAML representation of the object. + +#### Syntax + +```csharp +public object ReadYaml(YamlDotNet.Core.IParser parser, System.Type type, YamlDotNet.Serialization.ObjectDeserializer rootDeserializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `parser` | `YamlDotNet.Core.IParser` | The parser to read from. | +| `type` | `System.Type` | The type of the object. | +| `rootDeserializer` | `YamlDotNet.Serialization.ObjectDeserializer` | The root deserializer. | + +#### Returns + +Type: `object?` +The deserialized object. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `NotImplementedException` | Reading is not supported. | + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteYaml + +Writes the YAML representation of the object. + +#### Syntax + +```csharp +public void WriteYaml(YamlDotNet.Core.IEmitter emitter, object value, System.Type type, YamlDotNet.Serialization.ObjectSerializer serializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `emitter` | `YamlDotNet.Core.IEmitter` | The emitter to write to. | +| `value` | `object?` | The value to serialize. | +| `type` | `System.Type` | The type of the value. | +| `serializer` | `YamlDotNet.Serialization.ObjectSerializer` | The serializer. | + +## Related APIs + +- YamlDotNet.Serialization.IYamlTypeConverter + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter.mdx new file mode 100644 index 0000000..bb5c8c3 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter.mdx @@ -0,0 +1,238 @@ +--- +title: RefKindTypeConverter +description: "Custom type converter for RefKind enum." +icon: file-brackets-curly +keywords: ['RefKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.RefKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers.YamlConverters + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.RefKindTypeConverter +``` + +## Summary + +Custom type converter for RefKind enum. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public RefKindTypeConverter() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Accepts + +Determines whether this converter can handle the specified type. + +#### Syntax + +```csharp +public bool Accepts(System.Type type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `System.Type` | The type to check. | + +#### Returns + +Type: `bool` +true if this converter can handle the type; otherwise, false. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReadYaml + +Reads the YAML representation of the object. + +#### Syntax + +```csharp +public object ReadYaml(YamlDotNet.Core.IParser parser, System.Type type, YamlDotNet.Serialization.ObjectDeserializer rootDeserializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `parser` | `YamlDotNet.Core.IParser` | The parser to read from. | +| `type` | `System.Type` | The type of the object. | +| `rootDeserializer` | `YamlDotNet.Serialization.ObjectDeserializer` | The root deserializer. | + +#### Returns + +Type: `object?` +The deserialized object. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `NotImplementedException` | Reading is not supported. | + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteYaml + +Writes the YAML representation of the object. + +#### Syntax + +```csharp +public void WriteYaml(YamlDotNet.Core.IEmitter emitter, object value, System.Type type, YamlDotNet.Serialization.ObjectSerializer serializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `emitter` | `YamlDotNet.Core.IEmitter` | The emitter to write to. | +| `value` | `object?` | The value to serialize. | +| `type` | `System.Type` | The type of the value. | +| `serializer` | `YamlDotNet.Serialization.ObjectSerializer` | The serializer. | + +## Related APIs + +- YamlDotNet.Serialization.IYamlTypeConverter + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter.mdx new file mode 100644 index 0000000..68a190a --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter.mdx @@ -0,0 +1,238 @@ +--- +title: SymbolKindTypeConverter +description: "Custom type converter for SymbolKind enum." +icon: file-brackets-curly +keywords: ['SymbolKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.SymbolKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers.YamlConverters + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.SymbolKindTypeConverter +``` + +## Summary + +Custom type converter for SymbolKind enum. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public SymbolKindTypeConverter() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Accepts + +Determines whether this converter can handle the specified type. + +#### Syntax + +```csharp +public bool Accepts(System.Type type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `System.Type` | The type to check. | + +#### Returns + +Type: `bool` +true if this converter can handle the type; otherwise, false. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReadYaml + +Reads the YAML representation of the object. + +#### Syntax + +```csharp +public object ReadYaml(YamlDotNet.Core.IParser parser, System.Type type, YamlDotNet.Serialization.ObjectDeserializer rootDeserializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `parser` | `YamlDotNet.Core.IParser` | The parser to read from. | +| `type` | `System.Type` | The type of the object. | +| `rootDeserializer` | `YamlDotNet.Serialization.ObjectDeserializer` | The root deserializer. | + +#### Returns + +Type: `object?` +The deserialized object. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `NotImplementedException` | Reading is not supported. | + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteYaml + +Writes the YAML representation of the object. + +#### Syntax + +```csharp +public void WriteYaml(YamlDotNet.Core.IEmitter emitter, object value, System.Type type, YamlDotNet.Serialization.ObjectSerializer serializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `emitter` | `YamlDotNet.Core.IEmitter` | The emitter to write to. | +| `value` | `object?` | The value to serialize. | +| `type` | `System.Type` | The type of the value. | +| `serializer` | `YamlDotNet.Serialization.ObjectSerializer` | The serializer. | + +## Related APIs + +- YamlDotNet.Serialization.IYamlTypeConverter + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter.mdx new file mode 100644 index 0000000..642ae89 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter.mdx @@ -0,0 +1,238 @@ +--- +title: SymbolTypeConverter +description: "Custom type converter for ISymbol interface to prevent serialization." +icon: file-brackets-curly +keywords: ['SymbolTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.SymbolTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers.YamlConverters + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.SymbolTypeConverter +``` + +## Summary + +Custom type converter for ISymbol interface to prevent serialization. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public SymbolTypeConverter() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Accepts + +Determines whether this converter can handle the specified type. + +#### Syntax + +```csharp +public bool Accepts(System.Type type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `System.Type` | The type to check. | + +#### Returns + +Type: `bool` +true if this converter can handle the type; otherwise, false. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReadYaml + +Reads the YAML representation of the object. + +#### Syntax + +```csharp +public object ReadYaml(YamlDotNet.Core.IParser parser, System.Type type, YamlDotNet.Serialization.ObjectDeserializer rootDeserializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `parser` | `YamlDotNet.Core.IParser` | The parser to read from. | +| `type` | `System.Type` | The type of the object. | +| `rootDeserializer` | `YamlDotNet.Serialization.ObjectDeserializer` | The root deserializer. | + +#### Returns + +Type: `object?` +The deserialized object. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `NotImplementedException` | Reading is not supported. | + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteYaml + +Writes the YAML representation of the object. + +#### Syntax + +```csharp +public void WriteYaml(YamlDotNet.Core.IEmitter emitter, object value, System.Type type, YamlDotNet.Serialization.ObjectSerializer serializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `emitter` | `YamlDotNet.Core.IEmitter` | The emitter to write to. | +| `value` | `object?` | The value to serialize. | +| `type` | `System.Type` | The type of the value. | +| `serializer` | `YamlDotNet.Serialization.ObjectSerializer` | The serializer. | + +## Related APIs + +- YamlDotNet.Serialization.IYamlTypeConverter + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter.mdx new file mode 100644 index 0000000..6573ef0 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter.mdx @@ -0,0 +1,238 @@ +--- +title: TypeKindTypeConverter +description: "Custom type converter for TypeKind enum." +icon: file-brackets-curly +keywords: ['TypeKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.TypeKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers.YamlConverters + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.TypeKindTypeConverter +``` + +## Summary + +Custom type converter for TypeKind enum. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public TypeKindTypeConverter() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Accepts + +Determines whether this converter can handle the specified type. + +#### Syntax + +```csharp +public bool Accepts(System.Type type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `System.Type` | The type to check. | + +#### Returns + +Type: `bool` +true if this converter can handle the type; otherwise, false. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReadYaml + +Reads the YAML representation of the object. + +#### Syntax + +```csharp +public object ReadYaml(YamlDotNet.Core.IParser parser, System.Type type, YamlDotNet.Serialization.ObjectDeserializer rootDeserializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `parser` | `YamlDotNet.Core.IParser` | The parser to read from. | +| `type` | `System.Type` | The type of the object. | +| `rootDeserializer` | `YamlDotNet.Serialization.ObjectDeserializer` | The root deserializer. | + +#### Returns + +Type: `object?` +The deserialized object. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `NotImplementedException` | Reading is not supported. | + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteYaml + +Writes the YAML representation of the object. + +#### Syntax + +```csharp +public void WriteYaml(YamlDotNet.Core.IEmitter emitter, object value, System.Type type, YamlDotNet.Serialization.ObjectSerializer serializer) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `emitter` | `YamlDotNet.Core.IEmitter` | The emitter to write to. | +| `value` | `object?` | The value to serialize. | +| `type` | `System.Type` | The type of the value. | +| `serializer` | `YamlDotNet.Serialization.ObjectSerializer` | The serializer. | + +## Related APIs + +- YamlDotNet.Serialization.IYamlTypeConverter + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/index.mdx new file mode 100644 index 0000000..f577b9a --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/index.mdx @@ -0,0 +1,20 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Core.Renderers.YamlConverters Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'namespace', 'AccessibilityTypeConverter', 'RefKindTypeConverter', 'SymbolKindTypeConverter', 'SymbolTypeConverter', 'TypeKindTypeConverter'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [AccessibilityTypeConverter](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter) | Custom type converter for Accessibility enum. | +| [RefKindTypeConverter](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter) | Custom type converter for RefKind enum. | +| [SymbolKindTypeConverter](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter) | Custom type converter for SymbolKind enum. | +| [SymbolTypeConverter](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter) | Custom type converter for ISymbol interface to prevent serialization. | +| [TypeKindTypeConverter](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter) | Custom type converter for TypeKind enum. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer.mdx new file mode 100644 index 0000000..84f4050 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer.mdx @@ -0,0 +1,663 @@ +--- +title: YamlRenderer +description: "Renders documentation as YAML files." +icon: file-brackets-curly +keywords: ['YamlRenderer', 'CloudNimble.DotNetDocs.Core.Renderers.YamlRenderer', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.RendererBase', 'CloudNimble.DotNetDocs.Core.IDocRenderer'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Renderers + +**Inheritance:** CloudNimble.DotNetDocs.Core.Renderers.RendererBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Renderers.YamlRenderer +``` + +## Summary + +Renders documentation as YAML files. + +## Remarks + +Generates structured YAML documentation suitable for configuration files and + integration with various documentation platforms. + +## Constructors + +### .ctor + +Initializes a new instance of the [YamlRenderer](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer) class. + +#### Syntax + +```csharp +public YamlRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Initializes a new instance of the [RendererBase](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase) class. + +#### Syntax + +```csharp +protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null, bool enabled = true) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | +| `enabled` | `bool` | - | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Context Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the project context for this renderer. + +#### Syntax + +```csharp +protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.ProjectContext` +The project context containing configuration and settings. + +### Enabled Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +When more than one Renderer is registered, allows a renderer to be turned off. + +#### Syntax + +```csharp +public bool Enabled { get; set; } +``` + +#### Property Value + +Type: `bool` + +### FileNamingOptions Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file naming options for this renderer. + +#### Syntax + +```csharp +protected CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions FileNamingOptions { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions` +The file naming configuration. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### EscapeXmlTagsInString Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Escapes XML/HTML tag syntax for safe rendering in Markdown/MDX. + +#### Syntax + +```csharp +protected static string EscapeXmlTagsInString(string stringToEscape) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `stringToEscape` | `string?` | The string potentially containing XML/HTML tag syntax or generic type brackets. | + +#### Returns + +Type: `string` +The escaped string safe for MDX rendering. + +#### Remarks + +Converts angle brackets to HTML entities to prevent MDX parser interpretation as JSX/HTML tags. + This handles both generic type syntax (e.g., JsonConverter<object>) and XML documentation tags + (e.g., <see cref="...">) by converting them to JsonConverter&lt;object&gt; and + &lt;see cref="..."&gt; respectively. + +### GetAccessModifier Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the access modifier string for the given accessibility. + +#### Syntax + +```csharp +protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessibility) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `accessibility` | `Microsoft.CodeAnalysis.Accessibility` | The accessibility to convert. | + +#### Returns + +Type: `string` +The access modifier string. + +### GetEventSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the event signature string. + +#### Syntax + +```csharp +protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `evt` | `Microsoft.CodeAnalysis.IEventSymbol` | The event symbol. | + +#### Returns + +Type: `string` +The event signature. + +### GetFieldSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the field signature string. + +#### Syntax + +```csharp +protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `field` | `Microsoft.CodeAnalysis.IFieldSymbol` | The field symbol. | + +#### Returns + +Type: `string` +The field signature. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetMemberSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the member signature for a member symbol. + +#### Syntax + +```csharp +protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `member` | `CloudNimble.DotNetDocs.Core.DocMember` | The member to get the signature for. | + +#### Returns + +Type: `string` +The member signature string. + +### GetMethodSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the method signature string. + +#### Syntax + +```csharp +protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `method` | `Microsoft.CodeAnalysis.IMethodSymbol` | The method symbol. | + +#### Returns + +Type: `string` +The method signature. + +### GetNamespaceFileName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe file name for a namespace, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetNamespaceFileName(CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file name for. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the namespace. + +#### Remarks + +This method is deprecated. Use GetNamespaceFilePath instead. + +### GetNamespaceFilePath Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file path for a namespace documentation file. + +#### Syntax + +```csharp +protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the file path for. | +| `outputPath` | `string` | The base output path. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +The full file path for the namespace documentation. + +### GetPropertySignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the property signature string. + +#### Syntax + +```csharp +protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol property) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `property` | `Microsoft.CodeAnalysis.IPropertySymbol` | The property symbol. | + +#### Returns + +Type: `string` +The property signature. + +### GetSafeNamespaceName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe namespace name for use in file names and display. + +#### Syntax + +```csharp +public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace to get the name for. | + +#### Returns + +Type: `string` +A safe namespace name, using "global" for the global namespace. + +### GetSafeTypeName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe type name for use in file names, removing invalid characters. + +#### Syntax + +```csharp +protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the name for. | + +#### Returns + +Type: `string` +A safe type name with invalid characters replaced. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetTypeFileName Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets a safe file name for a type, suitable for use in file systems. + +#### Syntax + +```csharp +public string GetTypeFileName(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file name for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +A safe file name for the type. + +#### Remarks + +This method is deprecated. Use GetTypeFilePath instead. + +### GetTypeFilePath Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the file path for a type documentation file. + +#### Syntax + +```csharp +protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the file path for. | +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The namespace containing the type. | +| `outputPath` | `string` | The base output path. | +| `extension` | `string` | The file extension (without the dot). | + +#### Returns + +Type: `string` +The full file path for the type documentation. + +### GetTypeSignature Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Gets the type signature string. + +#### Syntax + +```csharp +protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `type` | `CloudNimble.DotNetDocs.Core.DocType` | The type to get the signature for. | + +#### Returns + +Type: `string` +The type signature. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### RemoveIndentation Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` + +Removes common leading indentation from multi-line text content. + +#### Syntax + +```csharp +internal static string RemoveIndentation(string text) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `text` | `string` | The text to remove indentation from. | + +#### Returns + +Type: `string` +The text with common indentation removed. + +### RenderAsync + +Renders the documentation assembly to YAML files. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous rendering operation. + +### RenderPlaceholdersAsync + +Renders placeholder conceptual content files for the documentation assembly. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to generate placeholders for. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous placeholder rendering operation. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocRenderer + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/index.mdx new file mode 100644 index 0000000..0242f6d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/index.mdx @@ -0,0 +1,21 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Core.Renderers Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Core.Renderers', 'namespace', 'JsonRenderer', 'JsonRendererOptions', 'MarkdownRenderer', 'MarkdownRendererBase', 'RendererBase', 'YamlRenderer'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [JsonRenderer](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer) | Renders documentation as JSON files. | +| [JsonRendererOptions](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions) | Configuration options for the JsonRenderer. | +| [MarkdownRenderer](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer) | Renders documentation as Markdown files. | +| [MarkdownRendererBase](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase) | Base class for Markdown-based renderers providing common formatting utilities. | +| [RendererBase](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase) | Base class for documentation renderers providing common functionality. | +| [YamlRenderer](/test/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer) | Renders documentation as YAML files. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.mdx new file mode 100644 index 0000000..5872cc8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.mdx @@ -0,0 +1,204 @@ +--- +title: MarkdownXmlTransformer +description: "Transforms XML documentation tags in DocEntity properties to Markdown format." +icon: file-brackets-curly +keywords: ['MarkdownXmlTransformer', 'CloudNimble.DotNetDocs.Core.Transformers.MarkdownXmlTransformer', 'CloudNimble.DotNetDocs.Core.Transformers', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Core.IDocTransformer'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core.Transformers + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Transformers.MarkdownXmlTransformer +``` + +## Summary + +Transforms XML documentation tags in DocEntity properties to Markdown format. + +## Remarks + +This transformer processes all string properties in the DocEntity object graph, + converting XML documentation tags to their Markdown equivalents. It uses performance-optimized + regex patterns to skip strings without XML tags and builds cross-references in a single pass. + +## Constructors + +### .ctor + +Initializes a new instance of the [MarkdownXmlTransformer](/test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer) class. + +#### Syntax + +```csharp +public MarkdownXmlTransformer(CloudNimble.DotNetDocs.Core.ProjectContext projectContext) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `projectContext` | `CloudNimble.DotNetDocs.Core.ProjectContext` | The project context for configuration and file naming. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### TransformAsync + +Transforms a documentation entity by converting XML tags to Markdown. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task TransformAsync(CloudNimble.DotNetDocs.Core.DocEntity entity) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entity` | `CloudNimble.DotNetDocs.Core.DocEntity` | The documentation entity to transform. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous transformation operation. + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocTransformer + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/index.mdx new file mode 100644 index 0000000..22107a1 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/index.mdx @@ -0,0 +1,16 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Core.Transformers Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Core.Transformers', 'namespace', 'MarkdownXmlTransformer'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [MarkdownXmlTransformer](/test/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer) | Transforms XML documentation tags in DocEntity properties to Markdown format. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/index.mdx new file mode 100644 index 0000000..218213c --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Core/index.mdx @@ -0,0 +1,50 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Core Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Core', 'namespace', 'AssemblyManager', 'CrossReferenceResolver', 'DocAssembly', 'DocConstants', 'DocEntity', 'DocEnum', 'DocEnumValue', 'DocException', 'DocMember', 'DocNamespace'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [AssemblyManager](/test/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager) | Manages assembly metadata extraction using Roslyn for API documentation generation. | +| [CrossReferenceResolver](/test/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver) | Resolves cross-references in documentation to their target entities and generates appropriate links. | +| [DocAssembly](/test/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly) | Represents documentation for a .NET assembly. | +| [DocConstants](/test/api-reference/CloudNimble/DotNetDocs/Core/DocConstants) | Defines constants used throughout the DotNetDocs library. | +| [DocEntity](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) | Base class for documentation entities, providing common contextual metadata. | +| [DocEnum](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnum) | Represents documentation for a .NET enum type. | +| [DocEnumValue](/test/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue) | Represents a single value within an enum type. | +| [DocException](/test/api-reference/CloudNimble/DotNetDocs/Core/DocException) | Represents exception documentation extracted from XML documentation comments. | +| [DocMember](/test/api-reference/CloudNimble/DotNetDocs/Core/DocMember) | Represents documentation for a .NET member (method, property, field, event, etc.). | +| [DocNamespace](/test/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace) | Represents documentation for a .NET namespace. | +| [DocParameter](/test/api-reference/CloudNimble/DotNetDocs/Core/DocParameter) | Represents documentation for a method or constructor parameter. | +| [DocReference](/test/api-reference/CloudNimble/DotNetDocs/Core/DocReference) | Represents a cross-reference in documentation, such as a see or seealso tag. | +| [DocReferenceHandlerBase](/test/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase) | Base class for documentation reference handlers providing common file copying functionality. | +| [DocType](/test/api-reference/CloudNimble/DotNetDocs/Core/DocType) | Represents documentation for a .NET type. | +| [DocTypeParameter](/test/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter) | Represents type parameter documentation extracted from XML documentation comments. | +| [DocumentationManager](/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager) | Orchestrates the documentation pipeline for one or more assemblies. | +| [DocumentationReference](/test/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference) | Represents a reference to external documentation to be combined into a documentation collection. | +| [MarkdownDocReferenceHandler](/test/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler) | Base class for Markdown-based documentation reference handlers providing content path rewriting. | +| [ProjectContext](/test/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext) | Represents MSBuild project context for source intent in documentation generation. | +| [ReferenceType](/test/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType) | Specifies the type of documentation reference. | + +### Interfaces + +| Name | Summary | +| ---- | ------- | +| [IDocEnricher](/test/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher) | Defines an enricher for conceptual documentation augmentation. | +| [IDocReferenceHandler](/test/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler) | Defines a handler for processing documentation references from other projects. | +| [IDocRenderer](/test/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer) | Defines a renderer for documentation output generation. | +| [IDocTransformer](/test/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer) | Defines a transformation step in the documentation processing pipeline. | + +### Enums + +| Name | Summary | +| ---- | ------- | +| [ReferenceType](/test/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType) | Specifies the type of documentation reference. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig.mdx new file mode 100644 index 0000000..56a0392 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig.mdx @@ -0,0 +1,219 @@ +--- +title: DocsNavigationConfig +description: "Configuration for DotNetDocs-specific navigation properties." +icon: file-brackets-curly +keywords: ['DocsNavigationConfig', 'CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig +``` + +## Summary + +Configuration for DotNetDocs-specific navigation properties. + +## Remarks + +This class holds metadata that bridges .docsproj XML templates to Mintlify.Core, + but is not part of the Mintlify docs.json specification itself. + These properties control how DotNetDocs organizes and integrates documentation + into the Mintlify navigation structure. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public DocsNavigationConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Mode + +Gets or sets the navigation mode for multi-assembly documentation. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Mintlify.NavigationMode Mode { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Mintlify.NavigationMode?` +The navigation organization mode. Default is NavigationMode.Unified. + +### Name + +Gets or sets the navigation name/title for this documentation project when Type is Tabs or Products. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string?` +The display name for the tab or product. If not specified, the project name will be used. + +### Type + +Gets or sets the navigation type for this documentation project. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Mintlify.NavigationType Type { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Mintlify.NavigationType?` +The navigation type. Default is NavigationType.Pages. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler.mdx new file mode 100644 index 0000000..7e43cdf --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler.mdx @@ -0,0 +1,88 @@ +--- +title: MintlifyDocReferenceHandler +description: "Handles documentation references for Mintlify documentation format." +icon: file-brackets-curly +keywords: ['MintlifyDocReferenceHandler', 'CloudNimble.DotNetDocs.Mintlify.MintlifyDocReferenceHandler', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify + +**Inheritance:** CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.MintlifyDocReferenceHandler +``` + +## Summary + +Handles documentation references for Mintlify documentation format. + +## Remarks + + + + + This handler extends [MarkdownDocReferenceHandler](/test/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler) to add Mintlify-specific + content rewriting patterns including ES imports, JSX attributes, and CSS url() references. + + + + + + It processes referenced documentation by: + + + + + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MintlifyDocReferenceHandler() +``` + +## Properties + +### DocumentationType Override + +#### Syntax + +```csharp +public override CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` + +## Methods + +### ProcessAsync Override + +#### Syntax + +```csharp +public override System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | - | +| `documentationRootPath` | `string` | - | + +#### Returns + +Type: `System.Threading.Tasks.Task` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons.mdx new file mode 100644 index 0000000..dac3f5d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons.mdx @@ -0,0 +1,238 @@ +--- +title: MintlifyIcons +description: "Provides FontAwesome 7 icon mappings for different .NET documentation entities in Mintlify." +icon: bolt +tag: "STATIC" +keywords: ['MintlifyIcons', 'CloudNimble.DotNetDocs.Mintlify.MintlifyIcons', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.MintlifyIcons +``` + +## Summary + +Provides FontAwesome 7 icon mappings for different .NET documentation entities in Mintlify. + +## Methods + +### GetIconForAccessibility + +Gets the icon for an Accessibility enum value. + +#### Syntax + +```csharp +public static string GetIconForAccessibility(Microsoft.CodeAnalysis.Accessibility accessibility) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `accessibility` | `Microsoft.CodeAnalysis.Accessibility` | The accessibility level. | + +#### Returns + +Type: `string` +The FontAwesome icon name. + +### GetIconForAccessModifier + +Gets the icon for an access modifier. + +#### Syntax + +```csharp +public static string GetIconForAccessModifier(string accessModifier) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `accessModifier` | `string` | The access modifier string. | + +#### Returns + +Type: `string` +The FontAwesome icon name. + +### GetIconForAssembly + +Gets the appropriate icon for a DocAssembly. + +#### Syntax + +```csharp +public static string GetIconForAssembly(CloudNimble.DotNetDocs.Core.DocAssembly assembly) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `assembly` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly. | + +#### Returns + +Type: `string` +The FontAwesome icon name. + +### GetIconForEntity + +Gets the appropriate icon for a DocEntity based on its type. + +#### Syntax + +```csharp +public static string GetIconForEntity(CloudNimble.DotNetDocs.Core.DocEntity entity) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entity` | `CloudNimble.DotNetDocs.Core.DocEntity` | The documentation entity. | + +#### Returns + +Type: `string` +The FontAwesome icon name. + +### GetIconForMember + +Gets the icon for a DocMember based on its kind and characteristics. + +#### Syntax + +```csharp +public static string GetIconForMember(CloudNimble.DotNetDocs.Core.DocMember member) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `member` | `CloudNimble.DotNetDocs.Core.DocMember` | The documentation member. | + +#### Returns + +Type: `string` +The FontAwesome icon name. + +### GetIconForMethod + +Gets the icon for a DocMember method, considering special characteristics. + +#### Syntax + +```csharp +public static string GetIconForMethod(CloudNimble.DotNetDocs.Core.DocMember docMember) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `docMember` | `CloudNimble.DotNetDocs.Core.DocMember` | The documentation member (should be a method). | + +#### Returns + +Type: `string` +The FontAwesome icon name. + +### GetIconForNamespace + +Gets the icon for a DocNamespace based on whether it has types. + +#### Syntax + +```csharp +public static string GetIconForNamespace(CloudNimble.DotNetDocs.Core.DocNamespace ns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `ns` | `CloudNimble.DotNetDocs.Core.DocNamespace` | The documentation namespace. | + +#### Returns + +Type: `string` +The FontAwesome icon name. + +### GetIconForNamespaceSegment + +Gets an icon based on the namespace segment for organization-specific icons. + +#### Syntax + +```csharp +public static string GetIconForNamespaceSegment(string namespaceName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `namespaceName` | `string` | The full namespace name. | + +#### Returns + +Type: `string` +The FontAwesome icon name based on common patterns. + +### GetIconForType + +Gets the icon for a DocType based on its kind and characteristics. + +#### Syntax + +```csharp +public static string GetIconForType(CloudNimble.DotNetDocs.Core.DocType docType) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `docType` | `CloudNimble.DotNetDocs.Core.DocType` | The documentation type. | + +#### Returns + +Type: `string` +The FontAwesome icon name. + +### GetIconForTypeByName + +Gets an appropriate icon based on common type naming patterns. + +#### Syntax + +```csharp +public static string GetIconForTypeByName(string typeName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `typeName` | `string` | The type name. | + +#### Returns + +Type: `string` +A FontAwesome icon based on the type name pattern. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer.mdx new file mode 100644 index 0000000..588f70d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer.mdx @@ -0,0 +1,99 @@ +--- +title: MintlifyRenderer +description: "Renders documentation as MDX files with Mintlify frontmatter and navigation." +icon: file-brackets-curly +keywords: ['MintlifyRenderer', 'CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase', 'CloudNimble.DotNetDocs.Core.IDocRenderer'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify + +**Inheritance:** CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +## Summary + +Renders documentation as MDX files with Mintlify frontmatter and navigation. + +## Remarks + +Generates structured MDX documentation with Mintlify-specific features including + frontmatter with icons, tags, and SEO metadata. Optionally generates docs.json + navigation configuration for Mintlify documentation sites. + +## Constructors + +### .ctor + +Initializes a new instance of the [MintlifyRenderer](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer) class. + +#### Syntax + +```csharp +public MintlifyRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context, Microsoft.Extensions.Options.IOptions options, Mintlify.Core.DocsJsonManager docsJsonManager) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `context` | `CloudNimble.DotNetDocs.Core.ProjectContext` | The project context. | +| `options` | `Microsoft.Extensions.Options.IOptions` | The Mintlify renderer options. | +| `docsJsonManager` | `Mintlify.Core.DocsJsonManager` | The DocsJsonManager for navigation generation. | + +## Methods + +### RenderAsync + +Renders the documentation assembly to MDX files with optional docs.json generation. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous rendering operation. + +### RenderPlaceholdersAsync + +Renders placeholder conceptual content files for the documentation assembly. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDocs.Core.DocAssembly model) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to generate placeholders for. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous placeholder rendering operation. + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocRenderer + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions.mdx new file mode 100644 index 0000000..38d70f6 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions.mdx @@ -0,0 +1,278 @@ +--- +title: MintlifyRendererOptions +description: "Configuration options for the Mintlify documentation renderer." +icon: file-brackets-curly +keywords: ['MintlifyRendererOptions', 'CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions +``` + +## Summary + +Configuration options for the Mintlify documentation renderer. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MintlifyRendererOptions() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### GenerateDocsJson + +Gets or sets whether to generate the docs.json navigation file. + +#### Syntax + +```csharp +public bool GenerateDocsJson { get; set; } +``` + +#### Property Value + +Type: `bool` +True to generate docs.json alongside MDX files; otherwise, false. + Default is true. + +### GenerateNamespaceIndex + +Gets or sets whether to generate index files for namespaces. + +#### Syntax + +```csharp +public bool GenerateNamespaceIndex { get; set; } +``` + +#### Property Value + +Type: `bool` +True to generate index.mdx files for namespace documentation; otherwise, false. + Default is true. + +### IncludeIcons + +Gets or sets whether to include icons in navigation and frontmatter. + +#### Syntax + +```csharp +public bool IncludeIcons { get; set; } +``` + +#### Property Value + +Type: `bool` +True to include FontAwesome icons; otherwise, false. + Default is true. + +### NamespaceOrder + +Gets or sets the custom order for namespaces in navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List NamespaceOrder { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` +A list of namespace patterns in the desired order, or null for alphabetical ordering. + Supports wildcards (e.g., "System.*" matches all System namespaces). + +### Navigation + +Gets or sets the navigation configuration for DotNetDocs-specific properties. + +#### Syntax + +```csharp +public CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig Navigation { get; set; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig` +A DocsNavigationConfig instance that controls navigation mode, type, and name. + Default is a new instance with Mode=Unified, Type=Pages, and Name=null. + +### Template + +Gets or sets a custom template for the docs.json configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.DocsJsonConfig Template { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.DocsJsonConfig?` +A DocsJsonConfig instance to use as a template, or null to use defaults. + The navigation section will be generated automatically. + +### UnifiedGroupName + +Gets or sets the group name used when NavigationMode is Unified. + +#### Syntax + +```csharp +public string UnifiedGroupName { get; set; } +``` + +#### Property Value + +Type: `string` +The name of the unified API reference group. Default is "API Reference". + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode.mdx new file mode 100644 index 0000000..1a87f4f --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode.mdx @@ -0,0 +1,35 @@ +--- +title: NavigationMode +description: "Specifies how navigation should be organized when generating documentation from multiple assemblies." +icon: list-ol +tag: "ENUM" +keywords: ['NavigationMode', 'CloudNimble.DotNetDocs.Mintlify.NavigationMode', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Enum'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify + +**Inheritance:** System.Enum + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.NavigationMode +``` + +## Summary + +Specifies how navigation should be organized when generating documentation from multiple assemblies. + +## Values + +| Name | Value | Description | +|------|-------|-------------| +| `Unified` | 0 | All assemblies are merged into a single unified navigation structure. + This is the default mode for backward compatibility. | +| `ByAssembly` | 1 | Each assembly gets its own top-level group in the navigation. + Useful for large solutions with distinct assembly boundaries. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType.mdx new file mode 100644 index 0000000..533ed10 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType.mdx @@ -0,0 +1,34 @@ +--- +title: NavigationType +description: "Defines the navigation type for documentation integration." +icon: list-ol +tag: "ENUM" +keywords: ['NavigationType', 'CloudNimble.DotNetDocs.Mintlify.NavigationType', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Enum'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify + +**Inheritance:** System.Enum + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.NavigationType +``` + +## Summary + +Defines the navigation type for documentation integration. + +## Values + +| Name | Value | Description | +|------|-------|-------------| +| `Pages` | 0 | Documentation appears in the main navigation as pages. | +| `Tabs` | 1 | Documentation appears as a top-level tab. | +| `Products` | 2 | Documentation appears as a product in the products section. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer.mdx new file mode 100644 index 0000000..f76ab18 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer.mdx @@ -0,0 +1,196 @@ +--- +title: MintlifyMarkdownTransformer +description: "Transforms HTML-style comments to JSX-style comments for MDX compatibility." +icon: file-brackets-curly +keywords: ['MintlifyMarkdownTransformer', 'CloudNimble.DotNetDocs.Mintlify.Transformers.MintlifyMarkdownTransformer', 'CloudNimble.DotNetDocs.Mintlify.Transformers', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Core.IDocTransformer'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify.Transformers + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.Transformers.MintlifyMarkdownTransformer +``` + +## Summary + +Transforms HTML-style comments to JSX-style comments for MDX compatibility. + +## Remarks + +MDX (used by Mintlify) requires JSX-style comments {/* */} instead of HTML comments <!-- -->. + This transformer processes all string properties in the DocEntity object graph and converts + HTML comments to JSX comments to prevent MDX parsing errors. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MintlifyMarkdownTransformer() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### TransformAsync + +Transforms a documentation entity by converting HTML comments to JSX comments. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task TransformAsync(CloudNimble.DotNetDocs.Core.DocEntity entity) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `entity` | `CloudNimble.DotNetDocs.Core.DocEntity` | The documentation entity to transform. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous transformation operation. + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocTransformer + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/index.mdx new file mode 100644 index 0000000..4682f5f --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/index.mdx @@ -0,0 +1,16 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Mintlify.Transformers Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Mintlify.Transformers', 'namespace', 'MintlifyMarkdownTransformer'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [MintlifyMarkdownTransformer](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer) | Transforms HTML-style comments to JSX-style comments for MDX compatibility. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/index.mdx new file mode 100644 index 0000000..ba7b437 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Mintlify/index.mdx @@ -0,0 +1,29 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Mintlify Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Mintlify', 'namespace', 'DocsNavigationConfig', 'MintlifyDocReferenceHandler', 'MintlifyIcons', 'MintlifyRenderer', 'MintlifyRendererOptions', 'NavigationMode', 'NavigationType'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [DocsNavigationConfig](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig) | Configuration for DotNetDocs-specific navigation properties. | +| [MintlifyDocReferenceHandler](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler) | Handles documentation references for Mintlify documentation format. | +| [MintlifyIcons](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons) | Provides FontAwesome 7 icon mappings for different .NET documentation entities in Mintlify. | +| [MintlifyRenderer](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer) | Renders documentation as MDX files with Mintlify frontmatter and navigation. | +| [MintlifyRendererOptions](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions) | Configuration options for the Mintlify documentation renderer. | +| [NavigationMode](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode) | Specifies how navigation should be organized when generating documentation from multiple assemblies. | +| [NavigationType](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType) | Defines the navigation type for documentation integration. | + +### Enums + +| Name | Summary | +| ---- | ------- | +| [NavigationMode](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode) | Specifies how navigation should be organized when generating documentation from multiple assemblies. | +| [NavigationType](/test/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType) | Defines the navigation type for documentation integration. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand.mdx new file mode 100644 index 0000000..502d034 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand.mdx @@ -0,0 +1,358 @@ +--- +title: AddCommand +description: "Command-line tool for creating and adding a documentation project to a solution file." +icon: file-brackets-curly +keywords: ['AddCommand', 'CloudNimble.DotNetDocs.Tools.Commands.AddCommand', 'CloudNimble.DotNetDocs.Tools.Commands', 'class', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Tools.dll + +**Namespace:** CloudNimble.DotNetDocs.Tools.Commands + +**Inheritance:** CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Tools.Commands.AddCommand +``` + +## Summary + +Command-line tool for creating and adding a documentation project to a solution file. + +## Remarks + +This command creates a .docsproj file configured for the specified documentation type (defaults to Mintlify) + and adds it to the specified solution file (.sln or .slnx). The project is automatically added to a "Docs" solution folder. + For .slnx files, the command post-processes the XML to add Type="C#" attributes to .docsproj nodes. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public AddCommand() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +#### Syntax + +```csharp +public DocsCommandBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### DocumentationType + +Gets or sets the documentation type for the project. + +#### Syntax + +```csharp +public string DocumentationType { get; set; } +``` + +#### Property Value + +Type: `string?` + +### OutputDirectory + +Gets or sets the output directory for the generated documentation project. + +#### Syntax + +```csharp +public string OutputDirectory { get; set; } +``` + +#### Property Value + +Type: `string?` + +### ProjectName + +Gets or sets the name of the documentation project. + +#### Syntax + +```csharp +public string ProjectName { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +If not specified, the project name defaults to the solution name. + +### SkipSolution + +Gets or sets whether to skip adding the project to the solution file. + +#### Syntax + +```csharp +public bool SkipSolution { get; set; } +``` + +#### Property Value + +Type: `bool` + +### SolutionPath + +Gets or sets the path to the solution file (.sln or .slnx) to use. + +#### Syntax + +```csharp +public string SolutionPath { get; set; } +``` + +#### Property Value + +Type: `string?` + +### UsePrerelease + +Gets or sets whether to use the latest prerelease version of the DotNetDocs.Sdk. + +#### Syntax + +```csharp +public bool UsePrerelease { get; set; } +``` + +#### Property Value + +Type: `bool` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetLatestSdkVersionAsync Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Queries NuGet.org for the latest version of the DotNetDocs.Sdk package. + +#### Syntax + +```csharp +protected static System.Threading.Tasks.Task GetLatestSdkVersionAsync(bool includePrerelease) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `includePrerelease` | `bool` | Whether to include prerelease versions in the search. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +The latest version string, or null if the query fails. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetVersion Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Gets the version string for the tool. + +#### Syntax + +```csharp +internal static string GetVersion() +``` + +#### Returns + +Type: `string` +The version string. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### OnExecute + +Executes the command to create and add a documentation project to the specified solution. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication app) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `app` | `McMaster.Extensions.CommandLineUtils.CommandLineApplication` | The command-line application context used to access command-line arguments and configuration. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task that represents the asynchronous operation. The task result is 0 if the documentation project is + created and added successfully; otherwise, 1. + +#### Remarks + +If the solution file is not specified, the method attempts to locate one in the + current directory. The documentation project is created in the specified output directory or, if not + provided, in a default location based on the solution file. Any errors encountered during execution are + reported to the console, and a nonzero exit code is returned. + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteHeader Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Writes the DotNetDocs CLI header to the console with colorful ASCII art and version information. + +#### Syntax + +```csharp +public static void WriteHeader() +``` + +#### Remarks + +This method displays a multi-line ASCII art logo combining the DotNetDocs branding with + version and attribution information. The output uses console colors to create an eye-catching + header for CLI operations. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase.mdx new file mode 100644 index 0000000..424e768 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase.mdx @@ -0,0 +1,181 @@ +--- +title: DocsCommandBase +description: "Base class for all DotNetDocs CLI commands, providing shared functionality like header display." +icon: file-brackets-curly +keywords: ['DocsCommandBase', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase', 'CloudNimble.DotNetDocs.Tools.Commands.Base', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Tools.dll + +**Namespace:** CloudNimble.DotNetDocs.Tools.Commands.Base + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase +``` + +## Summary + +Base class for all DotNetDocs CLI commands, providing shared functionality like header display. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public DocsCommandBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteHeader + +Writes the DotNetDocs CLI header to the console with colorful ASCII art and version information. + +#### Syntax + +```csharp +public static void WriteHeader() +``` + +#### Remarks + +This method displays a multi-line ASCII art logo combining the DotNetDocs branding with + version and attribution information. The output uses console colors to create an eye-catching + header for CLI operations. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/index.mdx new file mode 100644 index 0000000..7a2fc97 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/index.mdx @@ -0,0 +1,16 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Tools.Commands.Base Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Tools.Commands.Base', 'namespace', 'DocsCommandBase'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [DocsCommandBase](/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase) | Base class for all DotNetDocs CLI commands, providing shared functionality like header display. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand.mdx new file mode 100644 index 0000000..aaccf50 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand.mdx @@ -0,0 +1,308 @@ +--- +title: BuildCommand +icon: file-brackets-curly +keywords: ['BuildCommand', 'CloudNimble.DotNetDocs.Tools.Commands.BuildCommand', 'CloudNimble.DotNetDocs.Tools.Commands', 'class', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Tools.dll + +**Namespace:** CloudNimble.DotNetDocs.Tools.Commands + +**Inheritance:** CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Tools.Commands.BuildCommand +``` + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public BuildCommand() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +#### Syntax + +```csharp +public DocsCommandBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### ApiReferencePath + +#### Syntax + +```csharp +public string ApiReferencePath { get; set; } +``` + +#### Property Value + +Type: `string` + +### AssemblyListFile + +#### Syntax + +```csharp +public string AssemblyListFile { get; set; } +``` + +#### Property Value + +Type: `string` + +### DocumentationType + +#### Syntax + +```csharp +public string DocumentationType { get; set; } +``` + +#### Property Value + +Type: `string` + +### NamespaceMode + +#### Syntax + +```csharp +public string NamespaceMode { get; set; } +``` + +#### Property Value + +Type: `string` + +### OutputPath + +#### Syntax + +```csharp +public string OutputPath { get; set; } +``` + +#### Property Value + +Type: `string` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetLatestSdkVersionAsync Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Queries NuGet.org for the latest version of the DotNetDocs.Sdk package. + +#### Syntax + +```csharp +protected static System.Threading.Tasks.Task GetLatestSdkVersionAsync(bool includePrerelease) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `includePrerelease` | `bool` | Whether to include prerelease versions in the search. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +The latest version string, or null if the query fails. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetVersion Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Gets the version string for the tool. + +#### Syntax + +```csharp +internal static string GetVersion() +``` + +#### Returns + +Type: `string` +The version string. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### OnExecute + +#### Syntax + +```csharp +public System.Threading.Tasks.Task OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication app) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `app` | `McMaster.Extensions.CommandLineUtils.CommandLineApplication` | - | + +#### Returns + +Type: `System.Threading.Tasks.Task` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteHeader Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Writes the DotNetDocs CLI header to the console with colorful ASCII art and version information. + +#### Syntax + +```csharp +public static void WriteHeader() +``` + +#### Remarks + +This method displays a multi-line ASCII art logo combining the DotNetDocs branding with + version and attribution information. The output uses console colors to create an eye-catching + header for CLI operations. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand.mdx new file mode 100644 index 0000000..14be8b8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand.mdx @@ -0,0 +1,260 @@ +--- +title: DocsRootCommand +description: "Represents the root command for the DotNetDocs command-line interface (CLI) application." +icon: file-brackets-curly +keywords: ['DocsRootCommand', 'CloudNimble.DotNetDocs.Tools.Commands.DocsRootCommand', 'CloudNimble.DotNetDocs.Tools.Commands', 'class', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Tools.dll + +**Namespace:** CloudNimble.DotNetDocs.Tools.Commands + +**Inheritance:** CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Tools.Commands.DocsRootCommand +``` + +## Summary + +Represents the root command for the DotNetDocs command-line interface (CLI) application. + +## Remarks + +This command serves as the entry point for the DotNetDocs CLI and provides access to + subcommands such as build and add. When invoked without a subcommand or with insufficient arguments, it displays + help information describing available commands and usage. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public DocsRootCommand() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +#### Syntax + +```csharp +public DocsCommandBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetLatestSdkVersionAsync Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Queries NuGet.org for the latest version of the DotNetDocs.Sdk package. + +#### Syntax + +```csharp +protected static System.Threading.Tasks.Task GetLatestSdkVersionAsync(bool includePrerelease) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `includePrerelease` | `bool` | Whether to include prerelease versions in the search. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +The latest version string, or null if the query fails. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetVersion Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Gets the version string for the tool. + +#### Syntax + +```csharp +internal static string GetVersion() +``` + +#### Returns + +Type: `string` +The version string. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### OnExecute + +Displays the help information for the specified command-line application. + +#### Syntax + +```csharp +public int OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication app) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `app` | `McMaster.Extensions.CommandLineUtils.CommandLineApplication` | The command-line application for which to display help information. Cannot be null. | + +#### Returns + +Type: `int` +Always returns 0 after displaying the help information. + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteHeader Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Writes the DotNetDocs CLI header to the console with colorful ASCII art and version information. + +#### Syntax + +```csharp +public static void WriteHeader() +``` + +#### Remarks + +This method displays a multi-line ASCII art logo combining the DotNetDocs branding with + version and attribution information. The output uses console colors to create an eye-catching + header for CLI operations. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand.mdx new file mode 100644 index 0000000..387c303 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand.mdx @@ -0,0 +1,311 @@ +--- +title: UpdateCommand +description: "Command-line tool for updating existing .docsproj files to use the latest DotNetDocs.Sdk version from NuGet." +icon: file-brackets-curly +keywords: ['UpdateCommand', 'CloudNimble.DotNetDocs.Tools.Commands.UpdateCommand', 'CloudNimble.DotNetDocs.Tools.Commands', 'class', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Tools.dll + +**Namespace:** CloudNimble.DotNetDocs.Tools.Commands + +**Inheritance:** CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Tools.Commands.UpdateCommand +``` + +## Summary + +Command-line tool for updating existing .docsproj files to use the latest DotNetDocs.Sdk version from NuGet. + +## Remarks + +This command searches for all .docsproj files in the current directory (and optionally subdirectories), + queries NuGet.org for the latest SDK version, and updates the SDK reference in each file. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public UpdateCommand() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +#### Syntax + +```csharp +public DocsCommandBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### ProjectPath + +Gets or sets the project name or path to a specific .docsproj file to update. + +#### Syntax + +```csharp +public string ProjectPath { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Recursive + +Gets or sets whether to search recursively in subdirectories. + +#### Syntax + +```csharp +public bool Recursive { get; set; } +``` + +#### Property Value + +Type: `bool` + +### UsePrerelease + +Gets or sets whether to use the latest prerelease version of the DotNetDocs.Sdk. + +#### Syntax + +```csharp +public bool UsePrerelease { get; set; } +``` + +#### Property Value + +Type: `bool` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetLatestSdkVersionAsync Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Queries NuGet.org for the latest version of the DotNetDocs.Sdk package. + +#### Syntax + +```csharp +protected static System.Threading.Tasks.Task GetLatestSdkVersionAsync(bool includePrerelease) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `includePrerelease` | `bool` | Whether to include prerelease versions in the search. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +The latest version string, or null if the query fails. + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GetVersion Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Gets the version string for the tool. + +#### Syntax + +```csharp +internal static string GetVersion() +``` + +#### Returns + +Type: `string` +The version string. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### OnExecute + +Executes the command to update .docsproj SDK references to the latest version from NuGet. + +#### Syntax + +```csharp +public System.Threading.Tasks.Task OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication app) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `app` | `McMaster.Extensions.CommandLineUtils.CommandLineApplication` | The command-line application context used to access command-line arguments and configuration. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task that represents the asynchronous operation. The task result is 0 if the update is + successful; otherwise, 1. + +#### Remarks + +If a specific project is not specified, the method searches for all .docsproj files in the current directory + (and subdirectories if --recursive is specified). The --project option accepts either a project name + (e.g., "MyProject.Docs") or a file path (e.g., "MyProject.Docs.docsproj" or "path/to/MyProject.Docs.docsproj"). + Any errors encountered during execution are reported to the console, and a nonzero exit code is returned. + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### WriteHeader Inherited + +Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` + +Writes the DotNetDocs CLI header to the console with colorful ASCII art and version information. + +#### Syntax + +```csharp +public static void WriteHeader() +``` + +#### Remarks + +This method displays a multi-line ASCII art logo combining the DotNetDocs branding with + version and attribution information. The output uses console colors to create an eye-catching + header for CLI operations. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/index.mdx new file mode 100644 index 0000000..17c1668 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/index.mdx @@ -0,0 +1,19 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Tools.Commands Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Tools.Commands', 'namespace', 'AddCommand', 'BuildCommand', 'DocsRootCommand', 'UpdateCommand'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [AddCommand](/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand) | Command-line tool for creating and adding a documentation project to a solution file. | +| [BuildCommand](/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand) | | +| [DocsRootCommand](/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand) | Represents the root command for the DotNetDocs command-line interface (CLI) application. | +| [UpdateCommand](/test/api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand) | Command-line tool for updating existing .docsproj files to use the latest DotNetDocs.Sdk version from NuGet. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion.mdx new file mode 100644 index 0000000..8c369aa --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion.mdx @@ -0,0 +1,339 @@ +--- +title: NuGetVersion +description: "Represents a simplified NuGet version for comparison purposes." +icon: file-brackets-curly +keywords: ['NuGetVersion', 'CloudNimble.DotNetDocs.Tools.Models.NuGetVersion', 'CloudNimble.DotNetDocs.Tools.Models', 'class', 'System.Object', 'System.IComparable'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Tools.dll + +**Namespace:** CloudNimble.DotNetDocs.Tools.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Tools.Models.NuGetVersion +``` + +## Summary + +Represents a simplified NuGet version for comparison purposes. + +## Remarks + +This class provides basic semantic versioning support with major, minor, patch, and prerelease components. + It implements [IComparable`1](https://learn.microsoft.com/dotnet/api/system.icomparable-1) to allow version comparisons, where stable versions are considered + greater than prerelease versions with the same major.minor.patch numbers. + +## Constructors + +### .ctor + +Initializes a new instance of the [NuGetVersion](/test/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion) class from a version string. + +#### Syntax + +```csharp +public NuGetVersion(string version) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `version` | `string` | The version string to parse (e.g., "1.0.0" or "1.0.0-preview.1"). | + +#### Remarks + +The version string should be in the format "major.minor.patch" or "major.minor.patch-prerelease". + If any component cannot be parsed, it defaults to 0. + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### IsPrerelease + +Gets a value indicating whether this version is a prerelease version. + +#### Syntax + +```csharp +public bool IsPrerelease { get; } +``` + +#### Property Value + +Type: `bool` + +### Major + +Gets the major version component. + +#### Syntax + +```csharp +public int Major { get; } +``` + +#### Property Value + +Type: `int` + +### Minor + +Gets the minor version component. + +#### Syntax + +```csharp +public int Minor { get; } +``` + +#### Property Value + +Type: `int` + +### Patch + +Gets the patch version component. + +#### Syntax + +```csharp +public int Patch { get; } +``` + +#### Property Value + +Type: `int` + +### Prerelease + +Gets the prerelease label, if any. + +#### Syntax + +```csharp +public string Prerelease { get; } +``` + +#### Property Value + +Type: `string?` + +## Methods + +### CompareTo + +Compares the current version to another version. + +#### Syntax + +```csharp +public int CompareTo(CloudNimble.DotNetDocs.Tools.Models.NuGetVersion other) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `other` | `CloudNimble.DotNetDocs.Tools.Models.NuGetVersion?` | The version to compare to. | + +#### Returns + +Type: `int` +A negative value if this version is less than *other*, zero if they are equal, + or a positive value if this version is greater than *other*. + +#### Remarks + +Version comparison follows semantic versioning rules. Stable versions are considered greater than + prerelease versions with the same major.minor.patch numbers. Prerelease versions are compared + lexicographically by their prerelease labels. + +### Equals Override + +Determines whether the specified object is equal to the current version. + +#### Syntax + +```csharp +public override bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | The object to compare with the current version. | + +#### Returns + +Type: `bool` +`true` if the specified object is equal to the current version; otherwise, `false`. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Override + +Returns a hash code for the current version. + +#### Syntax + +```csharp +public override int GetHashCode() +``` + +#### Returns + +Type: `int` +A hash code for the current version. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns a string representation of the version. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +A string in the format "major.minor.patch" or "major.minor.patch-prerelease". + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- System.IComparable<CloudNimble.DotNetDocs.Tools.Models.NuGetVersion> + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Models/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Models/index.mdx new file mode 100644 index 0000000..1e18495 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Models/index.mdx @@ -0,0 +1,16 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Tools.Models Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Tools.Models', 'namespace', 'NuGetVersion'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [NuGetVersion](/test/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion) | Represents a simplified NuGet version for comparison purposes. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Program.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Program.mdx new file mode 100644 index 0000000..ca678cb --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/Program.mdx @@ -0,0 +1,186 @@ +--- +title: Program +icon: file-brackets-curly +keywords: ['Program', 'CloudNimble.DotNetDocs.Tools.Program', 'CloudNimble.DotNetDocs.Tools', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Tools.dll + +**Namespace:** CloudNimble.DotNetDocs.Tools + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Tools.Program +``` + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public Program() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### Main + +Initializes and runs the application using the specified command-line arguments. + +#### Syntax + +```csharp +public static System.Threading.Tasks.Task Main(string[] args) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `args` | `string[]` | An array of command-line arguments to configure the application's behavior. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task that represents the asynchronous operation. The task result contains the application's exit code. + +#### Remarks + +This method configures the application's host, sets the content root, and runs the + command-line application asynchronously. It is typically used as the application's entry point. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/index.mdx new file mode 100644 index 0000000..44affea --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/CloudNimble/DotNetDocs/Tools/index.mdx @@ -0,0 +1,16 @@ +--- +title: Overview +description: "Summary of the CloudNimble.DotNetDocs.Tools Namespace" +icon: folder-tree +mode: wide +keywords: ['CloudNimble.DotNetDocs.Tools', 'namespace', 'Program'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [Program](/test/api-reference/CloudNimble/DotNetDocs/Tools/Program) | | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/DotNetDocsCore_IServiceCollectionExtensions.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/DotNetDocsCore_IServiceCollectionExtensions.mdx new file mode 100644 index 0000000..d1818d9 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/DotNetDocsCore_IServiceCollectionExtensions.mdx @@ -0,0 +1,337 @@ +--- +title: DotNetDocsCore_IServiceCollectionExtensions +description: "Extension methods for registering DotNetDocs services with dependency injection." +icon: bolt +sidebarTitle: DotNetDocsCore_IServiceCollectionExtensions +tag: "STATIC" +keywords: ['DotNetDocsCore_IServiceCollectionExtensions', 'Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions', 'Microsoft.Extensions.DependencyInjection', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** Microsoft.Extensions.DependencyInjection + +**Inheritance:** System.Object + +## Syntax + +```csharp +Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions +``` + +## Summary + +Extension methods for registering DotNetDocs services with dependency injection. + +## Methods + +### AddDocEnricher + +Adds a custom document enricher to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDocEnricher(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TEnricher : class, CloudNimble.DotNetDocs.Core.IDocEnricher +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TEnricher` - The type of enricher to add. + +#### Examples + +```csharp +services.AddDocEnricher<ConceptualContentEnricher>(); +``` + +#### Remarks + +Registers the enricher as Scoped implementation of IDocEnricher. + Enrichers add conceptual content to documentation entities. + +### AddDocRenderer + +Adds a custom document renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDocRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TRenderer : class, CloudNimble.DotNetDocs.Core.IDocRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TRenderer` - The type of renderer to add. + +#### Examples + +```csharp +services.AddDocRenderer<MyCustomRenderer>(); +``` + +#### Remarks + +Registers the renderer as Scoped implementation of IDocRenderer. + +### AddDocTransformer + +Adds a custom document transformer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDocTransformer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TTransformer : class, CloudNimble.DotNetDocs.Core.IDocTransformer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TTransformer` - The type of transformer to add. + +#### Examples + +```csharp +services.AddDocTransformer<InheritDocTransformer>(); +``` + +#### Remarks + +Registers the transformer as Scoped implementation of IDocTransformer. + Transformers modify the documentation model before rendering. + +### AddDotNetDocs + +Adds DotNetDocs services with all built-in renderers to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDotNetDocs(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureContext = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureContext` | `System.Action?` | Optional action to configure the ProjectContext. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddDotNetDocs(context => +{ + context.OutputPath = "docs/api"; + context.ShowPlaceholders = false; +}); +``` + +#### Remarks + +This method registers: + - ProjectContext as Singleton + - DocumentationManager as Scoped + - All built-in renderers (Markdown, JSON, YAML) as Scoped + - MarkdownXmlTransformer for processing XML documentation tags + +### AddDotNetDocsCore + +Adds only the core DotNetDocs services without any renderers. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDotNetDocsCore(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureContext = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureContext` | `System.Action?` | Optional action to configure the ProjectContext. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsCore(context => +{ + context.OutputPath = "docs"; +}); +services.AddMarkdownRenderer(); +``` + +#### Remarks + +Use this method when you want to manually register specific renderers. + This registers: + - ProjectContext as Singleton + - DocumentationManager as Scoped + +### AddDotNetDocsPipeline + +Adds DotNetDocs services using a fluent pipeline builder. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDotNetDocsPipeline(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configurePipeline) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configurePipeline` | `System.Action` | Action to configure the documentation pipeline. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMarkdownRenderer() + .UseJsonRenderer(options => options.WriteIndented = true) + .AddEnricher<MyCustomEnricher>() + .ConfigureContext(ctx => ctx.OutputPath = "docs"); +}); +``` + +### AddJsonRenderer + +Adds the JSON renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddJsonRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureOptions = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureOptions` | `System.Action?` | Optional action to configure JsonRendererOptions. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddJsonRenderer(options => +{ + options.WriteIndented = true; + options.IncludeNullValues = false; +}); +``` + +#### Remarks + +Registers JsonRenderer as Scoped implementation of IDocRenderer. + +### AddMarkdownRenderer + +Adds the Markdown renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMarkdownRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Remarks + +Registers MarkdownRenderer as Scoped implementation of IDocRenderer. + Also registers MarkdownXmlTransformer to process XML documentation tags. + +### AddYamlRenderer + +Adds the YAML renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddYamlRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Remarks + +Registers YamlRenderer as Scoped implementation of IDocRenderer. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/DotNetDocsMintlify_IServiceCollectionExtensions.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/DotNetDocsMintlify_IServiceCollectionExtensions.mdx new file mode 100644 index 0000000..967ab7e --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/DotNetDocsMintlify_IServiceCollectionExtensions.mdx @@ -0,0 +1,190 @@ +--- +title: DotNetDocsMintlify_IServiceCollectionExtensions +description: "Extension methods for registering Mintlify documentation services with dependency injection." +icon: bolt +sidebarTitle: DotNetDocsMintlify_IServiceCollectionExtensions +tag: "STATIC" +keywords: ['DotNetDocsMintlify_IServiceCollectionExtensions', 'Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions', 'Microsoft.Extensions.DependencyInjection', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** Microsoft.Extensions.DependencyInjection + +**Inheritance:** System.Object + +## Syntax + +```csharp +Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions +``` + +## Summary + +Extension methods for registering Mintlify documentation services with dependency injection. + +## Methods + +### AddMintlifyRenderer + +Adds the Mintlify renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyRenderer(); +``` + +#### Remarks + + + +This method registers: + + + + +### AddMintlifyRenderer + +Adds a custom Mintlify renderer implementation to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddMintlifyRenderer<CustomMintlifyRenderer>(); +``` + +#### Remarks + + + +Registers the custom renderer as Scoped implementation of IDocRenderer. + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + +### AddMintlifyServices + +Adds Mintlify documentation services including the renderer and DocsJsonManager. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyServices(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyServices(); +``` + +#### Remarks + + + +This method registers: + + + + +### AddMintlifyServices + +Adds Mintlify documentation services with configuration options. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyServices(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureMintlify) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyServices(options => +{ + options.GenerateDocsJson = true; + options.IncludeIcons = true; +}); +``` + +#### Remarks + + + +This method registers: + + + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/IServiceCollection.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/IServiceCollection.mdx new file mode 100644 index 0000000..6a4d384 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/IServiceCollection.mdx @@ -0,0 +1,524 @@ +--- +title: IServiceCollection +description: "Extension methods for IServiceCollection from Microsoft.Extensions.DependencyInjection.Abstractions" +icon: file-brackets-curly +keywords: ['IServiceCollection', 'Microsoft.Extensions.DependencyInjection.IServiceCollection', 'Microsoft.Extensions.DependencyInjection', 'error'] +--- + +## Definition + +**Assembly:** Microsoft.Extensions.DependencyInjection.Abstractions.dll + +**Namespace:** Microsoft.Extensions.DependencyInjection + +## Syntax + +```csharp +Microsoft.Extensions.DependencyInjection.IServiceCollection +``` + +## Summary + +This type is defined in Microsoft.Extensions.DependencyInjection.Abstractions. + +## Remarks + +See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection) for more information about the rest of the API. + +## Methods + +### AddDocEnricher Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds a custom document enricher to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDocEnricher(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TEnricher : class, CloudNimble.DotNetDocs.Core.IDocEnricher +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TEnricher` - The type of enricher to add. + +#### Examples + +```csharp +services.AddDocEnricher<ConceptualContentEnricher>(); +``` + +#### Remarks + +Registers the enricher as Scoped implementation of IDocEnricher. + Enrichers add conceptual content to documentation entities. + +### AddDocRenderer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds a custom document renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDocRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TRenderer : class, CloudNimble.DotNetDocs.Core.IDocRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TRenderer` - The type of renderer to add. + +#### Examples + +```csharp +services.AddDocRenderer<MyCustomRenderer>(); +``` + +#### Remarks + +Registers the renderer as Scoped implementation of IDocRenderer. + +### AddDocTransformer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds a custom document transformer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDocTransformer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TTransformer : class, CloudNimble.DotNetDocs.Core.IDocTransformer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TTransformer` - The type of transformer to add. + +#### Examples + +```csharp +services.AddDocTransformer<InheritDocTransformer>(); +``` + +#### Remarks + +Registers the transformer as Scoped implementation of IDocTransformer. + Transformers modify the documentation model before rendering. + +### AddDotNetDocs Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds DotNetDocs services with all built-in renderers to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDotNetDocs(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureContext = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureContext` | `System.Action?` | Optional action to configure the ProjectContext. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddDotNetDocs(context => +{ + context.OutputPath = "docs/api"; + context.ShowPlaceholders = false; +}); +``` + +#### Remarks + +This method registers: + - ProjectContext as Singleton + - DocumentationManager as Scoped + - All built-in renderers (Markdown, JSON, YAML) as Scoped + - MarkdownXmlTransformer for processing XML documentation tags + +### AddDotNetDocsCore Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds only the core DotNetDocs services without any renderers. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDotNetDocsCore(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureContext = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureContext` | `System.Action?` | Optional action to configure the ProjectContext. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsCore(context => +{ + context.OutputPath = "docs"; +}); +services.AddMarkdownRenderer(); +``` + +#### Remarks + +Use this method when you want to manually register specific renderers. + This registers: + - ProjectContext as Singleton + - DocumentationManager as Scoped + +### AddDotNetDocsPipeline Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds DotNetDocs services using a fluent pipeline builder. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddDotNetDocsPipeline(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configurePipeline) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configurePipeline` | `System.Action` | Action to configure the documentation pipeline. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMarkdownRenderer() + .UseJsonRenderer(options => options.WriteIndented = true) + .AddEnricher<MyCustomEnricher>() + .ConfigureContext(ctx => ctx.OutputPath = "docs"); +}); +``` + +### AddJsonRenderer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds the JSON renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddJsonRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureOptions = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureOptions` | `System.Action?` | Optional action to configure JsonRendererOptions. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddJsonRenderer(options => +{ + options.WriteIndented = true; + options.IncludeNullValues = false; +}); +``` + +#### Remarks + +Registers JsonRenderer as Scoped implementation of IDocRenderer. + +### AddMarkdownRenderer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds the Markdown renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMarkdownRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Remarks + +Registers MarkdownRenderer as Scoped implementation of IDocRenderer. + Also registers MarkdownXmlTransformer to process XML documentation tags. + +### AddMintlifyRenderer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions` + +Adds the Mintlify renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyRenderer(); +``` + +#### Remarks + + + +This method registers: + + + + +### AddMintlifyRenderer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions` + +Adds a custom Mintlify renderer implementation to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddMintlifyRenderer<CustomMintlifyRenderer>(); +``` + +#### Remarks + + + +Registers the custom renderer as Scoped implementation of IDocRenderer. + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + +### AddMintlifyServices Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions` + +Adds Mintlify documentation services including the renderer and DocsJsonManager. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyServices(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyServices(); +``` + +#### Remarks + + + +This method registers: + + + + +### AddMintlifyServices Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions` + +Adds Mintlify documentation services with configuration options. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyServices(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureMintlify) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyServices(options => +{ + options.GenerateDocsJson = true; + options.IncludeIcons = true; +}); +``` + +#### Remarks + + + +This method registers: + + + + +### AddYamlRenderer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` + +Adds the YAML renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddYamlRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Remarks + +Registers YamlRenderer as Scoped implementation of IDocRenderer. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/index.mdx new file mode 100644 index 0000000..f7920ab --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Microsoft/Extensions/DependencyInjection/index.mdx @@ -0,0 +1,10 @@ +--- +title: Overview +description: "Summary of the Microsoft.Extensions.DependencyInjection Namespace" +icon: folder-tree +mode: wide +keywords: ['Microsoft.Extensions.DependencyInjection', 'namespace', 'IServiceCollection'] +--- + +## Types + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ApiConfigConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ApiConfigConverter.mdx new file mode 100644 index 0000000..f05d08d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ApiConfigConverter.mdx @@ -0,0 +1,112 @@ +--- +title: ApiConfigConverter +description: "Handles JSON conversion for API configuration properties that can be strings, arrays, or objects." +icon: file-brackets-curly +keywords: ['ApiConfigConverter', 'Mintlify.Core.Converters.ApiConfigConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.ApiSpecConfig> + +## Syntax + +```csharp +Mintlify.Core.Converters.ApiConfigConverter +``` + +## Summary + +Handles JSON conversion for API configuration properties that can be strings, arrays, or objects. + +## Remarks + +API configurations in Mintlify (OpenAPI and AsyncAPI) can be specified as: + - String: Single URL to specification file + - Array: Multiple URLs to specification files + - Object: Complex configuration with source and directory properties + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ApiConfigConverter() +``` + +## Methods + +### CanConvert Override + +Determines whether the specified type can be converted by this converter. + +#### Syntax + +```csharp +public override bool CanConvert(System.Type typeToConvert) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `typeToConvert` | `System.Type` | The type to convert. | + +#### Returns + +Type: `bool` +True if the type is ApiSpecConfig; otherwise, false. + +### Read Override + +Reads and converts the JSON to an ApiSpecConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.ApiSpecConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.ApiSpecConfig?` +An ApiSpecConfig for all supported API configuration formats. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the JSON token type is not supported. | + +### Write Override + +Writes the ApiSpecConfig object to JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.ApiSpecConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.ApiSpecConfig?` | The ApiSpecConfig value to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/BackgroundImageConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/BackgroundImageConverter.mdx new file mode 100644 index 0000000..1ef6c82 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/BackgroundImageConverter.mdx @@ -0,0 +1,111 @@ +--- +title: BackgroundImageConverter +description: "Handles JSON conversion for background image properties that can be either strings or objects." +icon: file-brackets-curly +keywords: ['BackgroundImageConverter', 'Mintlify.Core.Converters.BackgroundImageConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.BackgroundImageConfig> + +## Syntax + +```csharp +Mintlify.Core.Converters.BackgroundImageConverter +``` + +## Summary + +Handles JSON conversion for background image properties that can be either strings or objects. + +## Remarks + +Background image configurations in Mintlify can be specified as: + - String: Single image URL (e.g., "https://example.com/image.png") + - Object: Light/dark mode specific images with "light" and "dark" properties + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public BackgroundImageConverter() +``` + +## Methods + +### CanConvert Override + +Determines whether the specified type can be converted by this converter. + +#### Syntax + +```csharp +public override bool CanConvert(System.Type typeToConvert) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `typeToConvert` | `System.Type` | The type to convert. | + +#### Returns + +Type: `bool` +True if the type is BackgroundImageConfig; otherwise, false. + +### Read Override + +Reads and converts the JSON to a BackgroundImageConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.BackgroundImageConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.BackgroundImageConfig?` +A BackgroundImageConfig for both simple URLs and theme-specific configurations. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the JSON token type is not supported. | + +### Write Override + +Writes the BackgroundImageConfig object to JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.BackgroundImageConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.BackgroundImageConfig?` | The BackgroundImageConfig value to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ColorConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ColorConverter.mdx new file mode 100644 index 0000000..9a27fa5 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ColorConverter.mdx @@ -0,0 +1,111 @@ +--- +title: ColorConverter +description: "Handles JSON conversion for color properties that can be either strings or objects." +icon: file-brackets-curly +keywords: ['ColorConverter', 'Mintlify.Core.Converters.ColorConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.ColorConfig> + +## Syntax + +```csharp +Mintlify.Core.Converters.ColorConverter +``` + +## Summary + +Handles JSON conversion for color properties that can be either strings or objects. + +## Remarks + +Color configurations in Mintlify can be specified as: + - String: Simple hex color value (e.g., "#FF0000") + - Object: Complex color configuration with light and dark mode properties + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ColorConverter() +``` + +## Methods + +### CanConvert Override + +Determines whether the specified type can be converted by this converter. + +#### Syntax + +```csharp +public override bool CanConvert(System.Type typeToConvert) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `typeToConvert` | `System.Type` | The type to convert. | + +#### Returns + +Type: `bool` +True if the type is ColorConfig; otherwise, false. + +### Read Override + +Reads and converts the JSON to a ColorConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.ColorConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.ColorConfig?` +A ColorConfig object. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the JSON token type is not supported. | + +### Write Override + +Writes the ColorConfig object to JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.ColorConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.ColorConfig` | The ColorConfig value to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/IconConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/IconConverter.mdx new file mode 100644 index 0000000..9369b07 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/IconConverter.mdx @@ -0,0 +1,111 @@ +--- +title: IconConverter +description: "Handles JSON conversion for icon properties that can be either strings or objects." +icon: file-brackets-curly +keywords: ['IconConverter', 'Mintlify.Core.Converters.IconConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.IconConfig> + +## Syntax + +```csharp +Mintlify.Core.Converters.IconConverter +``` + +## Summary + +Handles JSON conversion for icon properties that can be either strings or objects. + +## Remarks + +Icons in Mintlify can be specified as: + - String: Simple icon name (e.g., "folder", "home") + - Object: Icon configuration with name, style, and library properties + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public IconConverter() +``` + +## Methods + +### CanConvert Override + +Determines whether the specified type can be converted by this converter. + +#### Syntax + +```csharp +public override bool CanConvert(System.Type typeToConvert) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `typeToConvert` | `System.Type` | The type to convert. | + +#### Returns + +Type: `bool` +True if the type is IconConfig; otherwise, false. + +### Read Override + +Reads and converts the JSON to an IconConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.IconConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.IconConfig?` +An IconConfig for both simple icon names and complex icon configurations. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the JSON token type is not supported. | + +### Write Override + +Writes the IconConfig object to JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.IconConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.IconConfig?` | The IconConfig value to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationJsonConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationJsonConverter.mdx new file mode 100644 index 0000000..ee15324 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationJsonConverter.mdx @@ -0,0 +1,77 @@ +--- +title: NavigationJsonConverter +description: "Custom JSON converter for navigation that outputs simple array format for Mintlify compatibility." +icon: file-brackets-curly +keywords: ['NavigationJsonConverter', 'Mintlify.Core.Converters.NavigationJsonConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.NavigationConfig> + +## Syntax + +```csharp +Mintlify.Core.Converters.NavigationJsonConverter +``` + +## Summary + +Custom JSON converter for navigation that outputs simple array format for Mintlify compatibility. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public NavigationJsonConverter() +``` + +## Methods + +### Read Override + +Reads navigation from JSON, supporting both array and object formats. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.NavigationConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | - | +| `typeToConvert` | `System.Type` | - | +| `options` | `System.Text.Json.JsonSerializerOptions` | - | + +#### Returns + +Type: `Mintlify.Core.Models.NavigationConfig?` + +### Write Override + +Writes navigation to JSON in the appropriate format for Mintlify compatibility. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.NavigationConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | - | +| `value` | `Mintlify.Core.Models.NavigationConfig` | - | +| `options` | `System.Text.Json.JsonSerializerOptions` | - | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationPageConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationPageConverter.mdx new file mode 100644 index 0000000..dffa61d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationPageConverter.mdx @@ -0,0 +1,116 @@ +--- +title: NavigationPageConverter +description: "Handles JSON conversion for navigation page items that can be either strings or GroupConfig objects." +icon: file-brackets-curly +keywords: ['NavigationPageConverter', 'Mintlify.Core.Converters.NavigationPageConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<object> + +## Syntax + +```csharp +Mintlify.Core.Converters.NavigationPageConverter +``` + +## Summary + +Handles JSON conversion for navigation page items that can be either strings or GroupConfig objects. + +## Remarks + +This converter is used for polymorphic navigation page properties in Mintlify configuration objects. + It properly deserializes JSON into strongly-typed objects instead of JsonElement instances. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public NavigationPageConverter() +``` + +## Methods + +### CanConvert Override + +Determines whether the specified type can be converted by this converter. + +#### Syntax + +```csharp +public override bool CanConvert(System.Type typeToConvert) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `typeToConvert` | `System.Type` | The type to convert. | + +#### Returns + +Type: `bool` +True if the type is object; otherwise, false. + +### Read Override + +Reads and converts the JSON to a navigation page object. + +#### Syntax + +```csharp +public override object Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `object?` +A string for page paths or a GroupConfig for nested navigation groups. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the JSON token type is not supported. | + +### Write Override + +Writes the navigation page object to JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, object value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `object` | The value to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the value type is not supported. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationPageListConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationPageListConverter.mdx new file mode 100644 index 0000000..d032a67 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/NavigationPageListConverter.mdx @@ -0,0 +1,89 @@ +--- +title: NavigationPageListConverter +description: "Handles JSON conversion for lists of navigation page items that can be either strings or GroupConfig objects." +icon: file-brackets-curly +keywords: ['NavigationPageListConverter', 'Mintlify.Core.Converters.NavigationPageListConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter>'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<System.Collections.Generic.List<object>> + +## Syntax + +```csharp +Mintlify.Core.Converters.NavigationPageListConverter +``` + +## Summary + +Handles JSON conversion for lists of navigation page items that can be either strings or GroupConfig objects. + +## Remarks + +This converter uses a static NavigationPageConverter instance for efficient conversion of all items + in the list without creating new converter instances for each item. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public NavigationPageListConverter() +``` + +## Methods + +### Read Override + +Reads and converts the JSON array to a list of navigation page objects. + +#### Syntax + +```csharp +public override System.Collections.Generic.List Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `System.Collections.Generic.List` +A list containing string and GroupConfig objects. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the JSON token is not a StartArray. | + +### Write Override + +Writes the list of navigation page objects to JSON array. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, System.Collections.Generic.List value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `System.Collections.Generic.List` | The list of navigation page objects to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter.mdx new file mode 100644 index 0000000..649ddcf --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter.mdx @@ -0,0 +1,111 @@ +--- +title: PrimaryNavigationConverter +description: "Handles JSON conversion for primary navigation properties that can be different types of objects." +icon: file-brackets-curly +keywords: ['PrimaryNavigationConverter', 'Mintlify.Core.Converters.PrimaryNavigationConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.PrimaryNavigationConfig> + +## Syntax + +```csharp +Mintlify.Core.Converters.PrimaryNavigationConverter +``` + +## Summary + +Handles JSON conversion for primary navigation properties that can be different types of objects. + +## Remarks + +Primary navigation in Mintlify NavbarConfig can be specified as: + - Object: Button configuration with type, label, and href properties + - Object: GitHub configuration with type and href properties + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public PrimaryNavigationConverter() +``` + +## Methods + +### CanConvert Override + +Determines whether the specified type can be converted by this converter. + +#### Syntax + +```csharp +public override bool CanConvert(System.Type typeToConvert) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `typeToConvert` | `System.Type` | The type to convert. | + +#### Returns + +Type: `bool` +True if the type is PrimaryNavigationConfig; otherwise, false. + +### Read Override + +Reads and converts the JSON to a PrimaryNavigationConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.PrimaryNavigationConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.PrimaryNavigationConfig?` +A PrimaryNavigationConfig object. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the JSON token type is not supported. | + +### Write Override + +Writes the PrimaryNavigationConfig object to JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.PrimaryNavigationConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.PrimaryNavigationConfig` | The PrimaryNavigationConfig value to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ServerConfigConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ServerConfigConverter.mdx new file mode 100644 index 0000000..efcc015 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/ServerConfigConverter.mdx @@ -0,0 +1,111 @@ +--- +title: ServerConfigConverter +description: "Handles JSON conversion for server configuration properties that can be strings or arrays." +icon: file-brackets-curly +keywords: ['ServerConfigConverter', 'Mintlify.Core.Converters.ServerConfigConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Converters + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.ServerConfig> + +## Syntax + +```csharp +Mintlify.Core.Converters.ServerConfigConverter +``` + +## Summary + +Handles JSON conversion for server configuration properties that can be strings or arrays. + +## Remarks + +Server configurations in Mintlify can be specified as: + - String: Single server URL + - Array: Multiple server URLs + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ServerConfigConverter() +``` + +## Methods + +### CanConvert Override + +Determines whether the specified type can be converted by this converter. + +#### Syntax + +```csharp +public override bool CanConvert(System.Type typeToConvert) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `typeToConvert` | `System.Type` | The type to convert. | + +#### Returns + +Type: `bool` +True if the type is ServerConfig; otherwise, false. + +### Read Override + +Reads and converts the JSON to a ServerConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.ServerConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.ServerConfig?` +A ServerConfig for all supported server configuration formats. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `JsonException` | Thrown when the JSON token type is not supported. | + +### Write Override + +Writes the ServerConfig object to JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.ServerConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.ServerConfig?` | The ServerConfig value to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/index.mdx new file mode 100644 index 0000000..4d42d9a --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Converters/index.mdx @@ -0,0 +1,24 @@ +--- +title: Overview +description: "Summary of the Mintlify.Core.Converters Namespace" +icon: folder-tree +mode: wide +keywords: ['Mintlify.Core.Converters', 'namespace', 'ApiConfigConverter', 'BackgroundImageConverter', 'ColorConverter', 'IconConverter', 'NavigationJsonConverter', 'NavigationPageConverter', 'NavigationPageListConverter', 'PrimaryNavigationConverter', 'ServerConfigConverter'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [ApiConfigConverter](/test/api-reference/Mintlify/Core/Converters/ApiConfigConverter) | Handles JSON conversion for API configuration properties that can be strings, arrays, or objects. | +| [BackgroundImageConverter](/test/api-reference/Mintlify/Core/Converters/BackgroundImageConverter) | Handles JSON conversion for background image properties that can be either strings or objects. | +| [ColorConverter](/test/api-reference/Mintlify/Core/Converters/ColorConverter) | Handles JSON conversion for color properties that can be either strings or objects. | +| [IconConverter](/test/api-reference/Mintlify/Core/Converters/IconConverter) | Handles JSON conversion for icon properties that can be either strings or objects. | +| [NavigationJsonConverter](/test/api-reference/Mintlify/Core/Converters/NavigationJsonConverter) | Custom JSON converter for navigation that outputs simple array format for Mintlify compatibility. | +| [NavigationPageConverter](/test/api-reference/Mintlify/Core/Converters/NavigationPageConverter) | Handles JSON conversion for navigation page items that can be either strings or GroupConfig objects. | +| [NavigationPageListConverter](/test/api-reference/Mintlify/Core/Converters/NavigationPageListConverter) | Handles JSON conversion for lists of navigation page items that can be either strings or GroupConfig objects. | +| [PrimaryNavigationConverter](/test/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter) | Handles JSON conversion for primary navigation properties that can be different types of objects. | +| [ServerConfigConverter](/test/api-reference/Mintlify/Core/Converters/ServerConfigConverter) | Handles JSON conversion for server configuration properties that can be strings or arrays. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/DocsJsonManager.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/DocsJsonManager.mdx new file mode 100644 index 0000000..6e234f8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/DocsJsonManager.mdx @@ -0,0 +1,723 @@ +--- +title: DocsJsonManager +description: "Loads and manages Mintlify docs.json configuration files with navigation manipulation capabilities." +icon: file-brackets-curly +keywords: ['DocsJsonManager', 'Mintlify.Core.DocsJsonManager', 'Mintlify.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.DocsJsonManager +``` + +## Summary + +Loads and manages Mintlify docs.json configuration files with navigation manipulation capabilities. + +## Remarks + +This class provides comprehensive support for loading, validating, and modifying Mintlify + documentation configuration files. It handles serialization using the standard Mintlify + JSON options and provides APIs for navigation manipulation. + +## Constructors + +### .ctor + +Initializes a new instance of the [DocsJsonManager](/test/api-reference/Mintlify/Core/DocsJsonManager) class. + +#### Syntax + +```csharp +public DocsJsonManager(Mintlify.Core.DocsJsonValidator validator = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `validator` | `Mintlify.Core.DocsJsonValidator?` | The validator to use for validating configurations. If null, a new instance will be created. | + +### .ctor + +Initializes a new instance of the [DocsJsonManager](/test/api-reference/Mintlify/Core/DocsJsonManager) class with the specified file path. + +#### Syntax + +```csharp +public DocsJsonManager(string filePath, Mintlify.Core.DocsJsonValidator validator = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `filePath` | `string` | The path to the docs.json file to load. | +| `validator` | `Mintlify.Core.DocsJsonValidator?` | The validator to use for validating configurations. If null, a new instance will be created. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentException` | Thrown when the file path does not exist or is not a JSON file. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Configuration + +Gets the loaded Mintlify documentation configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.DocsJsonConfig Configuration { get; internal set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.DocsJsonConfig?` +The [DocsJsonConfig](/test/api-reference/Mintlify/Core/Models/DocsJsonConfig) instance loaded from the file system or string content. + Returns null if no configuration has been loaded or if loading failed. + +### ConfigurationErrors + +Gets the collection of configuration loading errors encountered during processing. + +#### Syntax + +```csharp +public System.Collections.Generic.List ConfigurationErrors { get; private set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` +A collection of [CompilerError](https://learn.microsoft.com/dotnet/api/system.codedom.compiler.compilererror) instances representing validation errors, + parsing failures, or other issues encountered during configuration loading. + +### FilePath + +Gets the file path of the loaded docs.json configuration file. + +#### Syntax + +```csharp +public string FilePath { get; private set; } +``` + +#### Property Value + +Type: `string?` +The full path to the docs.json file that was loaded. Returns null if the configuration + was loaded from string content rather than a file. + +### IsLoaded + +Gets a value indicating whether the configuration has been successfully loaded. + +#### Syntax + +```csharp +public bool IsLoaded { get; } +``` + +#### Property Value + +Type: `bool` +True if the configuration was loaded without errors; otherwise, false. + +## Methods + +### AddNavigationItem + +Adds a navigation item (page or group) to the specified collection, tracking paths appropriately. + +#### Syntax + +```csharp +public bool AddNavigationItem(System.Collections.Generic.List pages, object item) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `pages` | `System.Collections.Generic.List` | The pages collection to add to. | +| `item` | `object` | The item to add (string page path or GroupConfig). | + +#### Returns + +Type: `bool` +True if the item was added; false if it was skipped (duplicate). + +### AddPage + +Adds a page to the navigation structure if it doesn't already exist. + +#### Syntax + +```csharp +public bool AddPage(System.Collections.Generic.List pages, string pagePath, bool allowDuplicatePaths = false, bool updateKnownPaths = true) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `pages` | `System.Collections.Generic.List` | The pages collection to add to. | +| `pagePath` | `string` | The page path to add. | +| `allowDuplicatePaths` | `bool` | If true, allows adding duplicate paths; otherwise, skips if the path already exists. | +| `updateKnownPaths` | `bool` | If true, updates the known page paths tracking; otherwise, only adds to the pages collection. | + +#### Returns + +Type: `bool` +True if the page was added; false if it already existed and duplicates are not allowed. + +### AddPage + +Adds a page to a hierarchical group path (slash-separated) in the navigation structure. + +#### Syntax + +```csharp +public bool AddPage(string groupPath, string pagePath, bool allowDuplicatePaths = false) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `groupPath` | `string` | The hierarchical group path (e.g., "Getting Started/API Reference"). | +| `pagePath` | `string` | The page path to add. | +| `allowDuplicatePaths` | `bool` | If true, allows adding duplicate paths; otherwise, skips if the path already exists. | + +#### Returns + +Type: `bool` +True if the page was added; false if it already existed and duplicates are not allowed. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `InvalidOperationException` | Thrown when no configuration is loaded. | + +### AddPageToGroup + +Adds a page to a group if it doesn't already exist. + +#### Syntax + +```csharp +public bool AddPageToGroup(Mintlify.Core.Models.GroupConfig group, string pagePath, bool allowDuplicatePaths = false, bool updateKnownPaths = true) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `group` | `Mintlify.Core.Models.GroupConfig` | The group to add the page to. | +| `pagePath` | `string` | The page path to add. | +| `allowDuplicatePaths` | `bool` | If true, allows adding duplicate paths; otherwise, skips if the path already exists. | +| `updateKnownPaths` | `bool` | If true, updates the known page paths tracking; otherwise, only adds to the pages collection. | + +#### Returns + +Type: `bool` +True if the page was added; false if it already existed and duplicates are not allowed. + +### ApplyDefaults + +Applies default values to missing configuration properties. + +#### Syntax + +```csharp +public void ApplyDefaults(string name = null, string theme = "mint") +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `name` | `string?` | The name to use for the documentation site if not already set. | +| `theme` | `string` | The theme to use if not already set (defaults to "mint"). | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `InvalidOperationException` | Thrown when no configuration is loaded. | + +### ApplyUrlPrefix + +Applies a URL prefix to all page references in the navigation structure. + +#### Syntax + +```csharp +public void ApplyUrlPrefix(string prefix) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `prefix` | `string` | The prefix to apply to all URLs. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentException` | Thrown when prefix is null or whitespace. | +| `InvalidOperationException` | Thrown when no configuration is loaded. | + +#### Remarks + +This method recursively traverses the entire navigation structure and prepends the + specified prefix to all page URLs, href attributes, and root paths. The prefix is + normalized to ensure proper URL formatting (e.g., trailing slashes are handled). + +### CreateDefault + +Creates a default Mintlify documentation configuration with basic structure. + +#### Syntax + +```csharp +public static Mintlify.Core.Models.DocsJsonConfig CreateDefault(string name, string theme = "mint") +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `name` | `string` | The name of the documentation site. | +| `theme` | `string` | The theme to use for the documentation site. | + +#### Returns + +Type: `Mintlify.Core.Models.DocsJsonConfig` +A new [DocsJsonConfig](/test/api-reference/Mintlify/Core/Models/DocsJsonConfig) instance with default values. + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentException` | Thrown when name is null or whitespace. | + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### FindOrCreateGroup + +Finds or creates a group with the specified name in the pages collection. + +#### Syntax + +```csharp +public Mintlify.Core.Models.GroupConfig FindOrCreateGroup(System.Collections.Generic.List pages, string groupName) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `pages` | `System.Collections.Generic.List` | The pages collection to search/add to. | +| `groupName` | `string` | The name of the group to find or create. | + +#### Returns + +Type: `Mintlify.Core.Models.GroupConfig` +The existing or newly created group. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### IsPathKnown + +Checks if a page path is already known (tracked for duplicate prevention). + +#### Syntax + +```csharp +public bool IsPathKnown(string pagePath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `pagePath` | `string` | The page path to check. | + +#### Returns + +Type: `bool` +True if the path is already known; otherwise, false. + +### Load + +Loads and parses the docs.json file from the file path specified in the constructor. + +#### Syntax + +```csharp +public void Load() +``` + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `InvalidOperationException` | Thrown when no file path has been specified. | + +### Load + +Loads and parses the docs.json configuration from the specified string content. + +#### Syntax + +```csharp +public void Load(string content) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `content` | `string` | The JSON content to parse as a docs.json configuration. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentException` | Thrown when content is null or whitespace. | + +### Load + +Loads the specified configuration and applies validation and cleaning steps. + +#### Syntax + +```csharp +public void Load(Mintlify.Core.Models.DocsJsonConfig config) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration object to load. Cannot be null. | + +#### Remarks + +This method replaces any existing configuration and clears previous configuration + errors. After loading, the configuration is validated and navigation groups are cleaned to ensure + consistency. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### Merge + +Merges another docs.json configuration into the current configuration. + +#### Syntax + +```csharp +public void Merge(Mintlify.Core.Models.DocsJsonConfig other, bool combineBaseProperties = true, Mintlify.Core.Models.MergeOptions options = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `other` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to merge into the current one. | +| `combineBaseProperties` | `bool` | If true, merges base properties; if false, only merges navigation. | +| `options` | `Mintlify.Core.Models.MergeOptions?` | Optional merge options to control merge behavior. When null, default behavior is used. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when other is null. | +| `InvalidOperationException` | Thrown when no configuration is loaded. | + +#### Remarks + +This method performs a shallow merge, with the other configuration taking precedence + for non-null values. Navigation structures are combined intelligently. + +### MergeNavigation + +Merges navigation from another NavigationConfig into the current configuration's navigation. + +#### Syntax + +```csharp +public void MergeNavigation(Mintlify.Core.Models.NavigationConfig sourceNavigation, Mintlify.Core.Models.MergeOptions options = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `sourceNavigation` | `Mintlify.Core.Models.NavigationConfig` | The navigation configuration to merge from. | +| `options` | `Mintlify.Core.Models.MergeOptions?` | Optional merge options to control merge behavior. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentNullException` | Thrown when sourceNavigation is null. | +| `InvalidOperationException` | Thrown when no configuration is loaded. | + +#### Remarks + +This method intelligently merges navigation structures, combining groups with the same name + and deduplicating page references. Use the MergeOptions parameter to control specific + behaviors like how empty groups are handled. + +### MergeNavigation + +Merges navigation from an existing docs.json file into the current configuration. + +#### Syntax + +```csharp +public void MergeNavigation(string filePath, Mintlify.Core.Models.MergeOptions options = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `filePath` | `string` | The path to the docs.json file containing navigation to merge. | +| `options` | `Mintlify.Core.Models.MergeOptions?` | Optional merge options to control merge behavior. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentException` | Thrown when filePath is null or whitespace. | +| `InvalidOperationException` | Thrown when no configuration is loaded. | +| `FileNotFoundException` | Thrown when the specified file does not exist. | + +#### Remarks + +This method loads navigation from an external docs.json file and merges it into the + current configuration. Only the navigation structure is merged; other configuration + properties are not affected. + +### PopulateNavigationFromPath + +Populates the navigation structure from a directory path by scanning for MDX files. + +#### Syntax + +```csharp +public void PopulateNavigationFromPath(string path, string[] fileExtensions = null, bool includeApiReference = false, bool preserveExisting = true, bool allowDuplicatePaths = false, string[] excludeDirectories = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `path` | `string` | The directory path to scan for documentation files. | +| `fileExtensions` | `string[]?` | The file extensions to include (defaults to .mdx only). | +| `includeApiReference` | `bool` | Whether to include the 'api-reference' directory in discovery (defaults to false). | +| `preserveExisting` | `bool` | Whether to preserve existing navigation structure and merge discovered content (defaults to true). | +| `allowDuplicatePaths` | `bool` | If true, allows adding duplicate paths; otherwise, skips duplicates. | +| `excludeDirectories` | `string[]?` | Optional array of directory names to exclude from navigation discovery (e.g., DocumentationReference output directories). | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentException` | Thrown when path is null or whitespace. | +| `InvalidOperationException` | Thrown when no configuration is loaded. | +| `DirectoryNotFoundException` | Thrown when the specified path does not exist. | + +#### Remarks + + + +This method scans the specified directory recursively and builds a navigation structure + based on the folder hierarchy and MDX files found. The method includes several advanced features: + + + + +The method preserves the directory structure in the navigation while applying these intelligent + processing rules to create clean, organized documentation. + + + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### Save + +Saves the current configuration to the file system using the original file path. + +#### Syntax + +```csharp +public void Save() +``` + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `InvalidOperationException` | Thrown when no configuration is loaded or no file path is specified. | + +### Save + +Saves the current configuration to the specified file path. + +#### Syntax + +```csharp +public void Save(string filePath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `filePath` | `string` | The file path where the configuration should be saved. | + +#### Exceptions + +| Exception | Description | +|-----------|-------------| +| `ArgumentException` | Thrown when filePath is null or whitespace. | +| `InvalidOperationException` | Thrown when no configuration is loaded. | + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/DocsJsonValidator.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/DocsJsonValidator.mdx new file mode 100644 index 0000000..229e6ba --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/DocsJsonValidator.mdx @@ -0,0 +1,361 @@ +--- +title: DocsJsonValidator +description: "Validates Mintlify docs.json configuration against the official schema requirements." +icon: file-brackets-curly +keywords: ['DocsJsonValidator', 'Mintlify.Core.DocsJsonValidator', 'Mintlify.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.DocsJsonValidator +``` + +## Summary + +Validates Mintlify docs.json configuration against the official schema requirements. + +## Remarks + +This class provides comprehensive validation of the docs.json configuration to ensure + it complies with the Mintlify schema and will work correctly when deployed. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public DocsJsonValidator() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### Validate + +Validates a docs.json configuration against the Mintlify schema. + +#### Syntax + +```csharp +public System.Collections.Generic.List Validate(Mintlify.Core.Models.DocsJsonConfig config) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | + +#### Returns + +Type: `System.Collections.Generic.List` +A list of validation errors. Empty if configuration is valid. + +### ValidateApi + +Validates the API configuration. + +#### Syntax + +```csharp +public void ValidateApi(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateAppearance + +Validates the appearance configuration. + +#### Syntax + +```csharp +public void ValidateAppearance(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateColors + +Validates the color configuration. + +#### Syntax + +```csharp +public void ValidateColors(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateGroups + +Validates group configurations in navigation. + +#### Syntax + +```csharp +public void ValidateGroups(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateIcons + +Validates the icons configuration. + +#### Syntax + +```csharp +public void ValidateIcons(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateLogo + +Validates the logo configuration. + +#### Syntax + +```csharp +public void ValidateLogo(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateNavigation + +Validates the navigation configuration. + +#### Syntax + +```csharp +public void ValidateNavigation(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateRequired + +Validates that the configuration has all required properties. + +#### Syntax + +```csharp +public void ValidateRequired(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateSeo + +Validates the SEO configuration. + +#### Syntax + +```csharp +public void ValidateSeo(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + +### ValidateTheme + +Validates the theme configuration. + +#### Syntax + +```csharp +public void ValidateTheme(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List errors) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | +| `errors` | `System.Collections.Generic.List` | The list to add errors to. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/MintlifyConstants.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/MintlifyConstants.mdx new file mode 100644 index 0000000..0354c0f --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/MintlifyConstants.mdx @@ -0,0 +1,50 @@ +--- +title: MintlifyConstants +description: "Contains constants and shared configuration objects for Mintlify documentation generation." +icon: bolt +tag: "STATIC" +keywords: ['MintlifyConstants', 'Mintlify.Core.MintlifyConstants', 'Mintlify.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.MintlifyConstants +``` + +## Summary + +Contains constants and shared configuration objects for Mintlify documentation generation. + +## Properties + +### JsonSerializerOptions + +Gets the shared JsonSerializerOptions instance for consistent Mintlify JSON serialization. + +#### Syntax + +```csharp +public static System.Text.Json.JsonSerializerOptions JsonSerializerOptions { get; } +``` + +#### Property Value + +Type: `System.Text.Json.JsonSerializerOptions` + +#### Remarks + +This instance is configured with: + - Indented formatting for readable output + - CamelCase property naming to match Mintlify schema + - Null value ignoring to omit optional properties + - Polymorphic JSON converters for complex object types + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/MintlifyOptions.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/MintlifyOptions.mdx new file mode 100644 index 0000000..eb509af --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/MintlifyOptions.mdx @@ -0,0 +1,705 @@ +--- +title: MintlifyOptions +description: "Configuration options for Mintlify documentation generation." +icon: file-brackets-curly +keywords: ['MintlifyOptions', 'Mintlify.Core.MintlifyOptions', 'Mintlify.Core', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.MintlifyOptions +``` + +## Summary + +Configuration options for Mintlify documentation generation. + +## Remarks + +This class contains all the configuration settings that control how the Mintlify + documentation is generated, including output paths, filtering options, and formatting preferences. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MintlifyOptions() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AppearanceDefault + +Gets or sets the default appearance mode (system, light, dark). + +#### Syntax + +```csharp +public string AppearanceDefault { get; set; } +``` + +#### Property Value + +Type: `string` + +### AppearanceStrict + +Gets or sets whether to hide the light/dark mode toggle. + +#### Syntax + +```csharp +public bool AppearanceStrict { get; set; } +``` + +#### Property Value + +Type: `bool` + +### BaseUrl + +Gets or sets the base URL for cross-references to external documentation. + +#### Syntax + +```csharp +public string BaseUrl { get; set; } +``` + +#### Property Value + +Type: `string` + +### Clean + +Gets or sets whether to clean the output directory before generating. + +#### Syntax + +```csharp +public bool Clean { get; set; } +``` + +#### Property Value + +Type: `bool` + +### ConfigOnly + +Gets or sets whether to only generate the docs.json file without MDX files. + +#### Syntax + +```csharp +public bool ConfigOnly { get; set; } +``` + +#### Property Value + +Type: `bool` + +### FaviconDark + +Gets or sets the dark mode favicon path. + +#### Syntax + +```csharp +public string FaviconDark { get; set; } +``` + +#### Property Value + +Type: `string?` + +### FaviconLight + +Gets or sets the favicon path or light mode favicon. + +#### Syntax + +```csharp +public string FaviconLight { get; set; } +``` + +#### Property Value + +Type: `string` + +### ForceBuild + +Gets or sets whether to force a rebuild instead of using existing binaries. + +#### Syntax + +```csharp +public bool ForceBuild { get; set; } +``` + +#### Property Value + +Type: `bool` + +#### Remarks + +When false (default), DocFX will attempt to use existing compiled assemblies + for faster documentation generation. When true, forces a complete rebuild + which may be slower but ensures all dependencies are up to date. + +### GenerateConfig + +Gets or sets whether to generate a docs.json configuration file. + +#### Syntax + +```csharp +public bool GenerateConfig { get; set; } +``` + +#### Property Value + +Type: `bool` + +### GenerateNavigationFiles + +Gets or sets whether to generate navigation.json files in non-api-reference folders. + +#### Syntax + +```csharp +public bool GenerateNavigationFiles { get; set; } +``` + +#### Property Value + +Type: `bool` + +#### Remarks + +When true, the generator will create navigation.json files in directories that don't + already have them, preserving the auto-discovered navigation structure. This allows + users to customize navigation later without losing their changes during regeneration. + +### GitHubUrl + +Gets or sets the GitHub URL for footer social links. + +#### Syntax + +```csharp +public string GitHubUrl { get; set; } +``` + +#### Property Value + +Type: `string` + +### IconLibrary + +Gets or sets the icon library to use (fontawesome, lucide). + +#### Syntax + +```csharp +public string IconLibrary { get; set; } +``` + +#### Property Value + +Type: `string` + +### IncludeExamples + +Gets or sets whether to include code examples in the generated documentation. + +#### Syntax + +```csharp +public bool IncludeExamples { get; set; } +``` + +#### Property Value + +Type: `bool` + +### IncludeInheritance + +Gets or sets whether to include inheritance information. + +#### Syntax + +```csharp +public bool IncludeInheritance { get; set; } +``` + +#### Property Value + +Type: `bool` + +### IncludeInternal + +Gets or sets whether to include internal members in the documentation. + +#### Syntax + +```csharp +public bool IncludeInternal { get; set; } +``` + +#### Property Value + +Type: `bool` + +### IncludeSeeAlso + +Gets or sets whether to include see also references. + +#### Syntax + +```csharp +public bool IncludeSeeAlso { get; set; } +``` + +#### Property Value + +Type: `bool` + +### LogoDark + +Gets or sets the path to the dark logo file. + +#### Syntax + +```csharp +public string LogoDark { get; set; } +``` + +#### Property Value + +Type: `string` + +### LogoHref + +Gets or sets the URL to redirect to when clicking the logo. + +#### Syntax + +```csharp +public string LogoHref { get; set; } +``` + +#### Property Value + +Type: `string?` + +### LogoLight + +Gets or sets the path to the light logo file. + +#### Syntax + +```csharp +public string LogoLight { get; set; } +``` + +#### Property Value + +Type: `string` + +### MaxDepth + +Gets or sets the maximum depth for nested type documentation. + +#### Syntax + +```csharp +public int MaxDepth { get; set; } +``` + +#### Property Value + +Type: `int` + +### NamespaceFilter + +Gets or sets the namespace filter regex pattern. + Only namespaces matching this pattern will be included. + +#### Syntax + +```csharp +public string NamespaceFilter { get; set; } +``` + +#### Property Value + +Type: `string?` + +### OutputDirectory + +Gets or sets the output directory for generated documentation. + +#### Syntax + +```csharp +public string OutputDirectory { get; set; } +``` + +#### Property Value + +Type: `string` + +### PreserveExistingConfig + +Gets or sets whether to preserve existing docs.json configuration when updating. + +#### Syntax + +```csharp +public bool PreserveExistingConfig { get; set; } +``` + +#### Property Value + +Type: `bool` + +#### Remarks + +When true (default), the generator will read any existing docs.json file and merge + the generated API documentation with existing configuration, preserving custom + navigation, styling, integrations, and other settings. When false, the generator + will completely replace the docs.json file with new configuration. + +### PrimaryColor + +Gets or sets the primary color for the documentation theme. + +#### Syntax + +```csharp +public string PrimaryColor { get; set; } +``` + +#### Property Value + +Type: `string` + +### PrimaryDarkColor + +Gets or sets the primary color for dark mode. + +#### Syntax + +```csharp +public string PrimaryDarkColor { get; set; } +``` + +#### Property Value + +Type: `string` + +### SearchPrompt + +Gets or sets the search prompt text. + +#### Syntax + +```csharp +public string SearchPrompt { get; set; } +``` + +#### Property Value + +Type: `string?` + +### SeoIndexing + +Gets or sets the SEO indexing mode (navigable, all). + +#### Syntax + +```csharp +public string SeoIndexing { get; set; } +``` + +#### Property Value + +Type: `string` + +### SiteDescription + +Gets or sets the description of the documentation site. + +#### Syntax + +```csharp +public string SiteDescription { get; set; } +``` + +#### Property Value + +Type: `string` + +### SiteName + +Gets or sets the name of the documentation site. + +#### Syntax + +```csharp +public string SiteName { get; set; } +``` + +#### Property Value + +Type: `string` + +### SolutionNamePrefix + +Gets or sets the solution name prefix to strip from project names when generating paths. + +#### Syntax + +```csharp +public string SolutionNamePrefix { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +For example, if the solution is "CloudNimble.Breakdance" and projects are named + "CloudNimble.Breakdance.AspNetCore", the output path will be "/aspnetcore/" instead + of "/cloudnimble-breakdance-aspnetcore/". + +### StripBackticksAroundLinks + +Gets or sets whether to strip backticks around parameter and return value links. + +#### Syntax + +```csharp +public bool StripBackticksAroundLinks { get; set; } +``` + +#### Property Value + +Type: `bool` + +#### Remarks + +When true (default), removes backticks around markdown links in parameter descriptions + and return value documentation to ensure proper link rendering in Mintlify. + This fixes the issue where links inside code formatting don't render correctly. + +### Theme + +Gets or sets the theme for the documentation site. + +#### Syntax + +```csharp +public string Theme { get; set; } +``` + +#### Property Value + +Type: `string` + +### TypeFilter + +Gets or sets the type filter regex pattern. + Only types matching this pattern will be included. + +#### Syntax + +```csharp +public string TypeFilter { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Verbose + +Gets or sets whether to enable verbose output during generation. + +#### Syntax + +```csharp +public bool Verbose { get; set; } +``` + +#### Property Value + +Type: `bool` + +### WebsiteUrl + +Gets or sets the website URL for footer social links. + +#### Syntax + +```csharp +public string WebsiteUrl { get; set; } +``` + +#### Property Value + +Type: `string` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### Validate + +Validates the options and throws an exception if any are invalid. + +#### Syntax + +```csharp +public void Validate() +``` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/AnchorConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/AnchorConfig.mdx new file mode 100644 index 0000000..8df5955 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/AnchorConfig.mdx @@ -0,0 +1,500 @@ +--- +title: AnchorConfig +description: "Represents an anchor configuration in Mintlify navigation." +icon: file-brackets-curly +keywords: ['AnchorConfig', 'Mintlify.Core.Models.AnchorConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationSectionBase'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** Mintlify.Core.Models.NavigationSectionBase + +## Syntax + +```csharp +Mintlify.Core.Models.AnchorConfig +``` + +## Summary + +Represents an anchor configuration in Mintlify navigation. + +## Remarks + +Anchors provide navigation links in your documentation. The anchor name is required. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public AnchorConfig() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +#### Syntax + +```csharp +protected NavigationSectionBase() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +#### Syntax + +```csharp +protected NavigationContainerBase() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +#### Syntax + +```csharp +protected NavigationItemBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchor + +Gets or sets the name of the anchor. + +#### Syntax + +```csharp +public string Anchor { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that appears as the anchor label. + +### AsyncApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Color Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the color configuration for this navigation section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ColorPairConfig Color { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ColorPairConfig?` + +#### Remarks + +Defines the primary and secondary colors used for this section's visual styling. + +### Description Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the description of this navigation section. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Provides additional descriptive text about this navigation section. + +### Dropdowns Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the dropdowns for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Dropdowns { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Dropdowns create expandable menu sections within this navigation section. + +### Global Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets global navigation items that appear on all sections and pages. + +#### Syntax + +```csharp +public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.GlobalNavigationConfig?` + +#### Remarks + +Global navigation items persist across different tabs and pages for consistent navigation. + +### Groups Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the groups for this navigation container. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Groups organize pages into labeled sections within this navigation container. + +### Hidden Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this navigation item will not be displayed in the navigation by default. + +### Href Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the URL or path for this navigation container. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be used to link to an external URL or specify a path for this container. + +### Icon Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the icon to be displayed in the section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +#### Remarks + +Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, + URL to an externally hosted icon, or path to an icon file in your project. + +### Languages Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the languages for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Languages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows partitioning navigation into different language-specific versions. + +### OpenApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Pages Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the pages for this navigation item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. + +### Tabs + +Gets or sets the tabs for the anchor. + +#### Syntax + +```csharp +public System.Collections.Generic.List Tabs { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows creating multiple tabs within an anchor section. + +### Versions Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the versions for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Versions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows partitioning navigation into different version-specific documentation. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiConfig.mdx new file mode 100644 index 0000000..56b4491 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiConfig.mdx @@ -0,0 +1,307 @@ +--- +title: ApiConfig +description: "Represents the API reference configuration and playground settings for Mintlify." +icon: file-brackets-curly +keywords: ['ApiConfig', 'Mintlify.Core.Models.ApiConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ApiConfig +``` + +## Summary + +Represents the API reference configuration and playground settings for Mintlify. + +## Remarks + +This configuration controls how API documentation is displayed and how the API playground + functions, including OpenAPI, AsyncAPI, and MDX-based API specifications. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ApiConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AsyncApi + +Gets or sets the AsyncAPI specification configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Examples + +Gets or sets the configuration for autogenerated API examples. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiExamplesConfig Examples { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiExamplesConfig?` + +#### Remarks + +Controls which programming languages are shown in code examples and whether + optional parameters are included in the generated examples. + +### Mdx + +Gets or sets the MDX configuration for API pages generated from MDX files. + +#### Syntax + +```csharp +public Mintlify.Core.Models.MdxConfig Mdx { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.MdxConfig?` + +#### Remarks + +Allows manual definition of API endpoints in individual MDX files rather than + using an OpenAPI specification. Useful for small APIs or prototyping. + +### OpenApi + +Gets or sets the OpenAPI specification configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Params + +Gets or sets the display settings for API parameters. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiParamsConfig Params { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiParamsConfig?` + +#### Remarks + +Controls how API parameters are displayed in the documentation, + including whether they are expanded by default. + +### Playground + +Gets or sets the API playground settings. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiPlaygroundConfig Playground { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiPlaygroundConfig?` + +#### Remarks + +Controls the display mode of the API playground and whether requests + are proxied through Mintlify's servers for CORS handling. + +### Proxy + +Gets or sets whether to pass API requests through a proxy server. + +#### Syntax + +```csharp +public System.Nullable Proxy { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, API requests from the playground are routed through Mintlify's + proxy servers to handle CORS restrictions. This is a legacy property that + is superseded by Playground.Proxy but kept for backward compatibility. + Defaults to true when not specified. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiExamplesConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiExamplesConfig.mdx new file mode 100644 index 0000000..ce557c7 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiExamplesConfig.mdx @@ -0,0 +1,258 @@ +--- +title: ApiExamplesConfig +description: "Represents the configuration for autogenerated API examples in the documentation." +icon: file-brackets-curly +keywords: ['ApiExamplesConfig', 'Mintlify.Core.Models.ApiExamplesConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ApiExamplesConfig +``` + +## Summary + +Represents the configuration for autogenerated API examples in the documentation. + +## Remarks + +Controls which programming languages are shown in code examples and whether + optional parameters are included in the generated examples. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ApiExamplesConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Defaults + +Gets or sets whether to show optional parameters in API examples. + +#### Syntax + +```csharp +public string Defaults { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Examples + +```csharp +"examples": { + "defaults": "required" +} +``` + +#### Remarks + +Valid values are: + - "all": Show all parameters including optional ones + - "required": Show only required parameters + Defaults to "all" when not specified. + +### Languages + +Gets or sets the programming languages for autogenerated API snippets. + +#### Syntax + +```csharp +public System.Collections.Generic.List Languages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Examples + +```csharp +"examples": { + "languages": ["javascript", "python", "curl"] +} +``` + +#### Remarks + +Specifies which programming languages should be included in the + automatically generated code examples. Common values include: + "javascript", "python", "curl", "go", "java", "php", "ruby", etc. + +### Prefill + +Gets or sets whether to prefill the API playground with data from schema examples. + +#### Syntax + +```csharp +public System.Nullable Prefill { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Examples + +```csharp +"examples": { + "prefill": true +} +``` + +#### Remarks + +When enabled, the playground automatically populates request fields with example + values from your OpenAPI specification. This provides users with pre-populated + data to help them understand the API structure and test endpoints more easily. + Defaults to false when not specified. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiParamsConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiParamsConfig.mdx new file mode 100644 index 0000000..fe6be46 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiParamsConfig.mdx @@ -0,0 +1,200 @@ +--- +title: ApiParamsConfig +description: "Represents the display settings for API parameters in the documentation." +icon: file-brackets-curly +keywords: ['ApiParamsConfig', 'Mintlify.Core.Models.ApiParamsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ApiParamsConfig +``` + +## Summary + +Represents the display settings for API parameters in the documentation. + +## Remarks + +Controls how API parameters are displayed in the interactive playground + and documentation pages, including whether they are expanded by default. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ApiParamsConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Expanded + +Gets or sets whether to expand all parameters by default. + +#### Syntax + +```csharp +public System.Nullable Expanded { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Examples + +```csharp +"params": { + "expanded": true +} +``` + +#### Remarks + +When true, all API parameters will be displayed in an expanded state. + When false or null, parameters will be collapsed by default. + Defaults to collapsed (false) when not specified. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig.mdx new file mode 100644 index 0000000..f039d79 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig.mdx @@ -0,0 +1,231 @@ +--- +title: ApiPlaygroundConfig +description: "Represents the API playground settings for interactive documentation." +icon: file-brackets-curly +keywords: ['ApiPlaygroundConfig', 'Mintlify.Core.Models.ApiPlaygroundConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ApiPlaygroundConfig +``` + +## Summary + +Represents the API playground settings for interactive documentation. + +## Remarks + +Controls how the API playground is displayed and whether API requests + are proxied through Mintlify's servers for CORS handling. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ApiPlaygroundConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Display + +Gets or sets the display mode of the API playground. + +#### Syntax + +```csharp +public string Display { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Examples + +```csharp +"playground": { + "display": "interactive" +} +``` + +#### Remarks + +Valid values are: + - "interactive": Full interactive playground with request/response testing + - "simple": Copyable endpoint with no interactive features + - "none": Hide the playground completely + Defaults to "interactive" when not specified. + +### Proxy + +Gets or sets whether to pass API requests through a proxy server. + +#### Syntax + +```csharp +public System.Nullable Proxy { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Examples + +```csharp +"playground": { + "proxy": false +} +``` + +#### Remarks + +When true, API requests from the playground are routed through Mintlify's + proxy servers to handle CORS restrictions. This allows the playground to + make requests to APIs that don't have CORS configured. + Defaults to true when not specified. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiSpecConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiSpecConfig.mdx new file mode 100644 index 0000000..a3d5fac --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ApiSpecConfig.mdx @@ -0,0 +1,243 @@ +--- +title: ApiSpecConfig +description: "Represents an API specification configuration for OpenAPI or AsyncAPI." +icon: file-brackets-curly +keywords: ['ApiSpecConfig', 'Mintlify.Core.Models.ApiSpecConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ApiSpecConfig +``` + +## Summary + +Represents an API specification configuration for OpenAPI or AsyncAPI. + +## Remarks + +API specifications can be specified as simple URLs, multiple URLs, or detailed configurations + with source and directory properties. This matches the official Mintlify schema. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ApiSpecConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Directory + +Gets or sets the directory path for API specifications. + +#### Syntax + +```csharp +public string Directory { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies a directory containing API specification files. + Used in conjunction with Source for complex configurations. + +### Source + +Gets or sets the source URL or path for API specifications. + +#### Syntax + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be an absolute URL or relative path to an API specification file. + +### Urls + +Gets or sets the list of URLs when multiple specifications are provided. + +#### Syntax + +```csharp +public System.Collections.Generic.List Urls { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Used internally when the API config represents multiple URL strings. + Not serialized directly as it's handled by the converter. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the API specification configuration. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The source URL, first URL, or empty string. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/AppearanceConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/AppearanceConfig.mdx new file mode 100644 index 0000000..7900d38 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/AppearanceConfig.mdx @@ -0,0 +1,210 @@ +--- +title: AppearanceConfig +description: "Represents the appearance configuration for light and dark mode settings in Mintlify." +icon: file-brackets-curly +keywords: ['AppearanceConfig', 'Mintlify.Core.Models.AppearanceConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.AppearanceConfig +``` + +## Summary + +Represents the appearance configuration for light and dark mode settings in Mintlify. + +## Remarks + +This configuration controls the default appearance mode and whether users can toggle + between light and dark modes in the documentation site. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public AppearanceConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Default + +Gets or sets the default light/dark mode for the documentation site. + +#### Syntax + +```csharp +public string Default { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Valid values are "system" (follows user's system preference), "light", or "dark". + Defaults to "system" if not specified. + +### Strict + +Gets or sets whether to hide the light/dark mode toggle from users. + +#### Syntax + +```csharp +public System.Nullable Strict { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When set to true, users will not be able to switch between light and dark modes, + and the site will use only the default mode specified. Defaults to false. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BackgroundConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BackgroundConfig.mdx new file mode 100644 index 0000000..2071746 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BackgroundConfig.mdx @@ -0,0 +1,230 @@ +--- +title: BackgroundConfig +description: "Represents the background configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['BackgroundConfig', 'Mintlify.Core.Models.BackgroundConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.BackgroundConfig +``` + +## Summary + +Represents the background configuration for the Mintlify documentation site. + +## Remarks + +This configuration controls the background appearance including images, decorations, + and colors for the documentation site. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public BackgroundConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Color + +Gets or sets the background color configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ColorConfig Color { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ColorConfig?` + +#### Remarks + +Can be a hex color string or an object with color configuration properties. + This controls the base background color of the documentation site. + +### Decoration + +Gets or sets the background decoration style. + +#### Syntax + +```csharp +public string Decoration { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Valid values are "gradient", "grid", or "windows". This adds decorative + background patterns to enhance the visual appearance of the site. + +### Image + +Gets or sets the background image configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.BackgroundImageConfig Image { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.BackgroundImageConfig?` + +#### Remarks + +Can be a string URL for a single image, or an object with "light" and "dark" + properties for different images in each mode. Should be an absolute URL or + relative path to the image file. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BackgroundImageConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BackgroundImageConfig.mdx new file mode 100644 index 0000000..833cbbf --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BackgroundImageConfig.mdx @@ -0,0 +1,244 @@ +--- +title: BackgroundImageConfig +description: "Represents a background image configuration in Mintlify." +icon: file-brackets-curly +keywords: ['BackgroundImageConfig', 'Mintlify.Core.Models.BackgroundImageConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.BackgroundImageConfig +``` + +## Summary + +Represents a background image configuration in Mintlify. + +## Remarks + +Background images can be simple URL/path references or theme-specific configurations + with separate images for light and dark modes. This matches the official Mintlify schema. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public BackgroundImageConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Dark + +Gets or sets the background image for dark mode. + +#### Syntax + +```csharp +public string Dark { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be an absolute URL or relative path to an image file. + Used when the theme switches to dark mode. + +### Light + +Gets or sets the background image for light mode. + +#### Syntax + +```csharp +public string Light { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be an absolute URL or relative path to an image file. + Used when the theme is in light mode. + +### Url + +Gets or sets the single image URL when not using theme-specific images. + +#### Syntax + +```csharp +public string Url { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Used internally when the background image is a simple string. + Not serialized directly as it's handled by the converter. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the background image configuration. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The URL, light image, dark image, or empty string. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BannerConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BannerConfig.mdx new file mode 100644 index 0000000..9bc193c --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/BannerConfig.mdx @@ -0,0 +1,212 @@ +--- +title: BannerConfig +description: "Represents the banner configuration for displaying announcements or notifications in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['BannerConfig', 'Mintlify.Core.Models.BannerConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.BannerConfig +``` + +## Summary + +Represents the banner configuration for displaying announcements or notifications in the Mintlify documentation site. + +## Remarks + +This configuration allows you to display a banner at the top of your documentation + for important announcements, updates, or notifications. The banner supports MDX formatting. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public BannerConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Content + +Gets or sets the content to display in the banner. + +#### Syntax + +```csharp +public string Content { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +The text or MDX content that will be displayed in the banner. MDX formatting + is supported, allowing for rich content including links, emphasis, and other + formatting. This content should be concise but informative. + +### Dismissible + +Gets or sets whether to show a dismiss button on the banner. + +#### Syntax + +```csharp +public System.Nullable Dismissible { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, displays a dismiss button (X) on the right side of the banner, + allowing users to close the banner. When false or not specified, the banner + cannot be dismissed by users and will always be visible. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorConfig.mdx new file mode 100644 index 0000000..c3ad7ca --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorConfig.mdx @@ -0,0 +1,246 @@ +--- +title: ColorConfig +description: "Represents a color configuration for Mintlify. Can be a simple hex color string or a complex color pair configuration with light and dark modes." +icon: file-brackets-curly +keywords: ['ColorConfig', 'Mintlify.Core.Models.ColorConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ColorConfig +``` + +## Summary + +Represents a color configuration for Mintlify. + Can be a simple hex color string or a complex color pair configuration with light and dark modes. + +## Constructors + +### .ctor + +Initializes a new instance of the [ColorConfig](/test/api-reference/Mintlify/Core/Models/ColorConfig) class. + +#### Syntax + +```csharp +public ColorConfig() +``` + +### .ctor + +Initializes a new instance of the [ColorConfig](/test/api-reference/Mintlify/Core/Models/ColorConfig) class with a single color. + +#### Syntax + +```csharp +public ColorConfig(string color) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `color` | `string?` | The hex color string for both light and dark modes. | + +### .ctor + +Initializes a new instance of the [ColorConfig](/test/api-reference/Mintlify/Core/Models/ColorConfig) class with separate light and dark colors. + +#### Syntax + +```csharp +public ColorConfig(string light, string dark) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `light` | `string?` | The hex color string for light mode. | +| `dark` | `string?` | The hex color string for dark mode. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Dark + +Gets or sets the color in hex format to use in dark mode. + +#### Syntax + +```csharp +public string Dark { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Light + +Gets or sets the color in hex format to use in light mode. + +#### Syntax + +```csharp +public string Light { get; set; } +``` + +#### Property Value + +Type: `string?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the color configuration. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The light color, dark color, or empty string. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorConfigJsonConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorConfigJsonConverter.mdx new file mode 100644 index 0000000..75bb3ce --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorConfigJsonConverter.mdx @@ -0,0 +1,78 @@ +--- +title: ColorConfigJsonConverter +description: "Custom JSON converter for ColorConfig that supports both string and object formats." +icon: file-brackets-curly +keywords: ['ColorConfigJsonConverter', 'Mintlify.Core.Models.ColorConfigJsonConverter', 'Mintlify.Core.Models', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.ColorConfig> + +## Syntax + +```csharp +Mintlify.Core.Models.ColorConfigJsonConverter +``` + +## Summary + +Custom JSON converter for ColorConfig that supports both string and object formats. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ColorConfigJsonConverter() +``` + +## Methods + +### Read + +Reads and converts the JSON to a ColorConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.ColorConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.ColorConfig?` +A ColorConfig object. + +### Write + +Writes a ColorConfig object as JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.ColorConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.ColorConfig` | The ColorConfig object to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorPairConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorPairConfig.mdx new file mode 100644 index 0000000..4c4fb1e --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorPairConfig.mdx @@ -0,0 +1,210 @@ +--- +title: ColorPairConfig +description: "Represents a color pair configuration for light and dark modes." +icon: file-brackets-curly +keywords: ['ColorPairConfig', 'Mintlify.Core.Models.ColorPairConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ColorPairConfig +``` + +## Summary + +Represents a color pair configuration for light and dark modes. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ColorPairConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Dark + +Gets or sets the color in hex format to use in dark mode. + +#### Syntax + +```csharp +public string Dark { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Light + +Gets or sets the color in hex format to use in light mode. + +#### Syntax + +```csharp +public string Light { get; set; } +``` + +#### Property Value + +Type: `string?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the color pair configuration. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The light color, dark color, or empty string. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorsConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorsConfig.mdx new file mode 100644 index 0000000..2b72902 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ColorsConfig.mdx @@ -0,0 +1,217 @@ +--- +title: ColorsConfig +description: "Represents the color configuration for Mintlify themes." +icon: file-brackets-curly +keywords: ['ColorsConfig', 'Mintlify.Core.Models.ColorsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ColorsConfig +``` + +## Summary + +Represents the color configuration for Mintlify themes. + +## Remarks + +The colors to use in your documentation. At the very least, you must define the primary color. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ColorsConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Dark + +Gets or sets the dark color of the theme in hex format. Used for light mode. + +#### Syntax + +```csharp +public string Dark { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Light + +Gets or sets the light color of the theme in hex format. Used for dark mode. + +#### Syntax + +```csharp +public string Light { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Primary + +Gets or sets the primary color of the theme in hex format. + +#### Syntax + +```csharp +public string Primary { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field. Must be a valid hex color in format #RRGGBB or #RGB. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ContextualConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ContextualConfig.mdx new file mode 100644 index 0000000..d011703 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ContextualConfig.mdx @@ -0,0 +1,199 @@ +--- +title: ContextualConfig +description: "Represents the contextual options configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['ContextualConfig', 'Mintlify.Core.Models.ContextualConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ContextualConfig +``` + +## Summary + +Represents the contextual options configuration for the Mintlify documentation site. + +## Remarks + +This configuration controls the contextual options that appear in the documentation, + such as copy buttons, view source links, and AI assistant integrations. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ContextualConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Options + +Gets or sets the list of contextual options to enable. + +#### Syntax + +```csharp +public System.Collections.Generic.List Options { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Valid options include: + - "copy": Shows a copy button for code blocks and other copyable content + - "view": Provides view source or view raw options for content + - "chatgpt": Enables ChatGPT integration for AI assistance + - "claude": Enables Claude AI integration for AI assistance + - "perplexity": Enables Perplexity AI integration for AI assistance + - "mcp": Provides details for connecting any AI to the documentation through the MCP protocol + - "cursor": Enables Cursor integration for AI assistance + - "vscode": Enables VS Code integration for AI assistance + These options enhance user interaction with the documentation content. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/DocsJsonConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/DocsJsonConfig.mdx new file mode 100644 index 0000000..5d33bc8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/DocsJsonConfig.mdx @@ -0,0 +1,548 @@ +--- +title: DocsJsonConfig +description: "Represents the root configuration object for Mintlify docs.json." +icon: file-brackets-curly +keywords: ['DocsJsonConfig', 'Mintlify.Core.Models.DocsJsonConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.DocsJsonConfig +``` + +## Summary + +Represents the root configuration object for Mintlify docs.json. + +## Remarks + +This class represents the complete structure of a Mintlify docs.json configuration file + as defined by the official Mintlify schema. It supports all themes and configuration options. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public DocsJsonConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Api + +Gets or sets the API reference configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiConfig Api { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiConfig?` + +### Appearance + +Gets or sets the appearance configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.AppearanceConfig Appearance { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.AppearanceConfig?` + +### Background + +Gets or sets the background configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.BackgroundConfig Background { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.BackgroundConfig?` + +### Banner + +Gets or sets the banner configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.BannerConfig Banner { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.BannerConfig?` + +### Colors + +Gets or sets the color configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ColorsConfig Colors { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ColorsConfig` + +#### Remarks + +This is a required field. At minimum, the primary color must be defined. + +### Contextual + +Gets or sets the contextual options configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ContextualConfig Contextual { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ContextualConfig?` + +### Description + +Gets or sets the optional description used for SEO and LLM indexing. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Errors + +Gets or sets the error pages configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ErrorsConfig Errors { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ErrorsConfig?` + +### Favicon + +Gets or sets the favicon configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.FaviconConfig Favicon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.FaviconConfig?` + +### Fonts + +Gets or sets the fonts configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.FontsConfig Fonts { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.FontsConfig?` + +### Footer + +Gets or sets the footer configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.FooterConfig Footer { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.FooterConfig?` + +### Icons + +Gets or sets the icons configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconsConfig Icons { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconsConfig?` + +### Integrations + +Gets or sets the integrations configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IntegrationsConfig Integrations { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IntegrationsConfig?` + +### Interaction + +Gets or sets the interaction configuration for navigation elements. + +#### Syntax + +```csharp +public Mintlify.Core.Models.InteractionConfig Interaction { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.InteractionConfig?` + +#### Remarks + +Controls how users interact with navigation elements such as groups and dropdowns, + including whether expanding a group automatically navigates to its first page. + +### Logo + +Gets or sets the logo configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.LogoConfig Logo { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.LogoConfig?` + +### Name + +Gets or sets the name of the project, organization, or product. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field. + +### Navbar + +Gets or sets the navbar configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.NavbarConfig Navbar { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.NavbarConfig?` + +### Navigation + +Gets or sets the navigation structure. + +#### Syntax + +```csharp +public Mintlify.Core.Models.NavigationConfig Navigation { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.NavigationConfig` + +#### Remarks + +This is a required field that defines the structure of your documentation. + +### Redirects + +Gets or sets the redirects. + +#### Syntax + +```csharp +public System.Collections.Generic.List Redirects { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Schema + +Gets or sets the JSON schema URL. + +#### Syntax + +```csharp +public string Schema { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Search + +Gets or sets the search configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.SearchConfig Search { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.SearchConfig?` + +### Seo + +Gets or sets the SEO configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.SeoConfig Seo { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.SeoConfig?` + +### Styling + +Gets or sets the styling configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.StylingConfig Styling { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.StylingConfig?` + +### Theme + +Gets or sets the theme name. + +#### Syntax + +```csharp +public string Theme { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field. Valid values are: mint, maple, palm, willow, linden, almond, aspen. + +### Thumbnails + +Gets or sets the thumbnails configuration. + +#### Syntax + +```csharp +public System.Collections.Generic.Dictionary Thumbnails { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.Dictionary?` + +#### Remarks + +Defines custom thumbnail images for social media sharing and link previews. + Can include background images and other preview assets. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/DropdownConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/DropdownConfig.mdx new file mode 100644 index 0000000..3cc6a67 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/DropdownConfig.mdx @@ -0,0 +1,518 @@ +--- +title: DropdownConfig +description: "Represents a dropdown configuration in Mintlify navigation." +icon: file-brackets-curly +keywords: ['DropdownConfig', 'Mintlify.Core.Models.DropdownConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationSectionBase'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** Mintlify.Core.Models.NavigationSectionBase + +## Syntax + +```csharp +Mintlify.Core.Models.DropdownConfig +``` + +## Summary + +Represents a dropdown configuration in Mintlify navigation. + +## Remarks + +Dropdowns create expandable navigation menus. The dropdown name is required. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public DropdownConfig() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +#### Syntax + +```csharp +protected NavigationSectionBase() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +#### Syntax + +```csharp +protected NavigationContainerBase() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +#### Syntax + +```csharp +protected NavigationItemBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchors + +Gets or sets the anchors for the dropdown. + +#### Syntax + +```csharp +public System.Collections.Generic.List Anchors { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Anchors provide persistent navigation items within the dropdown. + +### AsyncApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Color Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the color configuration for this navigation section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ColorPairConfig Color { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ColorPairConfig?` + +#### Remarks + +Defines the primary and secondary colors used for this section's visual styling. + +### Description Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the description of this navigation section. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Provides additional descriptive text about this navigation section. + +### Dropdown + +Gets or sets the name of the dropdown. + +#### Syntax + +```csharp +public string Dropdown { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that appears as the dropdown label in navigation. + +### Dropdowns Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the dropdowns for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Dropdowns { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Dropdowns create expandable menu sections within this navigation section. + +### Global Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets global navigation items that appear on all sections and pages. + +#### Syntax + +```csharp +public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.GlobalNavigationConfig?` + +#### Remarks + +Global navigation items persist across different tabs and pages for consistent navigation. + +### Groups Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the groups for this navigation container. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Groups organize pages into labeled sections within this navigation container. + +### Hidden Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this navigation item will not be displayed in the navigation by default. + +### Href Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the URL or path for this navigation container. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be used to link to an external URL or specify a path for this container. + +### Icon Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the icon to be displayed in the section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +#### Remarks + +Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, + URL to an externally hosted icon, or path to an icon file in your project. + +### Languages Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the languages for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Languages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows partitioning navigation into different language-specific versions. + +### OpenApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Pages Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the pages for this navigation item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. + +### Tabs + +Gets or sets the tabs for the dropdown. + +#### Syntax + +```csharp +public System.Collections.Generic.List Tabs { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows creating multiple tabs within a dropdown section. + +### Versions Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the versions for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Versions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows partitioning navigation into different version-specific documentation. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Error404Config.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Error404Config.mdx new file mode 100644 index 0000000..e97c74f --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Error404Config.mdx @@ -0,0 +1,193 @@ +--- +title: Error404Config +description: "Represents the configuration for 404 (Not Found) error handling in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['Error404Config', 'Mintlify.Core.Models.Error404Config', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Error404Config +``` + +## Summary + +Represents the configuration for 404 (Not Found) error handling in the Mintlify documentation site. + +## Remarks + +This configuration controls what happens when users try to access pages that don't exist, + including whether to automatically redirect them to the home page. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public Error404Config() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Redirect + +Gets or sets whether to automatically redirect users to the home page when a 404 error occurs. + +#### Syntax + +```csharp +public System.Nullable Redirect { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +When true (default), users who navigate to non-existent pages will be automatically + redirected to the home page of the documentation site. When false, users will see + a standard 404 error page instead. Automatic redirection can improve user experience + by keeping users within the documentation rather than showing error pages. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ErrorsConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ErrorsConfig.mdx new file mode 100644 index 0000000..36588ba --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ErrorsConfig.mdx @@ -0,0 +1,191 @@ +--- +title: ErrorsConfig +description: "Represents the error pages configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['ErrorsConfig', 'Mintlify.Core.Models.ErrorsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ErrorsConfig +``` + +## Summary + +Represents the error pages configuration for the Mintlify documentation site. + +## Remarks + +This configuration controls how various error conditions are handled, + including 404 (Not Found) errors and their behavior. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ErrorsConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### NotFound + +Gets or sets the configuration for 404 (Not Found) error handling. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Error404Config NotFound { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Error404Config?` + +#### Remarks + +Defines how the site behaves when users attempt to access pages that don't exist. + This includes options for automatic redirection and custom error page behavior. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FaviconConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FaviconConfig.mdx new file mode 100644 index 0000000..a9079bc --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FaviconConfig.mdx @@ -0,0 +1,229 @@ +--- +title: FaviconConfig +description: "Represents the favicon configuration for Mintlify. Can be a single file or separate files for light and dark mode." +icon: file-brackets-curly +keywords: ['FaviconConfig', 'Mintlify.Core.Models.FaviconConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.FaviconConfig +``` + +## Summary + +Represents the favicon configuration for Mintlify. + Can be a single file or separate files for light and dark mode. + +## Constructors + +### .ctor + +Initializes a new instance of the [FaviconConfig](/test/api-reference/Mintlify/Core/Models/FaviconConfig) class. + +#### Syntax + +```csharp +public FaviconConfig() +``` + +### .ctor + +Initializes a new instance of the [FaviconConfig](/test/api-reference/Mintlify/Core/Models/FaviconConfig) class with a single favicon path. + +#### Syntax + +```csharp +public FaviconConfig(string faviconPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `faviconPath` | `string?` | The path to the favicon file. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Dark + +Gets or sets the path to the dark favicon file, including the file extension. + +#### Syntax + +```csharp +public string Dark { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Light + +Gets or sets the path to the light favicon file, including the file extension. + +#### Syntax + +```csharp +public string Light { get; set; } +``` + +#### Property Value + +Type: `string?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the favicon configuration. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The favicon path or empty string. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter.mdx new file mode 100644 index 0000000..976a974 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter.mdx @@ -0,0 +1,78 @@ +--- +title: FaviconConfigJsonConverter +description: "Custom JSON converter for FaviconConfig that supports both string and object formats." +icon: file-brackets-curly +keywords: ['FaviconConfigJsonConverter', 'Mintlify.Core.Models.FaviconConfigJsonConverter', 'Mintlify.Core.Models', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.FaviconConfig> + +## Syntax + +```csharp +Mintlify.Core.Models.FaviconConfigJsonConverter +``` + +## Summary + +Custom JSON converter for FaviconConfig that supports both string and object formats. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public FaviconConfigJsonConverter() +``` + +## Methods + +### Read Override + +Reads and converts the JSON to a FaviconConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.FaviconConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.FaviconConfig?` +A FaviconConfig object. + +### Write Override + +Writes a FaviconConfig object as JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.FaviconConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.FaviconConfig` | The FaviconConfig object to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FontsConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FontsConfig.mdx new file mode 100644 index 0000000..53bb4ff --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FontsConfig.mdx @@ -0,0 +1,250 @@ +--- +title: FontsConfig +description: "Represents the font configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['FontsConfig', 'Mintlify.Core.Models.FontsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.FontsConfig +``` + +## Summary + +Represents the font configuration for the Mintlify documentation site. + +## Remarks + +This configuration allows customization of typography by specifying custom fonts + including font family, weight, source URLs, and format specifications. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public FontsConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Family + +Gets or sets the font family name. + +#### Syntax + +```csharp +public string Family { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies the name of the font family to use, such as "Open Sans" or "Playfair Display". + This should match the font family name defined in the font file. + +### Format + +Gets or sets the font file format. + +#### Syntax + +```csharp +public string Format { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies the format of the font file. Valid values are "woff" or "woff2". + WOFF2 is preferred for modern browsers as it provides better compression. + +### Source + +Gets or sets the font source URL. + +#### Syntax + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies the URL where the font file can be downloaded from. + Should be a complete URL pointing to the font file, such as + "https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2". + +### Weight + +Gets or sets the font weight. + +#### Syntax + +```csharp +public System.Nullable Weight { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +Specifies the font weight as a numeric value such as 400 (normal) or 700 (bold). + Precise font weights like 550 are supported for variable fonts. + Common values include 300 (light), 400 (normal), 500 (medium), 600 (semi-bold), 700 (bold). + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterConfig.mdx new file mode 100644 index 0000000..7435bc6 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterConfig.mdx @@ -0,0 +1,195 @@ +--- +title: FooterConfig +description: "Represents the footer configuration for Mintlify." +icon: file-brackets-curly +keywords: ['FooterConfig', 'Mintlify.Core.Models.FooterConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.FooterConfig +``` + +## Summary + +Represents the footer configuration for Mintlify. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public FooterConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Links + +Gets or sets the footer links. + +#### Syntax + +```csharp +public System.Collections.Generic.List Links { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Socials + +Gets or sets the social media links. + +#### Syntax + +```csharp +public System.Collections.Generic.Dictionary Socials { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.Dictionary?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterLink.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterLink.mdx new file mode 100644 index 0000000..e5a8be1 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterLink.mdx @@ -0,0 +1,199 @@ +--- +title: FooterLink +description: "Represents a footer link." +icon: file-brackets-curly +keywords: ['FooterLink', 'Mintlify.Core.Models.FooterLink', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.FooterLink +``` + +## Summary + +Represents a footer link. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public FooterLink() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Href + +Gets or sets the URL of the link. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Label + +Gets or sets the label of the link. + +#### Syntax + +```csharp +public string Label { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that appears as the link text in the footer. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterLinkGroup.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterLinkGroup.mdx new file mode 100644 index 0000000..71aa4d3 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FooterLinkGroup.mdx @@ -0,0 +1,199 @@ +--- +title: FooterLinkGroup +description: "Represents a group of footer links." +icon: file-brackets-curly +keywords: ['FooterLinkGroup', 'Mintlify.Core.Models.FooterLinkGroup', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.FooterLinkGroup +``` + +## Summary + +Represents a group of footer links. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public FooterLinkGroup() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Header + +Gets or sets the header title of the column. + +#### Syntax + +```csharp +public string Header { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that appears as the column title in the footer. + +### Items + +Gets or sets the items in the footer group. + +#### Syntax + +```csharp +public System.Collections.Generic.List Items { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FrontMatterConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FrontMatterConfig.mdx new file mode 100644 index 0000000..41fe571 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/FrontMatterConfig.mdx @@ -0,0 +1,628 @@ +--- +title: FrontMatterConfig +description: "Represents frontmatter configuration for Mintlify documentation pages." +icon: file-brackets-curly +keywords: ['FrontMatterConfig', 'Mintlify.Core.Models.FrontMatterConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.FrontMatterConfig +``` + +## Summary + +Represents frontmatter configuration for Mintlify documentation pages. + +## Remarks + +This class contains all the documented frontmatter properties supported by Mintlify. + These properties control page appearance, navigation, and behavior in the Mintlify documentation site. + For more information, see the Mintlify documentation at https://mintlify.com/docs/content/overview. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public FrontMatterConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Canonical + +Gets or sets the canonical URL for SEO. + +#### Syntax + +```csharp +public string Canonical { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Helps prevent duplicate content issues by specifying the canonical version of the page. + +### Classes + +Gets or sets custom CSS classes for the page. + +#### Syntax + +```csharp +public System.Collections.Generic.List Classes { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` + +#### Remarks + +Additional CSS classes to apply to the page for custom styling. + +### Data + +Gets or sets custom data attributes. + +#### Syntax + +```csharp +public System.Collections.Generic.Dictionary Data { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.Dictionary` + +#### Remarks + +Custom data attributes to add to the page for analytics or custom JavaScript. + +### Deprecated + +Gets or sets a value indicating whether the page is deprecated. + +#### Syntax + +```csharp +public System.Nullable Deprecated { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +When true, displays a deprecation notice on the page. + +### Description + +Gets or sets the description of the page. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Used for SEO meta descriptions and page summaries. + +### Groups + +Gets or sets the groups that can access this page. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List` + +#### Remarks + +Used for access control in authenticated documentation sites. + +### Hidden + +Gets or sets a value indicating whether the page should be hidden from navigation. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +When true, the page is accessible by direct URL but not shown in navigation menus. + +### Icon + +Gets or sets the icon for the page. + +#### Syntax + +```csharp +public string Icon { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Can be a FontAwesome icon name, Lucide icon name, or a custom icon path. + Examples: "cube", "book", "settings", "star". + +### IconType + +Gets or sets the icon type. + +#### Syntax + +```csharp +public string IconType { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Specifies the icon style. Common values: "solid", "regular", "light", "duotone". + +### Meta + +Gets or sets additional meta tags for the page. + +#### Syntax + +```csharp +public System.Collections.Generic.Dictionary Meta { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.Dictionary` + +#### Remarks + +Dictionary of additional meta tag name/content pairs for custom SEO or social media tags. + +### Mode + +Gets or sets the layout mode for the page. + +#### Syntax + +```csharp +public string Mode { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Controls the page layout. Common values: "wide", "centered". + +### OgDescription + +Gets or sets the OpenGraph description. + +#### Syntax + +```csharp +public string OgDescription { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Description used when the page is shared on social media platforms. + +### OgImage + +Gets or sets the OpenGraph image URL. + +#### Syntax + +```csharp +public string OgImage { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Image used when the page is shared on social media platforms. + +### OgTitle + +Gets or sets the OpenGraph title. + +#### Syntax + +```csharp +public string OgTitle { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Title used when the page is shared on social media platforms. + +### Order + +Gets or sets the navigation order. + +#### Syntax + +```csharp +public System.Nullable Order { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +Numeric value to control the order of pages in navigation. Lower numbers appear first. + +### Public + +Gets or sets a value indicating whether the page is public. + +#### Syntax + +```csharp +public System.Nullable Public { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +Controls visibility in public documentation sites. + +### Robots + +Gets or sets the robots meta tag content. + +#### Syntax + +```csharp +public string Robots { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Controls search engine indexing. Common values: "index,follow", "noindex,nofollow". + +### SidebarTitle + +Gets or sets the sidebar title. + +#### Syntax + +```csharp +public string SidebarTitle { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Shorter title used in the sidebar navigation. If not specified, the main title is used. + +### Tag + +Gets or sets the tag for the page. + +#### Syntax + +```csharp +public string Tag { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Displays a tag badge next to the title. Common values: "NEW", "BETA", "DEPRECATED". + +### Title + +Gets or sets the title of the page. + +#### Syntax + +```csharp +public string Title { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is the main heading displayed at the top of the page and used in navigation. + +### Url + +Gets or sets the external URL for the page. + +#### Syntax + +```csharp +public string Url { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +If specified, clicking on this page in navigation will redirect to this URL instead of showing content. + +### Version + +Gets or sets the version for the page. + +#### Syntax + +```csharp +public string Version { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Used for version-specific documentation. + +## Methods + +### Create + +Creates a FrontMatterConfig with basic title and description, properly escaped. + +#### Syntax + +```csharp +public static Mintlify.Core.Models.FrontMatterConfig Create(string title, string description = null) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `title` | `string` | The page title. | +| `description` | `string?` | The page description. | + +#### Returns + +Type: `Mintlify.Core.Models.FrontMatterConfig` +A new FrontMatterConfig instance. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### EscapeYamlValue + +Escapes a value for safe use in YAML frontmatter. + +#### Syntax + +```csharp +public static string EscapeYamlValue(string value) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `value` | `string` | The value to escape. | + +#### Returns + +Type: `string` +The escaped value, properly quoted if necessary. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +### ToYaml + +Generates YAML frontmatter from this configuration. + +#### Syntax + +```csharp +public string ToYaml() +``` + +#### Returns + +Type: `string` +The YAML frontmatter as a string, including delimiters. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalAnchorConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalAnchorConfig.mdx new file mode 100644 index 0000000..bc873b5 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalAnchorConfig.mdx @@ -0,0 +1,272 @@ +--- +title: GlobalAnchorConfig +description: "Represents an anchor configuration for global navigation in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['GlobalAnchorConfig', 'Mintlify.Core.Models.GlobalAnchorConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.GlobalAnchorConfig +``` + +## Summary + +Represents an anchor configuration for global navigation in the Mintlify documentation site. + +## Remarks + +This configuration defines an anchor link that appears globally across all sections + and pages, providing users with quick access to important external resources or key pages. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GlobalAnchorConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchor + +Gets or sets the display name for the anchor link. + +#### Syntax + +```csharp +public string Anchor { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Specifies the text that will be shown for the anchor link. Should be concise + and descriptive of the link's destination, such as "GitHub", "API Status", + "Support", etc. This is a required field. + +### Color + +Gets or sets the color configuration for the anchor. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ColorPairConfig Color { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ColorPairConfig?` + +#### Remarks + +Defines custom colors for the anchor link in light and dark modes. + This allows the anchor to have distinctive styling that matches + your brand or indicates different types of external resources. + +### Hidden + +Gets or sets whether this anchor is hidden by default. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this anchor will not be visible in the global navigation unless + specifically shown. This can be useful for anchors that are temporary + or not ready for public access. + +### Href + +Gets or sets the URL or path for this anchor link. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies where users should be directed when they click on this anchor. + Can be a relative path within the documentation or an absolute URL for + external resources such as GitHub repositories, status pages, or support portals. + +### Icon + +Gets or sets the icon to display alongside the anchor name. + +#### Syntax + +```csharp +public object Icon { get; set; } +``` + +#### Property Value + +Type: `object?` + +#### Remarks + +Can be a string icon name from the configured icon library, or an object + with detailed icon configuration including style and library properties. + The icon appears before the anchor text to provide visual context. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalDropdownConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalDropdownConfig.mdx new file mode 100644 index 0000000..769512e --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalDropdownConfig.mdx @@ -0,0 +1,291 @@ +--- +title: GlobalDropdownConfig +description: "Represents a dropdown configuration for global navigation in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['GlobalDropdownConfig', 'Mintlify.Core.Models.GlobalDropdownConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.GlobalDropdownConfig +``` + +## Summary + +Represents a dropdown configuration for global navigation in the Mintlify documentation site. + +## Remarks + +This configuration defines a dropdown menu that appears globally across all sections + and pages, providing users with organized access to multiple related links or sections. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GlobalDropdownConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Color + +Gets or sets the color configuration for the dropdown. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ColorPairConfig Color { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ColorPairConfig?` + +#### Remarks + +Defines custom colors for the dropdown in light and dark modes. + This allows the dropdown to have distinctive styling that matches + your brand or indicates different types of content. + +### Description + +Gets or sets the description text for the dropdown. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Optional descriptive text that can appear in the dropdown or as a tooltip. + Provides additional context about what users will find in the dropdown menu. + +### Dropdown + +Gets or sets the display name for the dropdown button. + +#### Syntax + +```csharp +public string Dropdown { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Specifies the text that will be shown on the dropdown button. Should be concise + and descriptive of the dropdown's contents, such as "Resources", "Tools", + "Community", etc. This is a required field. + +### Hidden + +Gets or sets whether this dropdown is hidden by default. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this dropdown will not be visible in the global navigation unless + specifically shown. This can be useful for dropdowns that are in development + or not ready for public access. + +### Href + +Gets or sets the primary URL or path for this dropdown. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies where users should be directed when they click directly on the dropdown + button (rather than selecting a specific item). Can be a relative path or absolute URL. + This is optional if the dropdown only contains sub-items. + +### Icon + +Gets or sets the icon to display alongside the dropdown name. + +#### Syntax + +```csharp +public object Icon { get; set; } +``` + +#### Property Value + +Type: `object?` + +#### Remarks + +Can be a string icon name from the configured icon library, or an object + with detailed icon configuration including style and library properties. + The icon appears before the dropdown text to provide visual context. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalLanguageConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalLanguageConfig.mdx new file mode 100644 index 0000000..0e3f483 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalLanguageConfig.mdx @@ -0,0 +1,251 @@ +--- +title: GlobalLanguageConfig +description: "Represents a language configuration for global navigation in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['GlobalLanguageConfig', 'Mintlify.Core.Models.GlobalLanguageConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.GlobalLanguageConfig +``` + +## Summary + +Represents a language configuration for global navigation in the Mintlify documentation site. + +## Remarks + +This configuration defines a language option that appears globally across all sections + and pages, allowing users to switch between different language versions of the documentation. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GlobalLanguageConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Default + +Gets or sets whether this language is the default language for the documentation. + +#### Syntax + +```csharp +public System.Nullable Default { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +When true, this language will be selected by default when users first visit + the documentation. Only one language should be marked as default. + +### Hidden + +Gets or sets whether this language option is hidden by default. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +When true, this language option will not be visible in the language selector + unless specifically shown. This can be useful for languages that are in development + or not ready for public access. + +### Href + +Gets or sets the URL or path for this language version. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies where users should be directed when they select this language. + Can be a relative path (e.g., "/es/") or an absolute URL for a different domain + (e.g., "https://es.example.com/"). + +### Language + +Gets or sets the language code in ISO 639-1 format. + +#### Syntax + +```csharp +public string Language { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Specifies the language using a standard two-letter code such as "en" for English, + "es" for Spanish, "fr" for French, etc. Extended codes like "zh-Hans" for Simplified + Chinese or "fr-CA" for Canadian French are also supported. This is a required field. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalNavigationConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalNavigationConfig.mdx new file mode 100644 index 0000000..ad18442 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalNavigationConfig.mdx @@ -0,0 +1,237 @@ +--- +title: GlobalNavigationConfig +description: "Represents global navigation configuration that appears on all sections and pages." +icon: file-brackets-curly +keywords: ['GlobalNavigationConfig', 'Mintlify.Core.Models.GlobalNavigationConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.GlobalNavigationConfig +``` + +## Summary + +Represents global navigation configuration that appears on all sections and pages. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GlobalNavigationConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchors + +Gets or sets the anchors configuration. + +#### Syntax + +```csharp +public System.Collections.Generic.List Anchors { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Dropdowns + +Gets or sets the dropdowns configuration. + +#### Syntax + +```csharp +public System.Collections.Generic.List Dropdowns { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Languages + +Gets or sets the languages configuration. + +#### Syntax + +```csharp +public System.Collections.Generic.List Languages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Tabs + +Gets or sets the tabs configuration. + +#### Syntax + +```csharp +public System.Collections.Generic.List Tabs { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Versions + +Gets or sets the versions configuration. + +#### Syntax + +```csharp +public System.Collections.Generic.List Versions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalTabConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalTabConfig.mdx new file mode 100644 index 0000000..192a1e5 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalTabConfig.mdx @@ -0,0 +1,252 @@ +--- +title: GlobalTabConfig +description: "Represents a tab configuration for global navigation in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['GlobalTabConfig', 'Mintlify.Core.Models.GlobalTabConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.GlobalTabConfig +``` + +## Summary + +Represents a tab configuration for global navigation in the Mintlify documentation site. + +## Remarks + +This configuration defines a tab that appears globally across all sections and pages, + providing users with quick access to different areas or types of documentation. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GlobalTabConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Hidden + +Gets or sets whether this tab is hidden by default. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this tab will not be visible in the global navigation unless + specifically shown. This can be useful for tabs that are in development + or not ready for public access. + +### Href + +Gets or sets the URL or path for this tab. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies where users should be directed when they click on this tab. + Can be a relative path (e.g., "/api/") or an absolute URL for external content. + This determines the landing page for the tab. + +### Icon + +Gets or sets the icon to display alongside the tab name. + +#### Syntax + +```csharp +public object Icon { get; set; } +``` + +#### Property Value + +Type: `object?` + +#### Remarks + +Can be a string icon name from the configured icon library, or an object + with detailed icon configuration including style and library properties. + The icon appears before or alongside the tab text to provide visual context. + +### Tab + +Gets or sets the display name for the tab. + +#### Syntax + +```csharp +public string Tab { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Specifies the text that will be shown on the tab button. Should be concise + and descriptive of the tab's content or purpose, such as "API Reference", + "Guides", "Examples", etc. This is a required field. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalVersionConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalVersionConfig.mdx new file mode 100644 index 0000000..3736fe8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GlobalVersionConfig.mdx @@ -0,0 +1,251 @@ +--- +title: GlobalVersionConfig +description: "Represents a version configuration for global navigation in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['GlobalVersionConfig', 'Mintlify.Core.Models.GlobalVersionConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.GlobalVersionConfig +``` + +## Summary + +Represents a version configuration for global navigation in the Mintlify documentation site. + +## Remarks + +This configuration defines a version option that appears globally across all sections + and pages, allowing users to switch between different versions of the documentation. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GlobalVersionConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Default + +Gets or sets whether this version is the default version for the documentation. + +#### Syntax + +```csharp +public System.Nullable Default { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +When true, this version will be selected by default when users first visit + the documentation. Only one version should be marked as default. + +### Hidden + +Gets or sets whether this version option is hidden by default. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +When true, this version option will not be visible in the version selector + unless specifically shown. This can be useful for versions that are deprecated, + in development, or not ready for public access. + +### Href + +Gets or sets the URL or path for this version of the documentation. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies where users should be directed when they select this version. + Can be a relative path (e.g., "/v2/") or an absolute URL for a different domain + (e.g., "https://v2.docs.example.com/"). + +### Version + +Gets or sets the version identifier or name. + +#### Syntax + +```csharp +public string Version { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Specifies the version name that will be displayed to users, such as "v1.0", + "v2.0", "latest", "beta", or any descriptive version label. This should be + concise and meaningful to your users. This is a required field. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GroupConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GroupConfig.mdx new file mode 100644 index 0000000..b45637f --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/GroupConfig.mdx @@ -0,0 +1,360 @@ +--- +title: GroupConfig +description: "Represents a group configuration in Mintlify navigation." +icon: file-brackets-curly +keywords: ['GroupConfig', 'Mintlify.Core.Models.GroupConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationItemBase'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** Mintlify.Core.Models.NavigationItemBase + +## Syntax + +```csharp +Mintlify.Core.Models.GroupConfig +``` + +## Summary + +Represents a group configuration in Mintlify navigation. + +## Remarks + +Groups organize pages into sections in your navigation. The group name is required. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GroupConfig() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +#### Syntax + +```csharp +protected NavigationItemBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AsyncApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Expanded + +Gets or sets whether the group is expanded by default in the navigation sidebar. + +#### Syntax + +```csharp +public System.Nullable Expanded { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, the group will be expanded by default showing all its pages. + When false or null, the group will be collapsed by default. + +### Group + +Gets or sets the name of the group. + +#### Syntax + +```csharp +public string Group { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that appears as the group title in navigation. + Group names cannot be null. While empty string names are technically accepted, + they are not recommended as Mintlify treats each empty group as a separate + ungrouped navigation section rather than merging them together. + +### Hidden Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this navigation item will not be displayed in the navigation by default. + +### Icon Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the icon to be displayed in the section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +#### Remarks + +Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, + URL to an externally hosted icon, or path to an icon file in your project. + +### OpenApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Pages Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the pages for this navigation item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. + +### Root + +Gets or sets the root page for the group. + +#### Syntax + +```csharp +public string Root { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies the default page to display when the group is selected. + +### Tag + +Gets or sets the tag for the group. + +#### Syntax + +```csharp +public string Tag { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Displays a label tag (e.g., "NEW", "BETA") next to the group name. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IconConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IconConfig.mdx new file mode 100644 index 0000000..dd3afba --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IconConfig.mdx @@ -0,0 +1,243 @@ +--- +title: IconConfig +description: "Represents an icon configuration in Mintlify." +icon: file-brackets-curly +keywords: ['IconConfig', 'Mintlify.Core.Models.IconConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.IconConfig +``` + +## Summary + +Represents an icon configuration in Mintlify. + +## Remarks + +Icons can be simple string references or detailed configurations with style and library options. + This matches the official Mintlify schema at https://mintlify.com/docs.json + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public IconConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Library + +Gets or sets the icon library. + +#### Syntax + +```csharp +public string Library { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies which icon library to use. Defaults to "fontawesome" if not specified. + Supported libraries include "fontawesome" and "lucide". + +### Name + +Gets or sets the icon name. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is the specific icon name, such as "home", "folder", "user", etc. + +### Style + +Gets or sets the icon style. + +#### Syntax + +```csharp +public string Style { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Specifies the style variant of the icon. Common styles include: + "brands", "duotone", "light", "regular", "solid". + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the icon. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The icon name or an empty string if null. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IconsConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IconsConfig.mdx new file mode 100644 index 0000000..51e47d7 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IconsConfig.mdx @@ -0,0 +1,193 @@ +--- +title: IconsConfig +description: "Represents the icon library configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['IconsConfig', 'Mintlify.Core.Models.IconsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.IconsConfig +``` + +## Summary + +Represents the icon library configuration for the Mintlify documentation site. + +## Remarks + +This configuration determines which icon library is used throughout the documentation + for displaying icons in navigation, buttons, and other UI elements. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public IconsConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Library + +Gets or sets the icon library to be used throughout the documentation. + +#### Syntax + +```csharp +public string Library { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Valid values are "fontawesome" or "lucide". The selected library determines + which icon names are available for use in navigation items, buttons, and other + UI components. FontAwesome provides a comprehensive set of icons, while Lucide + offers a more minimal, modern icon set. Defaults to "fontawesome". + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig.mdx new file mode 100644 index 0000000..e31606c --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig.mdx @@ -0,0 +1,193 @@ +--- +title: AmplitudeConfig +description: "Represents the configuration for Amplitude analytics integration." +icon: file-brackets-curly +keywords: ['AmplitudeConfig', 'Mintlify.Core.Models.Integrations.AmplitudeConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.AmplitudeConfig +``` + +## Summary + +Represents the configuration for Amplitude analytics integration. + +## Remarks + +Amplitude is a product analytics platform that helps teams build better products + through data-driven insights. This configuration enables automatic tracking of + documentation engagement events to your Amplitude project. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public AmplitudeConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### ApiKey + +Gets or sets the Amplitude API key for your project. + +#### Syntax + +```csharp +public string ApiKey { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your Amplitude project. You can find this + key in your Amplitude project settings. All documentation events will be + sent to the project associated with this API key. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig.mdx new file mode 100644 index 0000000..1a73170 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig.mdx @@ -0,0 +1,193 @@ +--- +title: ClearbitConfig +description: "Represents the configuration for Clearbit data enrichment integration." +icon: file-brackets-curly +keywords: ['ClearbitConfig', 'Mintlify.Core.Models.Integrations.ClearbitConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.ClearbitConfig +``` + +## Summary + +Represents the configuration for Clearbit data enrichment integration. + +## Remarks + +Clearbit provides business intelligence and data enrichment services, helping + you understand your documentation visitors by enriching analytics data with + company and demographic information. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ClearbitConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### PublicApiKey + +Gets or sets the Clearbit public API key. + +#### Syntax + +```csharp +public string PublicApiKey { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is your public API key for Clearbit, which enables data enrichment + features on your documentation site. The public key is safe to use in + client-side code. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/FathomConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/FathomConfig.mdx new file mode 100644 index 0000000..d4020a5 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/FathomConfig.mdx @@ -0,0 +1,193 @@ +--- +title: FathomConfig +description: "Represents the configuration for Fathom analytics integration." +icon: file-brackets-curly +keywords: ['FathomConfig', 'Mintlify.Core.Models.Integrations.FathomConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.FathomConfig +``` + +## Summary + +Represents the configuration for Fathom analytics integration. + +## Remarks + +Fathom is a simple, privacy-focused website analytics platform that doesn't + use cookies and is GDPR compliant. This configuration enables tracking of + documentation engagement to your Fathom analytics dashboard. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public FathomConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### SiteId + +Gets or sets the Fathom site ID. + +#### Syntax + +```csharp +public string SiteId { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your site in Fathom analytics. You can + find this ID in your Fathom dashboard under site settings. All documentation + events will be tracked under this site. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/Ga4Config.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/Ga4Config.mdx new file mode 100644 index 0000000..aaf474f --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/Ga4Config.mdx @@ -0,0 +1,64 @@ +--- +title: Ga4Config +description: "Represents the configuration for Google Analytics 4 integration." +icon: file-brackets-curly +keywords: ['Ga4Config', 'Mintlify.Core.Models.Integrations.Ga4Config', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.Ga4Config +``` + +## Summary + +Represents the configuration for Google Analytics 4 integration. + +## Remarks + +Google Analytics 4 (GA4) is Google's next-generation analytics platform that + provides insights about website traffic and user behavior. This configuration + enables automatic tracking of documentation events to your GA4 property. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public Ga4Config() +``` + +## Properties + +### MeasurementId + +Gets or sets the Google Analytics 4 measurement ID. + +#### Syntax + +```csharp +public string MeasurementId { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your GA4 web data stream, typically in + the format "G-XXXXXXXXXX". You can find this measurement ID in your Google + Analytics property settings under Data Streams. Note that Google Analytics + may take 2-3 days to start showing data after initial setup. + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config.mdx new file mode 100644 index 0000000..649910d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config.mdx @@ -0,0 +1,194 @@ +--- +title: GoogleAnalytics4Config +description: "Represents the configuration for Google Analytics 4 integration." +icon: file-brackets-curly +keywords: ['GoogleAnalytics4Config', 'Mintlify.Core.Models.Integrations.GoogleAnalytics4Config', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.GoogleAnalytics4Config +``` + +## Summary + +Represents the configuration for Google Analytics 4 integration. + +## Remarks + +Google Analytics 4 (GA4) is Google's next-generation analytics platform that + provides insights about website traffic and user behavior. This configuration + enables automatic tracking of documentation events to your GA4 property. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GoogleAnalytics4Config() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### MeasurementId + +Gets or sets the Google Analytics 4 measurement ID. + +#### Syntax + +```csharp +public string MeasurementId { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your GA4 web data stream, typically in + the format "G-XXXXXXXXXX". You can find this measurement ID in your Google + Analytics property settings under Data Streams. Note that Google Analytics + may take 2-3 days to start showing data after initial setup. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/GtmConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/GtmConfig.mdx new file mode 100644 index 0000000..608bb50 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/GtmConfig.mdx @@ -0,0 +1,194 @@ +--- +title: GtmConfig +description: "Represents the configuration for Google Tag Manager integration." +icon: file-brackets-curly +keywords: ['GtmConfig', 'Mintlify.Core.Models.Integrations.GtmConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.GtmConfig +``` + +## Summary + +Represents the configuration for Google Tag Manager integration. + +## Remarks + +Google Tag Manager (GTM) is a tag management system that allows you to quickly + update measurement codes and related code fragments (tags) on your website. + This configuration enables GTM integration for flexible analytics tracking. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public GtmConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### TagId + +Gets or sets the Google Tag Manager container ID. + +#### Syntax + +```csharp +public string TagId { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your GTM container, typically in the format + "GTM-XXXXXX". You can find this ID in your Google Tag Manager workspace + settings. The container ID allows you to manage all tracking tags through + the GTM interface. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HeapConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HeapConfig.mdx new file mode 100644 index 0000000..c331df8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HeapConfig.mdx @@ -0,0 +1,193 @@ +--- +title: HeapConfig +description: "Represents the configuration for Heap analytics integration." +icon: file-brackets-curly +keywords: ['HeapConfig', 'Mintlify.Core.Models.Integrations.HeapConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.HeapConfig +``` + +## Summary + +Represents the configuration for Heap analytics integration. + +## Remarks + +Heap is an analytics platform that automatically captures every user interaction + on your site without requiring manual event tracking. This configuration enables + Heap to track all documentation engagement automatically. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public HeapConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AppId + +Gets or sets the Heap application ID. + +#### Syntax + +```csharp +public string AppId { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your Heap project. You can find this ID + in your Heap project settings under Installation. All user interactions on + your documentation will be automatically captured and sent to this Heap project. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig.mdx new file mode 100644 index 0000000..50e17d3 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig.mdx @@ -0,0 +1,192 @@ +--- +title: HightouchConfig +description: "Represents the configuration for Hightouch integration." +icon: file-brackets-curly +keywords: ['HightouchConfig', 'Mintlify.Core.Models.Integrations.HightouchConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.HightouchConfig +``` + +## Summary + +Represents the configuration for Hightouch integration. + +## Remarks + +Hightouch is a data activation platform that syncs data from your warehouse + to business tools. This configuration enables Hightouch tracking on your + documentation site. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public HightouchConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### ApiKey + +Gets or sets the Hightouch API key. + +#### Syntax + +```csharp +public string ApiKey { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is your Hightouch API key that enables event tracking and data + synchronization from your documentation site to Hightouch. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig.mdx new file mode 100644 index 0000000..57896a3 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig.mdx @@ -0,0 +1,213 @@ +--- +title: HotjarConfig +description: "Represents the configuration for Hotjar integration." +icon: file-brackets-curly +keywords: ['HotjarConfig', 'Mintlify.Core.Models.Integrations.HotjarConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.HotjarConfig +``` + +## Summary + +Represents the configuration for Hotjar integration. + +## Remarks + +Hotjar is a behavior analytics tool that provides heatmaps, session recordings, + and feedback polls to understand how users interact with your documentation. + This configuration enables Hotjar tracking on your site. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public HotjarConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Hjid + +Gets or sets the Hotjar site ID. + +#### Syntax + +```csharp +public string Hjid { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your site in Hotjar, found in your Hotjar + tracking code. It is typically a numeric value that identifies which Hotjar + site configuration to use. + +### Hjsv + +Gets or sets the Hotjar script version. + +#### Syntax + +```csharp +public string Hjsv { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the version number of the Hotjar tracking script, also found in your + Hotjar tracking code. It ensures that the correct version of the tracking + script is loaded for your site. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig.mdx new file mode 100644 index 0000000..aee1336 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig.mdx @@ -0,0 +1,194 @@ +--- +title: LogRocketConfig +description: "Represents the configuration for LogRocket integration." +icon: file-brackets-curly +keywords: ['LogRocketConfig', 'Mintlify.Core.Models.Integrations.LogRocketConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.LogRocketConfig +``` + +## Summary + +Represents the configuration for LogRocket integration. + +## Remarks + +LogRocket is a session replay and analytics platform that records user sessions, + including console logs, network activity, and DOM changes. This configuration + enables LogRocket session recording on your documentation site. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public LogRocketConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AppId + +Gets or sets the LogRocket application ID. + +#### Syntax + +```csharp +public string AppId { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your LogRocket application, typically in + the format "organization-name/app-name". You can find this ID in your LogRocket + project settings. All session recordings and analytics will be sent to this + LogRocket application. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig.mdx new file mode 100644 index 0000000..3e1dc5b --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig.mdx @@ -0,0 +1,193 @@ +--- +title: MixpanelConfig +description: "Represents the configuration for Mixpanel analytics integration." +icon: file-brackets-curly +keywords: ['MixpanelConfig', 'Mintlify.Core.Models.Integrations.MixpanelConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.MixpanelConfig +``` + +## Summary + +Represents the configuration for Mixpanel analytics integration. + +## Remarks + +Mixpanel is a product analytics platform that helps you understand user behavior + through event tracking and user analysis. This configuration enables automatic + tracking of documentation engagement events to your Mixpanel project. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MixpanelConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### ProjectToken + +Gets or sets the Mixpanel project token. + +#### Syntax + +```csharp +public string ProjectToken { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your Mixpanel project. You can find this + token in your Mixpanel project settings. All documentation events will be + sent to the project associated with this token. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PirschConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PirschConfig.mdx new file mode 100644 index 0000000..0c83f16 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PirschConfig.mdx @@ -0,0 +1,193 @@ +--- +title: PirschConfig +description: "Represents the configuration for Pirsch analytics integration." +icon: file-brackets-curly +keywords: ['PirschConfig', 'Mintlify.Core.Models.Integrations.PirschConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.PirschConfig +``` + +## Summary + +Represents the configuration for Pirsch analytics integration. + +## Remarks + +Pirsch is a privacy-friendly, GDPR-compliant web analytics platform that provides + simple, cookie-free website analytics. This configuration enables tracking of + documentation engagement to your Pirsch analytics dashboard. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public PirschConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Id + +Gets or sets the Pirsch identification code. + +#### Syntax + +```csharp +public string Id { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the unique identifier for your Pirsch analytics instance. You can + find this ID in your Pirsch dashboard settings. All documentation events + will be tracked under this Pirsch account. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig.mdx new file mode 100644 index 0000000..d793533 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig.mdx @@ -0,0 +1,214 @@ +--- +title: PlausibleConfig +description: "Represents the configuration for Plausible analytics integration." +icon: file-brackets-curly +keywords: ['PlausibleConfig', 'Mintlify.Core.Models.Integrations.PlausibleConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.PlausibleConfig +``` + +## Summary + +Represents the configuration for Plausible analytics integration. + +## Remarks + +Plausible is a lightweight, open-source, privacy-friendly web analytics platform + that doesn't use cookies. This configuration enables tracking of documentation + engagement to your Plausible analytics instance. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public PlausibleConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Domain + +Gets or sets the domain being tracked in Plausible. + +#### Syntax + +```csharp +public string Domain { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is the domain name that you registered in your Plausible account. + It should match the domain where your documentation is hosted. All + analytics events will be attributed to this domain in your Plausible dashboard. + +### Server + +Gets or sets the custom Plausible server URL. + +#### Syntax + +```csharp +public string Server { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is optional and only needed if you are self-hosting Plausible or using + a custom Plausible server. If not specified, the default Plausible cloud + service will be used. The URL should point to your self-hosted Plausible + instance. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig.mdx new file mode 100644 index 0000000..a029081 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig.mdx @@ -0,0 +1,214 @@ +--- +title: PostHogConfig +description: "Represents the configuration for PostHog analytics integration." +icon: file-brackets-curly +keywords: ['PostHogConfig', 'Mintlify.Core.Models.Integrations.PostHogConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.PostHogConfig +``` + +## Summary + +Represents the configuration for PostHog analytics integration. + +## Remarks + +PostHog is an open-source product analytics platform that provides session + recording, feature flags, and product analytics. This configuration enables + automatic tracking of documentation events to your PostHog instance. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public PostHogConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### ApiHost + +Gets or sets the PostHog API host URL. + +#### Syntax + +```csharp +public string ApiHost { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is optional and only needed if you are self-hosting PostHog. If not + specified, events will be sent to the default PostHog cloud service at + https://app.posthog.com. If you are self-hosting, specify the full URL + to your PostHog instance. + +### ApiKey + +Gets or sets the PostHog project API key. + +#### Syntax + +```csharp +public string ApiKey { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is your PostHog project's API key, which typically starts with "phc_". + You can find this key in your PostHog project settings. All documentation + events will be sent to the PostHog project associated with this API key. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig.mdx new file mode 100644 index 0000000..7e4aa57 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig.mdx @@ -0,0 +1,195 @@ +--- +title: SegmentConfig +description: "Represents the configuration for Segment integration." +icon: file-brackets-curly +keywords: ['SegmentConfig', 'Mintlify.Core.Models.Integrations.SegmentConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models.Integrations + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.Integrations.SegmentConfig +``` + +## Summary + +Represents the configuration for Segment integration. + +## Remarks + +Segment is a customer data platform that collects, transforms, and routes + analytics data to various downstream tools. This configuration enables + documentation event tracking to be sent to Segment, which can then forward + the data to your configured destinations. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public SegmentConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Key + +Gets or sets the Segment write key. + +#### Syntax + +```csharp +public string Key { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This is your Segment source's write key, which identifies which Segment + source should receive the events. You can find this key in your Segment + source settings. All documentation events will be sent to this Segment + source and then forwarded to your configured destinations. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/index.mdx new file mode 100644 index 0000000..bfcc0d9 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/Integrations/index.mdx @@ -0,0 +1,29 @@ +--- +title: Overview +description: "Summary of the Mintlify.Core.Models.Integrations Namespace" +icon: folder-tree +mode: wide +keywords: ['Mintlify.Core.Models.Integrations', 'namespace', 'AmplitudeConfig', 'ClearbitConfig', 'FathomConfig', 'GoogleAnalytics4Config', 'GtmConfig', 'HeapConfig', 'HightouchConfig', 'HotjarConfig', 'LogRocketConfig', 'MixpanelConfig'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [AmplitudeConfig](/test/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig) | Represents the configuration for Amplitude analytics integration. | +| [ClearbitConfig](/test/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig) | Represents the configuration for Clearbit data enrichment integration. | +| [FathomConfig](/test/api-reference/Mintlify/Core/Models/Integrations/FathomConfig) | Represents the configuration for Fathom analytics integration. | +| [GoogleAnalytics4Config](/test/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config) | Represents the configuration for Google Analytics 4 integration. | +| [GtmConfig](/test/api-reference/Mintlify/Core/Models/Integrations/GtmConfig) | Represents the configuration for Google Tag Manager integration. | +| [HeapConfig](/test/api-reference/Mintlify/Core/Models/Integrations/HeapConfig) | Represents the configuration for Heap analytics integration. | +| [HightouchConfig](/test/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig) | Represents the configuration for Hightouch integration. | +| [HotjarConfig](/test/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig) | Represents the configuration for Hotjar integration. | +| [LogRocketConfig](/test/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig) | Represents the configuration for LogRocket integration. | +| [MixpanelConfig](/test/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig) | Represents the configuration for Mixpanel analytics integration. | +| [PirschConfig](/test/api-reference/Mintlify/Core/Models/Integrations/PirschConfig) | Represents the configuration for Pirsch analytics integration. | +| [PlausibleConfig](/test/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig) | Represents the configuration for Plausible analytics integration. | +| [PostHogConfig](/test/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig) | Represents the configuration for PostHog analytics integration. | +| [SegmentConfig](/test/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig) | Represents the configuration for Segment integration. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IntegrationsConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IntegrationsConfig.mdx new file mode 100644 index 0000000..66cdca2 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/IntegrationsConfig.mdx @@ -0,0 +1,443 @@ +--- +title: IntegrationsConfig +description: "Represents the integrations configuration for third-party services in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['IntegrationsConfig', 'Mintlify.Core.Models.IntegrationsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.IntegrationsConfig +``` + +## Summary + +Represents the integrations configuration for third-party services in the Mintlify documentation site. + +## Remarks + +This configuration enables integration with various analytics, feedback, and other third-party + services. Each integration has specific configuration requirements defined in their respective + configuration classes. These integrations allow automatic tracking of documentation engagement + and user behavior to your preferred analytics platforms. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public IntegrationsConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Amplitude + +Gets or sets the Amplitude analytics integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.AmplitudeConfig Amplitude { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.AmplitudeConfig?` + +#### Remarks + +Amplitude provides product analytics to understand user behavior and engagement. + When configured, all documentation events are automatically sent to your Amplitude project. + +### Clearbit + +Gets or sets the Clearbit data enrichment integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.ClearbitConfig Clearbit { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.ClearbitConfig?` + +#### Remarks + +Clearbit enriches your analytics data with company and demographic information. + When configured, visitor data is enhanced with business intelligence. + +### Fathom + +Gets or sets the Fathom analytics integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.FathomConfig Fathom { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.FathomConfig?` + +#### Remarks + +Fathom provides simple, privacy-focused analytics that is GDPR compliant + and doesn't use cookies. When configured, page views and events are tracked + in your Fathom dashboard. + +### GoogleAnalytics4 + +Gets or sets the Google Analytics 4 integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.GoogleAnalytics4Config GoogleAnalytics4 { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.GoogleAnalytics4Config?` + +#### Remarks + +Google Analytics 4 (GA4) is Google's next-generation analytics platform. + When configured, all documentation events are sent to your GA4 property. + Note that GA4 data may take 2-3 days to appear after initial setup. + +### Gtm + +Gets or sets the Google Tag Manager integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.GtmConfig Gtm { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.GtmConfig?` + +#### Remarks + +Google Tag Manager (GTM) allows flexible tag management for analytics and marketing. + When configured, you can manage all tracking tags through the GTM interface. + +### Heap + +Gets or sets the Heap analytics integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.HeapConfig Heap { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.HeapConfig?` + +#### Remarks + +Heap automatically captures all user interactions without manual event tracking. + When configured, every user interaction on your documentation is automatically tracked. + +### Hightouch + +Gets or sets the Hightouch data activation integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.HightouchConfig Hightouch { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.HightouchConfig?` + +#### Remarks + +Hightouch syncs data from your warehouse to business tools. When configured, + documentation events can be synchronized to your data warehouse and downstream tools. + +### Hotjar + +Gets or sets the Hotjar behavior analytics integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.HotjarConfig Hotjar { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.HotjarConfig?` + +#### Remarks + +Hotjar provides heatmaps, session recordings, and user feedback tools. + When configured, you can visualize how users interact with your documentation. + +### LogRocket + +Gets or sets the LogRocket session replay integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.LogRocketConfig LogRocket { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.LogRocketConfig?` + +#### Remarks + +LogRocket records user sessions including console logs and network activity. + When configured, you can replay user sessions to understand issues and behavior. + +### Mixpanel + +Gets or sets the Mixpanel product analytics integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.MixpanelConfig Mixpanel { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.MixpanelConfig?` + +#### Remarks + +Mixpanel provides detailed product analytics and user behavior tracking. + When configured, all documentation events are sent to your Mixpanel project. + +### Pirsch + +Gets or sets the Pirsch analytics integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.PirschConfig Pirsch { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.PirschConfig?` + +#### Remarks + +Pirsch is a privacy-friendly, GDPR-compliant analytics platform. + When configured, page views and events are tracked without cookies. + +### Plausible + +Gets or sets the Plausible analytics integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.PlausibleConfig Plausible { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.PlausibleConfig?` + +#### Remarks + +Plausible is a lightweight, open-source, privacy-focused analytics platform. + When configured, documentation engagement is tracked without cookies. + +### PostHog + +Gets or sets the PostHog product analytics integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.PostHogConfig PostHog { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.PostHogConfig?` + +#### Remarks + +PostHog provides session recording, feature flags, and product analytics. + When configured, all documentation events are sent to your PostHog instance. + +### Segment + +Gets or sets the Segment customer data platform integration configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.Integrations.SegmentConfig Segment { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.Integrations.SegmentConfig?` + +#### Remarks + +Segment collects, transforms, and routes analytics data to various destinations. + When configured, documentation events are sent to Segment and forwarded to your + configured downstream tools. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/InteractionConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/InteractionConfig.mdx new file mode 100644 index 0000000..d16bcb5 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/InteractionConfig.mdx @@ -0,0 +1,204 @@ +--- +title: InteractionConfig +description: "Represents the interaction configuration for navigation elements in Mintlify." +icon: file-brackets-curly +keywords: ['InteractionConfig', 'Mintlify.Core.Models.InteractionConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.InteractionConfig +``` + +## Summary + +Represents the interaction configuration for navigation elements in Mintlify. + +## Remarks + +Controls how users interact with navigation elements such as groups and dropdowns, + including whether expanding a group automatically navigates to its first page. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public InteractionConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Drilldown + +Gets or sets whether to automatically navigate to the first page when expanding a navigation group. + +#### Syntax + +```csharp +public System.Nullable Drilldown { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Examples + +```csharp +"interaction": { + "drilldown": false // Never navigate, only expand or collapse the group +} +``` + +#### Remarks + +Valid values are: + - true: Force automatic navigation to the first page when a navigation group is selected + - false: Prevent navigation and only expand or collapse the group when it is selected + - null: Use the theme's default behavior + + Some themes will automatically navigate to the first page in a group when it is expanded. + This setting allows you to override the theme's default behavior. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/LanguageConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/LanguageConfig.mdx new file mode 100644 index 0000000..870c0e6 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/LanguageConfig.mdx @@ -0,0 +1,353 @@ +--- +title: LanguageConfig +description: "Represents a language configuration in Mintlify navigation." +icon: file-brackets-curly +keywords: ['LanguageConfig', 'Mintlify.Core.Models.LanguageConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.LanguageConfig +``` + +## Summary + +Represents a language configuration in Mintlify navigation. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public LanguageConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchors + +Gets or sets the anchors for the language. + +#### Syntax + +```csharp +public System.Collections.Generic.List Anchors { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### AsyncApi + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public object AsyncApi { get; set; } +``` + +#### Property Value + +Type: `object?` + +### Default + +Gets or sets whether this language is the default language. + +#### Syntax + +```csharp +public System.Nullable Default { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +### Dropdowns + +Gets or sets the dropdowns for the language. + +#### Syntax + +```csharp +public System.Collections.Generic.List Dropdowns { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Global + +Gets or sets the global navigation configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.GlobalNavigationConfig?` + +### Groups + +Gets or sets the groups for the language. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Hidden + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +### Href + +Gets or sets the URL or path for the language. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Language + +Gets or sets the language code in ISO 639-1 format. + +#### Syntax + +```csharp +public string Language { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that identifies the language. + +### OpenApi + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public object OpenApi { get; set; } +``` + +#### Property Value + +Type: `object?` + +### Pages + +Gets or sets the pages for the language. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Tabs + +Gets or sets the tabs for the language. + +#### Syntax + +```csharp +public System.Collections.Generic.List Tabs { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Versions + +Gets or sets the versions for the language. + +#### Syntax + +```csharp +public System.Collections.Generic.List Versions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/LogoConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/LogoConfig.mdx new file mode 100644 index 0000000..4f352e6 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/LogoConfig.mdx @@ -0,0 +1,226 @@ +--- +title: LogoConfig +description: "Represents the logo configuration for Mintlify. Can be a single image path for both light and dark mode, or separate paths for each mode." +icon: file-brackets-curly +keywords: ['LogoConfig', 'Mintlify.Core.Models.LogoConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.LogoConfig +``` + +## Summary + +Represents the logo configuration for Mintlify. + Can be a single image path for both light and dark mode, or separate paths for each mode. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public LogoConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Dark + +Gets or sets the path to the dark logo file, including the file extension. + +#### Syntax + +```csharp +public string Dark { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Href + +Gets or sets the URL to redirect to when clicking the logo. + If not provided, the logo will link to the homepage. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Light + +Gets or sets the path to the light logo file, including the file extension. + +#### Syntax + +```csharp +public string Light { get; set; } +``` + +#### Property Value + +Type: `string?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the logo configuration. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The logo path or empty string. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MdxAuthConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MdxAuthConfig.mdx new file mode 100644 index 0000000..9d3b99d --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MdxAuthConfig.mdx @@ -0,0 +1,230 @@ +--- +title: MdxAuthConfig +description: "Represents the authentication configuration for MDX-based API documentation." +icon: file-brackets-curly +keywords: ['MdxAuthConfig', 'Mintlify.Core.Models.MdxAuthConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.MdxAuthConfig +``` + +## Summary + +Represents the authentication configuration for MDX-based API documentation. + +## Remarks + +Specifies how API requests should be authenticated when using the interactive + playground in MDX-generated API documentation pages. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MdxAuthConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Method + +Gets or sets the authentication method. + +#### Syntax + +```csharp +public string Method { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Examples + +```csharp +"auth": { + "method": "bearer" +} +``` + +#### Remarks + +Valid values are: "bearer", "basic", "key", "cobo". + - bearer: Bearer token authentication (Authorization: Bearer TOKEN) + - basic: Basic authentication (Authorization: Basic BASE64) + - key: API key authentication (custom header) + - cobo: Cobo-specific authentication + +### Name + +Gets or sets the name of the authentication header or parameter. + +#### Syntax + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Examples + +```csharp +"auth": { + "method": "key", + "name": "x-api-key" +} +``` + +#### Remarks + +For "key" authentication method, this specifies the header name (e.g., "x-api-key"). + For other methods, this may specify additional configuration parameters. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MdxConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MdxConfig.mdx new file mode 100644 index 0000000..692ef0b --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MdxConfig.mdx @@ -0,0 +1,221 @@ +--- +title: MdxConfig +description: "Represents the MDX configuration for API pages generated from MDX files." +icon: file-brackets-curly +keywords: ['MdxConfig', 'Mintlify.Core.Models.MdxConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.MdxConfig +``` + +## Summary + +Represents the MDX configuration for API pages generated from MDX files. + +## Remarks + +This configuration allows manual definition of API endpoints in individual MDX files + rather than using an OpenAPI specification. It provides flexibility for custom content + and is useful for documenting small APIs or prototyping. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MdxConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Auth + +Gets or sets the authentication configuration for MDX-based API requests. + +#### Syntax + +```csharp +public Mintlify.Core.Models.MdxAuthConfig Auth { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.MdxAuthConfig?` + +#### Remarks + +Defines the authentication method and parameters required for API calls + made from the documentation playground. + +### Server + +Gets or sets the base server URL(s) for API requests. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ServerConfig Server { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ServerConfig?` + +#### Examples + +```csharp +// Single server +"server": "https://api.example.com" + +// Multiple servers +"server": ["https://api1.example.com", "https://api2.example.com"] +``` + +#### Remarks + +Can be a single string URL or an array of URLs for multiple base endpoints. + Used as the base URL for all API requests made from the playground. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MenuConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MenuConfig.mdx new file mode 100644 index 0000000..ef4057f --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MenuConfig.mdx @@ -0,0 +1,254 @@ +--- +title: MenuConfig +description: "Represents a menu item configuration in Mintlify navigation." +icon: file-brackets-curly +keywords: ['MenuConfig', 'Mintlify.Core.Models.MenuConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.MenuConfig +``` + +## Summary + +Represents a menu item configuration in Mintlify navigation. + +## Remarks + +Menu items appear as dropdown menu options within tabs. + The item name is required. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MenuConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Description + +Gets or sets the description of the menu item. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Provides additional descriptive text for the menu item. + +### Groups + +Gets or sets the groups for the menu item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Icon + +Gets or sets the icon to be displayed for the menu item. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +### Item + +Gets or sets the name of the menu item. + +#### Syntax + +```csharp +public string Item { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that appears as the menu item label. + +### Pages + +Gets or sets the pages for the menu item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MergeOptions.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MergeOptions.mdx new file mode 100644 index 0000000..2caa6d2 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/MergeOptions.mdx @@ -0,0 +1,201 @@ +--- +title: MergeOptions +description: "Defines merging as combining two navigation structures into one integrated structure. Options control how different aspects of the merge are hand..." +icon: file-brackets-curly +keywords: ['MergeOptions', 'Mintlify.Core.Models.MergeOptions', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.MergeOptions +``` + +## Summary + +Defines merging as combining two navigation structures into one integrated structure. + Options control how different aspects of the merge are handled. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MergeOptions() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AddRootPagesToGettingStarted + +Gets or sets whether to add newly discovered root-level pages to the "Getting Started" group + instead of the root level. This is used when merging discovered navigation into template navigation. + When true, new root-level string pages from the source will be added to the "Getting Started" group. + When false (default), new root-level pages are added at the root level. + +#### Syntax + +```csharp +public bool AddRootPagesToGettingStarted { get; set; } +``` + +#### Property Value + +Type: `bool` + +### CombineEmptyGroups + +Gets or sets whether to combine groups with empty string names at the same navigation level. + When true, multiple groups with empty names will be merged into a single group. + When false (default), each empty group remains separate, matching Mintlify's behavior. + +#### Syntax + +```csharp +public bool CombineEmptyGroups { get; set; } +``` + +#### Property Value + +Type: `bool` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavbarConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavbarConfig.mdx new file mode 100644 index 0000000..58d32b0 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavbarConfig.mdx @@ -0,0 +1,211 @@ +--- +title: NavbarConfig +description: "Represents the navigation bar configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['NavbarConfig', 'Mintlify.Core.Models.NavbarConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.NavbarConfig +``` + +## Summary + +Represents the navigation bar configuration for the Mintlify documentation site. + +## Remarks + +This configuration controls the content and appearance of the top navigation bar, + including custom links and primary call-to-action buttons. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public NavbarConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Links + +Gets or sets the list of navigation links to display in the navbar. + +#### Syntax + +```csharp +public System.Collections.Generic.List Links { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Each link should have a label, optional icon, and href pointing to the destination. + These links appear in the top navigation bar of the documentation site. + +### Primary + +Gets or sets the primary call-to-action configuration in the navbar. + +#### Syntax + +```csharp +public Mintlify.Core.Models.PrimaryNavigationConfig Primary { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.PrimaryNavigationConfig?` + +#### Remarks + +Can be a button configuration with type "button", label, and href properties, + or a GitHub configuration with type "github" and href properties. + This appears prominently in the navbar to drive user actions. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavbarLink.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavbarLink.mdx new file mode 100644 index 0000000..3fcde8c --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavbarLink.mdx @@ -0,0 +1,230 @@ +--- +title: NavbarLink +description: "Represents a navigation link in the Mintlify navbar." +icon: file-brackets-curly +keywords: ['NavbarLink', 'Mintlify.Core.Models.NavbarLink', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.NavbarLink +``` + +## Summary + +Represents a navigation link in the Mintlify navbar. + +## Remarks + +Each navbar link consists of a label, optional icon, and destination URL. + These links provide quick access to important pages or external resources. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public NavbarLink() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Href + +Gets or sets the destination URL for the navigation link. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be an absolute URL (https://example.com) or a relative path (/docs/page). + This determines where users navigate when clicking the link. + +### Icon + +Gets or sets the icon to display alongside the navigation link. + +#### Syntax + +```csharp +public object Icon { get; set; } +``` + +#### Property Value + +Type: `object?` + +#### Remarks + +Can be a string icon name from the configured icon library, or an object + with detailed icon configuration including style and library properties. + The icon appears before the label text. + +### Label + +Gets or sets the display text for the navigation link. + +#### Syntax + +```csharp +public string Label { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This text appears in the navbar and should be concise and descriptive + of the link's destination. This is a required field. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationConfig.mdx new file mode 100644 index 0000000..564e428 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationConfig.mdx @@ -0,0 +1,306 @@ +--- +title: NavigationConfig +description: "Represents the navigation configuration for Mintlify." +icon: file-brackets-curly +keywords: ['NavigationConfig', 'Mintlify.Core.Models.NavigationConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.NavigationConfig +``` + +## Summary + +Represents the navigation configuration for Mintlify. + +## Remarks + +This is a required field that defines the structure of your documentation. + At minimum, you need to define some navigation items (pages, groups, tabs, etc.). + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public NavigationConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchors + +Gets or sets the anchors in the navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Anchors { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Dropdowns + +Gets or sets the dropdowns in the navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Dropdowns { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Global + +Gets or sets global navigation items that appear on all sections and pages. + +#### Syntax + +```csharp +public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.GlobalNavigationConfig?` + +### Groups + +Gets or sets the groups in the navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Languages + +Gets or sets the languages in the navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Languages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Pages + +Gets or sets the pages in the navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be either strings (page paths) or nested GroupConfig objects. + +### Products + +Gets or sets the products in the navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Products { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Products separate documentation into distinct product-specific sections. + +### Tabs + +Gets or sets the tabs in the navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Tabs { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Versions + +Gets or sets the versions in the navigation. + +#### Syntax + +```csharp +public System.Collections.Generic.List Versions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationContainerBase.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationContainerBase.mdx new file mode 100644 index 0000000..cfece37 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationContainerBase.mdx @@ -0,0 +1,314 @@ +--- +title: NavigationContainerBase +description: "Base class for navigation items that can contain groups and have external links." +icon: shapes +tag: "ABSTRACT" +keywords: ['NavigationContainerBase', 'Mintlify.Core.Models.NavigationContainerBase', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationItemBase'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** Mintlify.Core.Models.NavigationItemBase + +## Syntax + +```csharp +Mintlify.Core.Models.NavigationContainerBase +``` + +## Summary + +Base class for navigation items that can contain groups and have external links. + +## Remarks + +Extends NavigationItemBase to add support for nested groups and external URLs. + Used by products and other container-level navigation elements. + +## Constructors + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +#### Syntax + +```csharp +protected NavigationItemBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AsyncApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Groups + +Gets or sets the groups for this navigation container. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Groups organize pages into labeled sections within this navigation container. + +### Hidden Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this navigation item will not be displayed in the navigation by default. + +### Href + +Gets or sets the URL or path for this navigation container. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be used to link to an external URL or specify a path for this container. + +### Icon Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the icon to be displayed in the section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +#### Remarks + +Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, + URL to an externally hosted icon, or path to an icon file in your project. + +### OpenApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Pages Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the pages for this navigation item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationItemBase.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationItemBase.mdx new file mode 100644 index 0000000..ec286eb --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationItemBase.mdx @@ -0,0 +1,258 @@ +--- +title: NavigationItemBase +description: "Base class for all navigation items in Mintlify." +icon: shapes +tag: "ABSTRACT" +keywords: ['NavigationItemBase', 'Mintlify.Core.Models.NavigationItemBase', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.NavigationItemBase +``` + +## Summary + +Base class for all navigation items in Mintlify. + +## Remarks + +Provides common properties shared across all navigation elements including + API specifications, icons, pages, and visibility settings. + +## Constructors + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AsyncApi + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Hidden + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this navigation item will not be displayed in the navigation by default. + +### Icon + +Gets or sets the icon to be displayed in the section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +#### Remarks + +Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, + URL to an externally hosted icon, or path to an icon file in your project. + +### OpenApi + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Pages + +Gets or sets the pages for this navigation item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationSectionBase.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationSectionBase.mdx new file mode 100644 index 0000000..8627972 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/NavigationSectionBase.mdx @@ -0,0 +1,437 @@ +--- +title: NavigationSectionBase +description: "Base class for top-level navigation sections (tabs, anchors, dropdowns)." +icon: shapes +tag: "ABSTRACT" +keywords: ['NavigationSectionBase', 'Mintlify.Core.Models.NavigationSectionBase', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationContainerBase'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** Mintlify.Core.Models.NavigationContainerBase + +## Syntax + +```csharp +Mintlify.Core.Models.NavigationSectionBase +``` + +## Summary + +Base class for top-level navigation sections (tabs, anchors, dropdowns). + +## Remarks + +Extends NavigationContainerBase to add support for colors, descriptions, + global navigation, versioning, and language support. Used by tabs, anchors, + and dropdowns which are the primary navigation sections. + +## Constructors + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +#### Syntax + +```csharp +protected NavigationContainerBase() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +#### Syntax + +```csharp +protected NavigationItemBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AsyncApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Color + +Gets or sets the color configuration for this navigation section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ColorPairConfig Color { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ColorPairConfig?` + +#### Remarks + +Defines the primary and secondary colors used for this section's visual styling. + +### Description + +Gets or sets the description of this navigation section. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Provides additional descriptive text about this navigation section. + +### Dropdowns + +Gets or sets the dropdowns for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Dropdowns { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Dropdowns create expandable menu sections within this navigation section. + +### Global + +Gets or sets global navigation items that appear on all sections and pages. + +#### Syntax + +```csharp +public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.GlobalNavigationConfig?` + +#### Remarks + +Global navigation items persist across different tabs and pages for consistent navigation. + +### Groups Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the groups for this navigation container. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Groups organize pages into labeled sections within this navigation container. + +### Hidden Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this navigation item will not be displayed in the navigation by default. + +### Href Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the URL or path for this navigation container. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be used to link to an external URL or specify a path for this container. + +### Icon Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the icon to be displayed in the section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +#### Remarks + +Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, + URL to an externally hosted icon, or path to an icon file in your project. + +### Languages + +Gets or sets the languages for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Languages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows partitioning navigation into different language-specific versions. + +### OpenApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Pages Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the pages for this navigation item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. + +### Versions + +Gets or sets the versions for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Versions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows partitioning navigation into different version-specific documentation. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig.mdx new file mode 100644 index 0000000..8416067 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig.mdx @@ -0,0 +1,303 @@ +--- +title: PrimaryNavigationConfig +description: "Represents the primary navigation configuration for Mintlify navbar. Can be a button configuration or a GitHub configuration." +icon: file-brackets-curly +keywords: ['PrimaryNavigationConfig', 'Mintlify.Core.Models.PrimaryNavigationConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.PrimaryNavigationConfig +``` + +## Summary + +Represents the primary navigation configuration for Mintlify navbar. + Can be a button configuration or a GitHub configuration. + +## Constructors + +### .ctor + +Initializes a new instance of the [PrimaryNavigationConfig](/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig) class. + +#### Syntax + +```csharp +public PrimaryNavigationConfig() +``` + +### .ctor + +Initializes a new instance of the [PrimaryNavigationConfig](/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig) class for a button. + +#### Syntax + +```csharp +public PrimaryNavigationConfig(string label, string href) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `label` | `string` | The button label. | +| `href` | `string` | The button href URL. | + +### .ctor + +Initializes a new instance of the [PrimaryNavigationConfig](/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig) class for GitHub. + +#### Syntax + +```csharp +public PrimaryNavigationConfig(string href) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `href` | `string` | The GitHub URL. | + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Href + +Gets or sets the href URL for the navigation item. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Label + +Gets or sets the label text for button-type navigation items. + +#### Syntax + +```csharp +public string Label { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Type + +Gets or sets the type of navigation item (e.g., "button", "github"). + +#### Syntax + +```csharp +public string Type { get; set; } +``` + +#### Property Value + +Type: `string?` + +## Methods + +### Button + +Creates a button-type navigation configuration. + +#### Syntax + +```csharp +public static Mintlify.Core.Models.PrimaryNavigationConfig Button(string label, string href) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `label` | `string` | The button label. | +| `href` | `string` | The button href URL. | + +#### Returns + +Type: `Mintlify.Core.Models.PrimaryNavigationConfig` +A PrimaryNavigationConfig configured as a button. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### GitHub + +Creates a GitHub-type navigation configuration. + +#### Syntax + +```csharp +public static Mintlify.Core.Models.PrimaryNavigationConfig GitHub(string href) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `href` | `string` | The GitHub URL. | + +#### Returns + +Type: `Mintlify.Core.Models.PrimaryNavigationConfig` +A PrimaryNavigationConfig configured for GitHub. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the navigation configuration. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The href URL or empty string. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfigJsonConverter.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfigJsonConverter.mdx new file mode 100644 index 0000000..253dba0 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfigJsonConverter.mdx @@ -0,0 +1,79 @@ +--- +title: PrimaryNavigationConfigJsonConverter +description: "Custom JSON converter for PrimaryNavigationConfig that handles object format." +icon: file-brackets-curly +sidebarTitle: PrimaryNavigationConfigJsonConverter +keywords: ['PrimaryNavigationConfigJsonConverter', 'Mintlify.Core.Models.PrimaryNavigationConfigJsonConverter', 'Mintlify.Core.Models', 'class', 'System.Text.Json.Serialization.JsonConverter'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.PrimaryNavigationConfig> + +## Syntax + +```csharp +Mintlify.Core.Models.PrimaryNavigationConfigJsonConverter +``` + +## Summary + +Custom JSON converter for PrimaryNavigationConfig that handles object format. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public PrimaryNavigationConfigJsonConverter() +``` + +## Methods + +### Read + +Reads and converts the JSON to a PrimaryNavigationConfig object. + +#### Syntax + +```csharp +public override Mintlify.Core.Models.PrimaryNavigationConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reader` | `System.Text.Json.Utf8JsonReader` | The JSON reader. | +| `typeToConvert` | `System.Type` | The type to convert to. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + +#### Returns + +Type: `Mintlify.Core.Models.PrimaryNavigationConfig?` +A PrimaryNavigationConfig object. + +### Write + +Writes a PrimaryNavigationConfig object as JSON. + +#### Syntax + +```csharp +public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.PrimaryNavigationConfig value, System.Text.Json.JsonSerializerOptions options) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `writer` | `System.Text.Json.Utf8JsonWriter` | The JSON writer. | +| `value` | `Mintlify.Core.Models.PrimaryNavigationConfig` | The PrimaryNavigationConfig object to write. | +| `options` | `System.Text.Json.JsonSerializerOptions` | The serializer options. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ProductConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ProductConfig.mdx new file mode 100644 index 0000000..a6f01c8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ProductConfig.mdx @@ -0,0 +1,371 @@ +--- +title: ProductConfig +description: "Represents a product configuration in Mintlify navigation." +icon: file-brackets-curly +keywords: ['ProductConfig', 'Mintlify.Core.Models.ProductConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationContainerBase'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** Mintlify.Core.Models.NavigationContainerBase + +## Syntax + +```csharp +Mintlify.Core.Models.ProductConfig +``` + +## Summary + +Represents a product configuration in Mintlify navigation. + +## Remarks + +Products separate documentation into distinct product-specific sections. + The product name is required. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ProductConfig() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +#### Syntax + +```csharp +protected NavigationContainerBase() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +#### Syntax + +```csharp +protected NavigationItemBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### AsyncApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Description + +Gets or sets the description of the product. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Provides additional context about the product section. + +### Groups Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the groups for this navigation container. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Groups organize pages into labeled sections within this navigation container. + +### Hidden Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this navigation item will not be displayed in the navigation by default. + +### Href Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the URL or path for this navigation container. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be used to link to an external URL or specify a path for this container. + +### Icon Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the icon to be displayed in the section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +#### Remarks + +Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, + URL to an externally hosted icon, or path to an icon file in your project. + +### OpenApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Pages Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the pages for this navigation item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. + +### Product + +Gets or sets the name of the product. + +#### Syntax + +```csharp +public string Product { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that appears as the product label in navigation. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/RedirectConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/RedirectConfig.mdx new file mode 100644 index 0000000..8e0f4d2 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/RedirectConfig.mdx @@ -0,0 +1,233 @@ +--- +title: RedirectConfig +description: "Represents a URL redirect configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['RedirectConfig', 'Mintlify.Core.Models.RedirectConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.RedirectConfig +``` + +## Summary + +Represents a URL redirect configuration for the Mintlify documentation site. + +## Remarks + +This configuration defines how requests to specific paths should be redirected + to different URLs, useful for maintaining backward compatibility or reorganizing content. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public RedirectConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Destination + +Gets or sets the destination path where requests should be redirected. + +#### Syntax + +```csharp +public string Destination { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Specifies where users should be redirected when they visit the source path. + Can be a relative path (e.g., "/new-page") or an absolute URL + (e.g., "https://example.com/page"). This is a required field. + +### Permanent + +Gets or sets whether the redirect is permanent (301) or temporary (302). + +#### Syntax + +```csharp +public System.Nullable Permanent { get; set; } +``` + +#### Property Value + +Type: `System.Nullable` + +#### Remarks + +When true, returns a 301 (Moved Permanently) status code, indicating to search + engines that the move is permanent. When false or not specified, returns a 302 + (Found) status code for temporary redirects. Permanent redirects are better for SEO + when content has permanently moved. + +### Source + +Gets or sets the source path that should be redirected. + +#### Syntax + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +Specifies the original path that users might visit. When a request is made + to this path, it will be automatically redirected to the destination. + Should be a relative path starting with "/" (e.g., "/old-page"). This is a required field. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/SearchConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/SearchConfig.mdx new file mode 100644 index 0000000..0a6542e --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/SearchConfig.mdx @@ -0,0 +1,191 @@ +--- +title: SearchConfig +description: "Represents the search functionality configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['SearchConfig', 'Mintlify.Core.Models.SearchConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.SearchConfig +``` + +## Summary + +Represents the search functionality configuration for the Mintlify documentation site. + +## Remarks + +This configuration controls the appearance and behavior of the search feature, + including placeholder text and search display settings. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public SearchConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Prompt + +Gets or sets the placeholder text displayed in the search input field. + +#### Syntax + +```csharp +public string Prompt { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +This text appears in the search bar when it's empty, providing guidance + to users about what they can search for. Should be concise and helpful. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/SeoConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/SeoConfig.mdx new file mode 100644 index 0000000..8f25048 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/SeoConfig.mdx @@ -0,0 +1,212 @@ +--- +title: SeoConfig +description: "Represents the SEO (Search Engine Optimization) configuration for the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['SeoConfig', 'Mintlify.Core.Models.SeoConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.SeoConfig +``` + +## Summary + +Represents the SEO (Search Engine Optimization) configuration for the Mintlify documentation site. + +## Remarks + +This configuration controls how search engines index and display the documentation, + including meta tags and indexing behavior. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public SeoConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Indexing + +Gets or sets which pages should be indexed by search engines. + +#### Syntax + +```csharp +public string Indexing { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Valid values are "navigable" (only pages in navigation) or "all" (all pages). + The "navigable" setting indexes only pages that appear in the site navigation, + while "all" indexes every page in the documentation. Defaults to "navigable". + +### Metatags + +Gets or sets custom meta tags to be added to every page. + +#### Syntax + +```csharp +public System.Collections.Generic.Dictionary Metatags { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.Dictionary?` + +#### Remarks + +Each key-value pair represents a meta tag name and its content. + These tags are included in the HTML head section of all pages + to provide additional information to search engines. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ServerConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ServerConfig.mdx new file mode 100644 index 0000000..a45a72a --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/ServerConfig.mdx @@ -0,0 +1,224 @@ +--- +title: ServerConfig +description: "Represents a server configuration for API endpoints." +icon: file-brackets-curly +keywords: ['ServerConfig', 'Mintlify.Core.Models.ServerConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.ServerConfig +``` + +## Summary + +Represents a server configuration for API endpoints. + +## Remarks + +Server configurations can be simple URL strings or arrays of URLs for multiple endpoints. + This is used specifically for MDX server configurations and API playground base URLs. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public ServerConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Url + +Gets or sets the single server URL. + +#### Syntax + +```csharp +public string Url { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Used when only a single server URL is specified. + +### Urls + +Gets or sets the list of server URLs. + +#### Syntax + +```csharp +public System.Collections.Generic.List Urls { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Used when multiple server URLs are provided. + Not serialized directly as it's handled by the converter. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Override + +Returns the string representation of the server configuration. + +#### Syntax + +```csharp +public override string ToString() +``` + +#### Returns + +Type: `string` +The primary URL or empty string. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/StylingConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/StylingConfig.mdx new file mode 100644 index 0000000..8d7e737 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/StylingConfig.mdx @@ -0,0 +1,213 @@ +--- +title: StylingConfig +description: "Represents the styling configuration for various UI elements in the Mintlify documentation site." +icon: file-brackets-curly +keywords: ['StylingConfig', 'Mintlify.Core.Models.StylingConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.StylingConfig +``` + +## Summary + +Represents the styling configuration for various UI elements in the Mintlify documentation site. + +## Remarks + +This configuration controls the visual styling of specific components such as + breadcrumbs, section eyebrows, and code blocks throughout the documentation. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public StylingConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Codeblocks + +Gets or sets the code block theme. + +#### Syntax + +```csharp +public string Codeblocks { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Valid values are "system" or "dark". The "system" option uses a theme that + matches the current light/dark mode, while "dark" always uses a dark theme + for code blocks regardless of the site's appearance mode. Defaults to "system". + +### Eyebrows + +Gets or sets the eyebrows style for content sections. + +#### Syntax + +```csharp +public string Eyebrows { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Valid values are "section" or "breadcrumbs". This controls the style of the + small text that appears above page titles and section headers. "section" shows + the current section name, while "breadcrumbs" shows the full navigation path. + Defaults to "section". + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/TabConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/TabConfig.mdx new file mode 100644 index 0000000..fdff75c --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/TabConfig.mdx @@ -0,0 +1,519 @@ +--- +title: TabConfig +description: "Represents a tab configuration in Mintlify navigation." +icon: file-brackets-curly +keywords: ['TabConfig', 'Mintlify.Core.Models.TabConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationSectionBase'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** Mintlify.Core.Models.NavigationSectionBase + +## Syntax + +```csharp +Mintlify.Core.Models.TabConfig +``` + +## Summary + +Represents a tab configuration in Mintlify navigation. + +## Remarks + +Tabs provide top-level navigation sections in your documentation. + The tab name is required. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public TabConfig() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +#### Syntax + +```csharp +protected NavigationSectionBase() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +#### Syntax + +```csharp +protected NavigationContainerBase() +``` + +### .ctor Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +#### Syntax + +```csharp +protected NavigationItemBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchors + +Gets or sets the anchors for the tab. + +#### Syntax + +```csharp +public System.Collections.Generic.List Anchors { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Anchors provide persistent navigation items at the top of the sidebar. + +### AsyncApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to AsyncAPI specification files. + +### Color Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the color configuration for this navigation section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ColorPairConfig Color { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ColorPairConfig?` + +#### Remarks + +Defines the primary and secondary colors used for this section's visual styling. + +### Description Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the description of this navigation section. + +#### Syntax + +```csharp +public string Description { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Provides additional descriptive text about this navigation section. + +### Dropdowns Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the dropdowns for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Dropdowns { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Dropdowns create expandable menu sections within this navigation section. + +### Global Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets global navigation items that appear on all sections and pages. + +#### Syntax + +```csharp +public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.GlobalNavigationConfig?` + +#### Remarks + +Global navigation items persist across different tabs and pages for consistent navigation. + +### Groups Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the groups for this navigation container. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Groups organize pages into labeled sections within this navigation container. + +### Hidden Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +#### Remarks + +When true, this navigation item will not be displayed in the navigation by default. + +### Href Inherited + +Inherited from `Mintlify.Core.Models.NavigationContainerBase` + +Gets or sets the URL or path for this navigation container. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +#### Remarks + +Can be used to link to an external URL or specify a path for this container. + +### Icon Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the icon to be displayed in the section. + +#### Syntax + +```csharp +public Mintlify.Core.Models.IconConfig Icon { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.IconConfig?` + +#### Remarks + +Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, + URL to an externally hosted icon, or path to an icon file in your project. + +### Languages Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the languages for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Languages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows partitioning navigation into different language-specific versions. + +### Menu + +Gets or sets the menu items for the tab. + +#### Syntax + +```csharp +public System.Collections.Generic.List Menu { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Menu items create a dropdown menu within the tab navigation. + +### OpenApi Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.ApiSpecConfig?` + +#### Remarks + +Can be a string URL, an array of URLs, or an object with source and directory properties + pointing to OpenAPI specification files. + +### Pages Inherited + +Inherited from `Mintlify.Core.Models.NavigationItemBase` + +Gets or sets the pages for this navigation item. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. + +### Tab + +Gets or sets the name of the tab. + +#### Syntax + +```csharp +public string Tab { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that appears as the tab label in navigation. + +### Versions Inherited + +Inherited from `Mintlify.Core.Models.NavigationSectionBase` + +Gets or sets the versions for this navigation section. + +#### Syntax + +```csharp +public System.Collections.Generic.List Versions { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +#### Remarks + +Allows partitioning navigation into different version-specific documentation. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/VersionConfig.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/VersionConfig.mdx new file mode 100644 index 0000000..a0cc5b7 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/VersionConfig.mdx @@ -0,0 +1,358 @@ +--- +title: VersionConfig +description: "Represents a version configuration in Mintlify navigation." +icon: file-brackets-curly +keywords: ['VersionConfig', 'Mintlify.Core.Models.VersionConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] +--- + +## Definition + +**Assembly:** Mintlify.Core.dll + +**Namespace:** Mintlify.Core.Models + +**Inheritance:** System.Object + +## Syntax + +```csharp +Mintlify.Core.Models.VersionConfig +``` + +## Summary + +Represents a version configuration in Mintlify navigation. + +## Remarks + +Versions allow you to maintain multiple documentation versions. + The version name is required. + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public VersionConfig() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### Anchors + +Gets or sets the anchors for the version. + +#### Syntax + +```csharp +public System.Collections.Generic.List Anchors { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### AsyncApi + +Gets or sets the AsyncAPI configuration. + +#### Syntax + +```csharp +public object AsyncApi { get; set; } +``` + +#### Property Value + +Type: `object?` + +### Default + +Gets or sets whether this version is the default version. + +#### Syntax + +```csharp +public System.Nullable Default { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +### Dropdowns + +Gets or sets the dropdowns for the version. + +#### Syntax + +```csharp +public System.Collections.Generic.List Dropdowns { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Global + +Gets or sets the global navigation configuration. + +#### Syntax + +```csharp +public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } +``` + +#### Property Value + +Type: `Mintlify.Core.Models.GlobalNavigationConfig?` + +### Groups + +Gets or sets the groups for the version. + +#### Syntax + +```csharp +public System.Collections.Generic.List Groups { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Hidden + +Gets or sets whether the current option is default hidden. + +#### Syntax + +```csharp +public System.Nullable Hidden { get; set; } +``` + +#### Property Value + +Type: `System.Nullable?` + +### Href + +Gets or sets the URL or path for the version. + +#### Syntax + +```csharp +public string Href { get; set; } +``` + +#### Property Value + +Type: `string?` + +### Languages + +Gets or sets the languages for the version. + +#### Syntax + +```csharp +public System.Collections.Generic.List Languages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### OpenApi + +Gets or sets the OpenAPI configuration. + +#### Syntax + +```csharp +public object OpenApi { get; set; } +``` + +#### Property Value + +Type: `object?` + +### Pages + +Gets or sets the pages for the version. + +#### Syntax + +```csharp +public System.Collections.Generic.List Pages { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Tabs + +Gets or sets the tabs for the version. + +#### Syntax + +```csharp +public System.Collections.Generic.List Tabs { get; set; } +``` + +#### Property Value + +Type: `System.Collections.Generic.List?` + +### Version + +Gets or sets the name of the version. + +#### Syntax + +```csharp +public string Version { get; set; } +``` + +#### Property Value + +Type: `string` + +#### Remarks + +This is a required field that identifies the version. + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/index.mdx new file mode 100644 index 0000000..9dbf76a --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/Models/index.mdx @@ -0,0 +1,72 @@ +--- +title: Overview +description: "Summary of the Mintlify.Core.Models Namespace" +icon: folder-tree +mode: wide +keywords: ['Mintlify.Core.Models', 'namespace', 'AnchorConfig', 'ApiConfig', 'ApiExamplesConfig', 'ApiParamsConfig', 'ApiPlaygroundConfig', 'ApiSpecConfig', 'AppearanceConfig', 'BackgroundConfig', 'BackgroundImageConfig', 'BannerConfig'] +--- + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [AnchorConfig](/test/api-reference/Mintlify/Core/Models/AnchorConfig) | Represents an anchor configuration in Mintlify navigation. | +| [ApiConfig](/test/api-reference/Mintlify/Core/Models/ApiConfig) | Represents the API reference configuration and playground settings for Mintlify. | +| [ApiExamplesConfig](/test/api-reference/Mintlify/Core/Models/ApiExamplesConfig) | Represents the configuration for autogenerated API examples in the documentation. | +| [ApiParamsConfig](/test/api-reference/Mintlify/Core/Models/ApiParamsConfig) | Represents the display settings for API parameters in the documentation. | +| [ApiPlaygroundConfig](/test/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig) | Represents the API playground settings for interactive documentation. | +| [ApiSpecConfig](/test/api-reference/Mintlify/Core/Models/ApiSpecConfig) | Represents an API specification configuration for OpenAPI or AsyncAPI. | +| [AppearanceConfig](/test/api-reference/Mintlify/Core/Models/AppearanceConfig) | Represents the appearance configuration for light and dark mode settings in Mintlify. | +| [BackgroundConfig](/test/api-reference/Mintlify/Core/Models/BackgroundConfig) | Represents the background configuration for the Mintlify documentation site. | +| [BackgroundImageConfig](/test/api-reference/Mintlify/Core/Models/BackgroundImageConfig) | Represents a background image configuration in Mintlify. | +| [BannerConfig](/test/api-reference/Mintlify/Core/Models/BannerConfig) | Represents the banner configuration for displaying announcements or notifications in the Mintlify documentation site. | +| [ColorConfig](/test/api-reference/Mintlify/Core/Models/ColorConfig) | Represents a color configuration for Mintlify. Can be a simple hex color string or a complex color pair configuration with light and dark modes. | +| [ColorPairConfig](/test/api-reference/Mintlify/Core/Models/ColorPairConfig) | Represents a color pair configuration for light and dark modes. | +| [ColorsConfig](/test/api-reference/Mintlify/Core/Models/ColorsConfig) | Represents the color configuration for Mintlify themes. | +| [ContextualConfig](/test/api-reference/Mintlify/Core/Models/ContextualConfig) | Represents the contextual options configuration for the Mintlify documentation site. | +| [DocsJsonConfig](/test/api-reference/Mintlify/Core/Models/DocsJsonConfig) | Represents the root configuration object for Mintlify docs.json. | +| [DropdownConfig](/test/api-reference/Mintlify/Core/Models/DropdownConfig) | Represents a dropdown configuration in Mintlify navigation. | +| [Error404Config](/test/api-reference/Mintlify/Core/Models/Error404Config) | Represents the configuration for 404 (Not Found) error handling in the Mintlify documentation site. | +| [ErrorsConfig](/test/api-reference/Mintlify/Core/Models/ErrorsConfig) | Represents the error pages configuration for the Mintlify documentation site. | +| [FaviconConfig](/test/api-reference/Mintlify/Core/Models/FaviconConfig) | Represents the favicon configuration for Mintlify. Can be a single file or separate files for light and dark mode. | +| [FaviconConfigJsonConverter](/test/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter) | Custom JSON converter for FaviconConfig that supports both string and object formats. | +| [FontsConfig](/test/api-reference/Mintlify/Core/Models/FontsConfig) | Represents the font configuration for the Mintlify documentation site. | +| [FooterConfig](/test/api-reference/Mintlify/Core/Models/FooterConfig) | Represents the footer configuration for Mintlify. | +| [FooterLinkGroup](/test/api-reference/Mintlify/Core/Models/FooterLinkGroup) | Represents a group of footer links. | +| [FooterLink](/test/api-reference/Mintlify/Core/Models/FooterLink) | Represents a footer link. | +| [FrontMatterConfig](/test/api-reference/Mintlify/Core/Models/FrontMatterConfig) | Represents frontmatter configuration for Mintlify documentation pages. | +| [GlobalAnchorConfig](/test/api-reference/Mintlify/Core/Models/GlobalAnchorConfig) | Represents an anchor configuration for global navigation in the Mintlify documentation site. | +| [GlobalDropdownConfig](/test/api-reference/Mintlify/Core/Models/GlobalDropdownConfig) | Represents a dropdown configuration for global navigation in the Mintlify documentation site. | +| [GlobalLanguageConfig](/test/api-reference/Mintlify/Core/Models/GlobalLanguageConfig) | Represents a language configuration for global navigation in the Mintlify documentation site. | +| [GlobalNavigationConfig](/test/api-reference/Mintlify/Core/Models/GlobalNavigationConfig) | Represents global navigation configuration that appears on all sections and pages. | +| [GlobalTabConfig](/test/api-reference/Mintlify/Core/Models/GlobalTabConfig) | Represents a tab configuration for global navigation in the Mintlify documentation site. | +| [GlobalVersionConfig](/test/api-reference/Mintlify/Core/Models/GlobalVersionConfig) | Represents a version configuration for global navigation in the Mintlify documentation site. | +| [GroupConfig](/test/api-reference/Mintlify/Core/Models/GroupConfig) | Represents a group configuration in Mintlify navigation. | +| [IconConfig](/test/api-reference/Mintlify/Core/Models/IconConfig) | Represents an icon configuration in Mintlify. | +| [IconsConfig](/test/api-reference/Mintlify/Core/Models/IconsConfig) | Represents the icon library configuration for the Mintlify documentation site. | +| [IntegrationsConfig](/test/api-reference/Mintlify/Core/Models/IntegrationsConfig) | Represents the integrations configuration for third-party services in the Mintlify documentation site. | +| [InteractionConfig](/test/api-reference/Mintlify/Core/Models/InteractionConfig) | Represents the interaction configuration for navigation elements in Mintlify. | +| [LanguageConfig](/test/api-reference/Mintlify/Core/Models/LanguageConfig) | Represents a language configuration in Mintlify navigation. | +| [LogoConfig](/test/api-reference/Mintlify/Core/Models/LogoConfig) | Represents the logo configuration for Mintlify. Can be a single image path for both light and dark mode, or separate paths for each mode. | +| [MdxConfig](/test/api-reference/Mintlify/Core/Models/MdxConfig) | Represents the MDX configuration for API pages generated from MDX files. | +| [MdxAuthConfig](/test/api-reference/Mintlify/Core/Models/MdxAuthConfig) | Represents the authentication configuration for MDX-based API documentation. | +| [MenuConfig](/test/api-reference/Mintlify/Core/Models/MenuConfig) | Represents a menu item configuration in Mintlify navigation. | +| [MergeOptions](/test/api-reference/Mintlify/Core/Models/MergeOptions) | Defines merging as combining two navigation structures into one integrated structure. Options control how different aspects of the merge are handled. | +| [NavbarConfig](/test/api-reference/Mintlify/Core/Models/NavbarConfig) | Represents the navigation bar configuration for the Mintlify documentation site. | +| [NavbarLink](/test/api-reference/Mintlify/Core/Models/NavbarLink) | Represents a navigation link in the Mintlify navbar. | +| [NavigationConfig](/test/api-reference/Mintlify/Core/Models/NavigationConfig) | Represents the navigation configuration for Mintlify. | +| [NavigationContainerBase](/test/api-reference/Mintlify/Core/Models/NavigationContainerBase) | Base class for navigation items that can contain groups and have external links. | +| [NavigationItemBase](/test/api-reference/Mintlify/Core/Models/NavigationItemBase) | Base class for all navigation items in Mintlify. | +| [NavigationSectionBase](/test/api-reference/Mintlify/Core/Models/NavigationSectionBase) | Base class for top-level navigation sections (tabs, anchors, dropdowns). | +| [PrimaryNavigationConfig](/test/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig) | Represents the primary navigation configuration for Mintlify navbar. Can be a button configuration or a GitHub configuration. | +| [ProductConfig](/test/api-reference/Mintlify/Core/Models/ProductConfig) | Represents a product configuration in Mintlify navigation. | +| [RedirectConfig](/test/api-reference/Mintlify/Core/Models/RedirectConfig) | Represents a URL redirect configuration for the Mintlify documentation site. | +| [SearchConfig](/test/api-reference/Mintlify/Core/Models/SearchConfig) | Represents the search functionality configuration for the Mintlify documentation site. | +| [SeoConfig](/test/api-reference/Mintlify/Core/Models/SeoConfig) | Represents the SEO (Search Engine Optimization) configuration for the Mintlify documentation site. | +| [ServerConfig](/test/api-reference/Mintlify/Core/Models/ServerConfig) | Represents a server configuration for API endpoints. | +| [StylingConfig](/test/api-reference/Mintlify/Core/Models/StylingConfig) | Represents the styling configuration for various UI elements in the Mintlify documentation site. | +| [TabConfig](/test/api-reference/Mintlify/Core/Models/TabConfig) | Represents a tab configuration in Mintlify navigation. | +| [VersionConfig](/test/api-reference/Mintlify/Core/Models/VersionConfig) | Represents a version configuration in Mintlify navigation. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/index.mdx new file mode 100644 index 0000000..10d58dd --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/Mintlify/Core/index.mdx @@ -0,0 +1,37 @@ +--- +title: Overview +description: "Summary of the Mintlify.Core Namespace" +icon: folder-tree +mode: wide +keywords: ['Mintlify.Core', 'namespace', 'DocsJsonManager', 'DocsJsonValidator', 'MintlifyConstants', 'MintlifyOptions'] +--- + + + + +## Summary + +Mintlify.Core is a comprehensive .NET library for working with Mintlify documentation configuration files (`docs.json`). This package provides robust loading, +validation, manipulation, and generation capabilities for Mintlify documentation projects. + +## Types + +### Classes + +| Name | Summary | +| ---- | ------- | +| [DocsJsonManager](/test/api-reference/Mintlify/Core/DocsJsonManager) | Loads and manages Mintlify docs.json configuration files with navigation manipulation capabilities. | +| [DocsJsonValidator](/test/api-reference/Mintlify/Core/DocsJsonValidator) | Validates Mintlify docs.json configuration against the official schema requirements. | +| [MintlifyConstants](/test/api-reference/Mintlify/Core/MintlifyConstants) | Contains constants and shared configuration objects for Mintlify documentation generation. | +| [MintlifyOptions](/test/api-reference/Mintlify/Core/MintlifyOptions) | Configuration options for Mintlify documentation generation. | + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/index.mdx new file mode 100644 index 0000000..002bbaf --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/api-reference/index.mdx @@ -0,0 +1,20 @@ +--- +title: Overview +icon: cubes +mode: wide +--- + +## Namespaces + +- [CloudNimble.DotNetDocs.Core](CloudNimble/DotNetDocs/Core) +- [CloudNimble.DotNetDocs.Core.Configuration](CloudNimble/DotNetDocs/Core/Configuration) +- [CloudNimble.DotNetDocs.Core.Renderers](CloudNimble/DotNetDocs/Core/Renderers) +- [CloudNimble.DotNetDocs.Core.Renderers.YamlConverters](CloudNimble/DotNetDocs/Core/Renderers/YamlConverters) +- [CloudNimble.DotNetDocs.Core.Transformers](CloudNimble/DotNetDocs/Core/Transformers) +- [Microsoft.Extensions.DependencyInjection](Microsoft/Extensions/DependencyInjection) +- [CloudNimble.DotNetDocs.Mintlify](CloudNimble/DotNetDocs/Mintlify) +- [CloudNimble.DotNetDocs.Mintlify.Transformers](CloudNimble/DotNetDocs/Mintlify/Transformers) +- [Mintlify.Core](Mintlify/Core) +- [Mintlify.Core.Converters](Mintlify/Core/Converters) +- [Mintlify.Core.Models](Mintlify/Core/Models) +- [Mintlify.Core.Models.Integrations](Mintlify/Core/Models/Integrations) diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/apple-touch-icon.png b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/apple-touch-icon.png new file mode 100644 index 0000000..925289f Binary files /dev/null and b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/apple-touch-icon.png differ diff --git a/src/CloudNimble.DotNetDocs.Docs/guides/cli-reference.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/cli-reference.mdx similarity index 98% rename from src/CloudNimble.DotNetDocs.Docs/guides/cli-reference.mdx rename to samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/cli-reference.mdx index aedbd09..2eb058c 100644 --- a/src/CloudNimble.DotNetDocs.Docs/guides/cli-reference.mdx +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/cli-reference.mdx @@ -607,15 +607,15 @@ For solutions with multiple projects: ## See Also - + Use MSBuild SDK for integrated documentation builds - + Understand how documentation generation works - + Learn about Mintlify-enhanced documentation diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/collections.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/collections.mdx new file mode 100644 index 0000000..f830155 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/collections.mdx @@ -0,0 +1,754 @@ +--- +title: Documentation Collections +sidebarTitle: Collections +description: Combine multiple documentation projects into unified portals +icon: layer-group +--- + +## Overview + +Documentation Collections allow you to combine multiple independent `.docsproj` projects into a single unified documentation portal. This feature is perfect for: + +- **Microservices**: Create a single portal for all services in your architecture +- **Multi-Product Suites**: Unify documentation across separate open-source products +- **Modular Systems**: Combine documentation from independently maintained modules + +Collections work by **copying documentation files** from referenced projects and **combining their navigation structures** into a single cohesive experience. + + + Collections are currently supported for Mintlify documentation only. Support for other documentation formats may be added in future releases. + + +## How Collections Work + +The collection `.docsproj` is a **normal, first-class documentation project** that: + +1. Has its own assemblies to document (or none at all) +2. Has its own conceptual content and guides +3. Has its own branding and theme configuration +4. Generates its own documentation using the standard pipeline + +After the collection completes its normal documentation generation, DotNetDocs: + +1. **Copies** markdown files from referenced projects into the collection's folder structure +2. **Loads** each referenced project's `docs.json` navigation file +3. **Applies** URL prefixes to navigation paths +4. **Combines** navigation into the collection's Tabs or Products arrays +5. **Saves** the final `docs.json` once with everything integrated + + + No complex merging logic or priorities neededjust copy files and combine navigation. This "Easy As Fuck"" design keeps collections simple and predictable. + + +## Configuration + +### Using DocumentationReference + +Add `` items to your collection's `.docsproj` file, similar to how you use ``: + + +```xml Current (1.0.2) + + + Mintlify + true + + + + + + + + +``` + +```xml Preview (1.1.0-preview.1) + + + Mintlify + true + + + + + + + + +``` + + +### Required Attributes + + + Relative or absolute path to the referenced `.docsproj` file. + + ```xml + + ``` + + + + URL path where the referenced documentation will be accessible. This becomes the URL prefix for all documentation from this reference. + + ```xml + DestinationPath="services/user-service" + ``` + + Files from the referenced project appear at URLs like: + - `services/user-service/api-reference/...` + - `services/user-service/guides/...` + + +### Optional Attributes + + + How the reference's navigation is integrated into the collection. Supported values: + + - `Tabs` - Adds as a top-level tab in Mintlify navigation + - `Products` - Adds as a product in Mintlify's multi-product navigation + + ```xml + IntegrationType="Tabs" + ``` + + + + Custom display name for this documentation in navigation. If not specified, the project file name (without extension) will be used. + + ```xml + Name="User Management Service" + ``` + + This is especially useful when project file names aren't user-friendly (e.g., `ServiceA.docsproj` can display as "Authentication Service"). + + +## Integration Types + +Mintlify supports two ways to integrate referenced documentation into your navigation structure. + +### Tabs Integration + +Tabs appear as top-level navigation items in your documentation site. This is the default integration type. + +```xml + + + + +``` + +**Result in `docs.json`**: +```json +{ + "name": "Microservices Platform", + "tabs": [ + { + "tab": "User Management", + "href": "services/users", + "pages": [ + "services/users/introduction", + "services/users/api-reference/overview", + ... + ] + }, + { + "tab": "Order Processing", + "href": "services/orders", + "pages": [ + "services/orders/introduction", + "services/orders/api-reference/overview", + ... + ] + } + ] +} +``` + + + If you omit the `Name` attribute, the project file name is used (e.g., "UserService" and "OrderService"). + + +### Products Integration + +Products are designed for multi-product documentation portals where each product has its own complete documentation set. + +```xml + + + + + +``` + +**Result in `docs.json`**: +```json +{ + "name": "EasyAF Product Suite", + "navigation": { + "products": [ + { + "product": "EasyAF Core", + "href": "core", + "pages": [...], + "groups": [...] + }, + { + "product": "HTTP Client", + "href": "http", + "pages": [...], + "groups": [...] + }, + { + "product": "Validation Framework", + "href": "validation", + "pages": [...], + "groups": [...] + } + ] + } +} +``` + +## Complete Examples + +### Example 1: Microservices Portal + +Create a unified documentation portal for a microservices architecture: + +**File**: `docs/MicroservicesPlatform.docsproj` + + +```xml Current (1.0.2) + + + + Mintlify + false + + + + Microservices Platform + quill + + #0066CC + + + + + + + + + + + + +``` + +```xml Preview (1.1.0-preview.1) + + + + Mintlify + false + + + + Microservices Platform + quill + + #0066CC + + + + + + + + + + + + +``` + + +**Resulting Structure**: +``` +docs/ + introduction.md # Collection's own introduction + architecture.md # Collection's own architecture guide + services/ +  users/ # UserService documentation +   introduction.md +   api-reference/ +  orders/ # OrderService documentation +   introduction.md +   api-reference/ +  payments/ # PaymentService documentation +  notifications/ # NotificationService documentation + docs.json # Combined navigation +``` + +### Example 2: Multi-Product Suite + +Create a unified portal for related open-source products: + +**File**: `docs/EasyAF.Portal.docsproj` + + +```xml Current (1.0.2) + + + Mintlify + + EasyAF Product Suite + maple + + + + + + + + + + +``` + +```xml Preview (1.1.0-preview.1) + + + Mintlify + + EasyAF Product Suite + maple + + + + + + + + + + +``` + + +### Example 3: Hybrid Collection + +A collection that documents its own assemblies AND references external documentation: + + +```xml Current (1.0.2) + + + + Mintlify + true + Folder + + + + + + + + +``` + +```xml Preview (1.1.0-preview.1) + + + + Mintlify + true + Folder + + + + + + + + +``` + + +## Validation and Safety + +DotNetDocs validates references during the build process to ensure everything works correctly. + +### Build-Time Validation + +The `DocumentationReferenceResolverTask` checks: + +1. **Project Exists**: The referenced `.docsproj` file must exist +2. **Documentation Type Match**: Referenced projects must use the same `DocumentationType` as the collection +3. **Outputs Exist**: The referenced project must have generated documentation +4. **Navigation File Exists**: For Mintlify projects, `docs.json` must exist + +### Type Mismatch Warnings + +If you try to reference a project with a different `DocumentationType`, you'll see a warning: + +``` +� Skipping documentation reference 'ServiceA.docsproj' because it uses 'DocFX' format. +Only 'Mintlify' documentation can be combined with Mintlify collections. +Cross-format documentation combination is not currently supported. +``` + +The reference will be skipped, but the build continues successfully. + + + Build the referenced projects **before** building the collection. The collection copies existing documentation outputsit doesn't build referenced projects automatically. + + +## URL Prefixes and Navigation + +DotNetDocs automatically applies URL prefixes to all navigation paths when combining referenced documentation. + +### How Prefixes Work + +Given this reference: +```xml + +``` + +**Original navigation** in `ServiceA/docs.json`: +```json +{ + "pages": [ + "introduction", + "api-reference/overview", + { + "group": "API Reference", + "pages": [ + "api-reference/classes/user", + "api-reference/classes/order" + ] + } + ] +} +``` + +**After prefix application** in collection: +```json +{ + "pages": [ + "services/service-a/introduction", + "services/service-a/api-reference/overview", + { + "group": "API Reference", + "pages": [ + "services/service-a/api-reference/classes/user", + "services/service-a/api-reference/classes/order" + ] + } + ] +} +``` + +### Deep Prefix Application + +URL prefixes are applied **recursively** at all nesting levels: + +- **String pages**: Direct path strings +- **Groups**: Pages inside navigation groups +- **Tabs**: Pages inside nested tabs +- **Dropdowns**: Pages inside dropdown menus + +This ensures all links work correctly regardless of navigation structure complexity. + +## File Copying Behavior + +DotNetDocs copies documentation files based on the referenced project's `DocumentationType`. + +### Mintlify File Patterns + +For Mintlify references, these patterns are copied: +- `*.md`, `*.mdx`, `*.mdz` - All markdown files +- `images/**/*` - All images +- `logo/**/*` - Logo assets + +### Conflict Resolution + +If the same file exists in both the collection and a reference: + + + **Collection wins**: The collection's file is kept, and the referenced file is skipped. This allows the collection to override content from references. + + +This is intentionalcollections can provide their own versions of files to customize the experience. + +## Build Process + +Understanding the build order helps troubleshoot issues: + + + + Build each referenced `.docsproj` first. This generates their documentation outputs. + + ```bash + dotnet build ServiceA/ServiceA.docsproj --configuration Release + dotnet build ServiceB/ServiceB.docsproj --configuration Release + ``` + + + + Build the collection `.docsproj`. It validates references, copies files, and combines navigation. + + ```bash + dotnet build MicroservicesPlatform.docsproj --configuration Release + ``` + + + + The SDK validates that: + - Referenced projects exist + - Documentation types match + - Documentation outputs are available + + + + The collection generates its own documentation (if `GenerateDocumentation=true`). + + + + Files from referenced projects are copied to `DestinationPath` locations. + + + + The `MintlifyRenderer` combines navigation from all references into the collection's `docs.json`. + + + + The final `docs.json` is saved once with everything combined. + + + +## Troubleshooting + +### "Referenced project not found" + +**Problem**: The `.docsproj` path is incorrect or the file doesn't exist. + +**Solution**: Verify the path in your `DocumentationReference` is correct. Use relative paths from the collection `.docsproj` location. + +### "Documentation root does not exist" + +**Problem**: The referenced project hasn't been built yet, so its documentation outputs don't exist. + +**Solution**: Build referenced projects before building the collection: + +```bash +# Build dependencies first +dotnet build ServiceA/ServiceA.docsproj +dotnet build ServiceB/ServiceB.docsproj + +# Then build collection +dotnet build MicroservicesPlatform.docsproj +``` + +### "Skipping documentation reference... uses different format" + +**Problem**: The referenced project uses a different `DocumentationType` than the collection. + +**Solution**: Ensure all referenced projects use the same documentation type. Collections can only combine documentation of the same format (currently Mintlify only). + +### Missing navigation or broken links + +**Problem**: URL prefixes aren't being applied correctly, or files aren't being copied. + +**Solution**: +1. Check that `DestinationPath` matches where files are actually copied +2. Verify the referenced project's `docs.json` exists and is valid JSON +3. Rebuild both the references and collection from scratch + +## Best Practices + +```noescape + + + Always build referenced projects before building the collection. Use solution build order or explicit build scripts. + + + + Organize `DestinationPath` consistently (e.g., all services under `services/`, all plugins under `plugins/`). + + + + Avoid circular references or overly complex reference chains. Keep your dependency graph flat and straightforward. + + + + When releasing, ensure referenced projects and collections use compatible versions of DotNetDocs.Sdk. + + + + Each referenced project should work standalone before being added to a collection. Test them independently first. + + + + Add a `README.md` or introduction page explaining the collection structure and how projects relate to each other. + + +``` + +## Limitations + +Current limitations of Documentation Collections: + +1. **Mintlify Only**: Collections currently only work with Mintlify documentation. Support for DocFX, MkDocs, etc. may be added later. + +2. **No Cross-Format**: You cannot combine Mintlify and DocFX documentation in the same collection. All references must use the same format. + +3. **Build-Time Only**: Collections are resolved at build time. You cannot dynamically add references at runtime. + +4. **No Transitive References**: If ProjectA references ProjectB, and you reference ProjectA in your collection, you don't automatically get ProjectB. Each reference must be explicit. + +5. **Single SDK Version**: All referenced projects should use the same (or compatible) versions of DotNetDocs.Sdk to ensure consistent behavior. + +## Technical Details + +For those interested in how collections work under the hood: + +```noescape + + + The `DocumentationReferenceResolverTask` runs during build to: + + 1. Load each referenced `.docsproj` file + 2. Extract `DocumentationRoot` and `DocumentationType` properties + 3. Validate that documentation outputs exist + 4. Populate `ResolvedDocumentationReference` items with metadata + + These resolved items are passed to `GenerateDocumentationTask`, which populates `ProjectContext.DocumentationReferences`. + + + + The `DocumentationManager.CopyReferencedDocumentationAsync()` method: + + 1. Iterates through each `DocumentationReference` + 2. Determines file patterns based on `DocumentationType` + 3. Copies files from `DocumentationRoot` to `DestinationPath` + 4. Skips files that already exist in the collection (collection wins) + + Copying happens **after** rendering completes. + + + + The `MintlifyRenderer.CombineReferencedNavigation()` method: + + 1. Loads each reference's `docs.json` using `DocsJsonManager` + 2. Applies URL prefix using `ApplyUrlPrefix(DestinationPath)` + 3. Adds navigation to `Tabs` or `Products` array based on `IntegrationType` + 4. Saves the combined `docs.json` once at the end + + This happens **inside** `RenderAsync()` before saving, not as a separate step. + + + + The `DocsJsonManager.ApplyUrlPrefix()` method recursively processes: + + - **String pages**: Prepends the prefix + - **GroupConfig.Pages**: Recursively processes nested pages + - **TabConfig.Pages**: Recursively processes nested pages + - **DropdownConfig.Pages**: Recursively processes nested pages + + This ensures URL prefixes are applied at **all** nesting levels for correct navigation. + + +``` + +## Next Steps + +```noescape + + + Learn about all available MSBuild properties for documentation projects + + + Deploy your collection to Mintlify, GitHub Pages, or other hosting platforms + + + Understand how the documentation pipeline processes assemblies and content + + + Deep dive into Mintlify-specific features and configuration + + +``` diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/conceptual-docs.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/conceptual-docs.mdx new file mode 100644 index 0000000..5cc36f1 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/conceptual-docs.mdx @@ -0,0 +1,897 @@ +--- +title: Conceptual Documentation +sidebarTitle: Conceptual Docs +description: Expanding your documentation experience with Conceptual Docs +icon: book +--- + +## What is Conceptual Documentation? + +Conceptual Documentation is DotNetDocs' system for enriching API reference documentation with rich, context-aware content that goes beyond what XML +documentation comments can provide. While XML comments describe **what** an API element is, conceptual documentation explains **how** to use it effectively. + +Conceptual documentation is inspired by best practices from major documentation platforms like [Microsoft Learn](https://learn.microsoft.com), +[Read the Docs](https://readthedocs.org), and [Mintlify](https://mintlify.com). It brings the power of rich, structured content to your .NET projects. + +Conceptual content is stored in separate `.mdz` files organized alongside your code, allowing technical writers and developers to collaborate +on comprehensive documentation without cluttering source files. + + + The `.mdz` file extension was chosen to avoid being picked up by documentation platforms that autiomatically look for `.md` or `.mdx` files. It + does not stand for anything in particular, except that if you have the file `index.md` and `index.mdx` and `index.mdz` in the same folder, + the `index.mdz` file will appear last in the list. + + +## How Conceptual Documentation Works + +DotNetDocs follows a two-phase documentation pipeline: + + + + The `AssemblyManager` extracts documentation from XML comments in your compiled assemblies, populating basic API metadata like summaries, + remarks, parameters, and return values. + + + + The `DocumentationManager` loads conceptual content from `.mdz` files in the configured `ConceptualPath` directory, enriching the documentation + model with usage guides, examples, best practices, patterns, and considerations. + + + +These two content sources are merged into a unified documentation model that renderers (like MintlifyRenderer) transform into beautiful, comprehensive +documentation sites. + +## Configuration + +### Enabling Conceptual Documentation + +Conceptual documentation is enabled by default in `ProjectContext`: + +```csharp +var context = new ProjectContext +{ + ConceptualPath = "conceptual", // Where .mdz files are stored + ConceptualDocsEnabled = true, // Enable conceptual docs (default: true) + ShowPlaceholders = true // Show placeholder content (default: true) +}; +``` + +### Configuration Properties + + + The directory where conceptual documentation files (`.mdz`) are stored, relative to the documentation root. + + + + When `true`, DotNetDocs generates placeholder files for new types and loads existing conceptual content. When `false`, only XML comments are processed. + + + + Controls whether placeholder content is included in the final documentation. See [Placeholders](#placeholders-and-the-showplaceholders-property) + section below. + + +## Conceptual Documentation Sections + +DotNetDocs supports seven distinct conceptual sections, each with a specific purpose. These sections are available at three levels: **namespace**, +**type**, and **member**. + +### Available Sections + + + + **File**: `summary.mdz` + **Level**: Namespace only + **Purpose**: Brief description of what the namespace contains and its purpose + + This section is only available at the namespace level since types and members already have summaries from XML `` tags. + + ```markdown + + This namespace contains core documentation processing types including assembly management, + entity models, and the transformation pipeline. + ``` + + + + **File**: `usage.mdz` + **Level**: Namespace, Type, Member + **Purpose**: Explains **how to use** the API element + + Usage documentation provides step-by-step guides for common scenarios. This is where you explain HOW developers should interact with your API. + + ```markdown + + ## Basic Usage + + To use the `DocumentationManager`, first create a `ProjectContext`: + + 1. Configure your project context with references + 2. Create the manager with enrichers, transformers, and renderers + 3. Call `ProcessAsync()` with your assembly paths + + The manager orchestrates the entire documentation pipeline automatically. + ``` + + + + **File**: `examples.mdz` + **Level**: Namespace, Type, Member + **Purpose**: Concrete code examples showing the API in action + + Examples should be complete, runnable code snippets that demonstrate real-world usage patterns. + + ```markdown + + ## Basic Example + + ```csharp + var context = new ProjectContext + { + ConceptualPath = "conceptual", + ShowPlaceholders = false + }; + + var manager = new DocumentationManager(context); + await manager.ProcessAsync("MyAssembly.dll", "MyAssembly.xml"); + ``` + + ## Advanced Example + + ```csharp + // Multi-assembly processing with custom configuration + var assemblies = new[] + { + ("Core.dll", "Core.xml"), + ("Extensions.dll", "Extensions.xml") + }; + + await manager.ProcessAsync(assemblies); + ``` + ``` + + + + **File**: `best-practices.mdz` + **Level**: Namespace, Type, Member + **Purpose**: Recommendations for effective usage + + Best practices guide developers toward optimal usage patterns and away from common pitfalls. + + ```markdown + + ## Best Practices + + - Always dispose of `DocumentationManager` when done to free assembly manager resources + - Use dependency injection containers to manage enricher and renderer lifecycles + - Set `ShowPlaceholders = false` for production documentation builds + - Cache `ProjectContext` instances when processing multiple assemblies + ``` + + + + **File**: `patterns.mdz` + **Level**: Namespace, Type, Member + **Purpose**: Common usage patterns and architectural guidance + + Patterns documentation explains recurring solutions and architectural approaches. + + ```markdown + + ## Pipeline Pattern + + The DocumentationManager implements a pipeline pattern with three stages: + + 1. **Enrichment**: Add metadata from external sources + 2. **Transformation**: Modify the documentation model + 3. **Rendering**: Generate output formats + + Each stage operates on the complete model, allowing cross-assembly transformations. + ``` + + + + **File**: `considerations.mdz` + **Level**: Namespace, Type, Member + **Purpose**: Important notes, gotchas, performance, and security considerations + + This section highlights important things developers need to know before using the API. + + ```markdown + + ## Performance Considerations + + - Assembly loading is expensive; use `GetOrCreateAssemblyManager` for caching + - Conceptual file loading happens in parallel per assembly for better performance + - Large assemblies may benefit from setting `ConceptualDocsEnabled = false` + + ## Security Considerations + + - Assembly reflection can trigger code execution; only process trusted assemblies + - File system access requires appropriate permissions for conceptual paths + ``` + + + + **File**: `related-apis.mdz` + **Level**: Type, Member + **Purpose**: List of related API elements + + Related APIs are specified as one API per line in the markdown file. The renderer formats these appropriately. + + ```markdown + + CloudNimble.DotNetDocs.Core.AssemblyManager + CloudNimble.DotNetDocs.Core.ProjectContext + CloudNimble.DotNetDocs.Core.IDocRenderer + CloudNimble.DotNetDocs.Core.IDocEnricher + ``` + + + +## File Organization + +Conceptual documentation files follow a hierarchical folder structure that mirrors your code organization: + +``` +conceptual/ +├── YourNamespace/ +│ ├── summary.mdz # Namespace summary +│ ├── usage.mdz # Namespace usage guide +│ ├── examples.mdz # Namespace examples +│ ├── YourClass/ +│ │ ├── usage.mdz # Type usage guide +│ │ ├── examples.mdz # Type examples +│ │ ├── best-practices.mdz # Type best practices +│ │ ├── patterns.mdz # Type patterns +│ │ ├── considerations.mdz # Type considerations +│ │ ├── related-apis.mdz # Type related APIs +│ │ ├── YourMethod/ +│ │ │ ├── usage.mdz # Member usage guide +│ │ │ ├── examples.mdz # Member examples +│ │ │ ├── best-practices.mdz # Member best practices +│ │ │ ├── patterns.mdz # Member patterns +│ │ │ ├── considerations.mdz # Member considerations +│ │ │ └── related-apis.mdz # Member related APIs +│ │ └── YourProperty/ +│ │ └── usage.mdz # Member usage guide +│ └── AnotherClass/ +│ └── usage.mdz +└── AnotherNamespace/ + └── usage.mdz +``` + +### Path Construction + +The `DocumentationManager` constructs file paths based on the fully qualified names of your types: + +- **Namespace**: `conceptual/{Namespace}/` +- **Type**: `conceptual/{Namespace}/{TypeName}/` +- **Member**: `conceptual/{Namespace}/{TypeName}/{MemberName}/` + + + Dots in namespace names are converted to directory separators. For example, `System.Text.Json` becomes `conceptual/System/Text/Json/`. + + +## Placeholders and the ShowPlaceholders Property + +When `ConceptualDocsEnabled = true`, DotNetDocs automatically generates placeholder files for any conceptual sections that don't exist yet. These +placeholders help you identify documentation gaps and provide a starting point for writing. + +### Placeholder Format + +Placeholder files include a special TODO comment marker: + +```markdown + +# Usage + +Describe how to use `DocumentationManager` here. + +Consider including: +- Step-by-step instructions +- Common scenarios +- Configuration options +``` + +### Controlling Placeholder Visibility + +The `ShowPlaceholders` property controls whether placeholder content appears in your final documentation: + + + + ```csharp + var context = new ProjectContext + { + ShowPlaceholders = true // Default + }; + ``` + + **When to use**: During development to see documentation gaps and track progress. + + **Result**: All conceptual content loads, including placeholders. You'll see placeholder sections in your generated documentation. + + + + ```csharp + var context = new ProjectContext + { + ShowPlaceholders = false + }; + ``` + + **When to use**: For production documentation builds where you only want to show completed content. + + **Result**: Files containing the TODO comment marker are skipped during loading. Only customized content appears in documentation. + + + +### How Placeholder Detection Works + +The `DocumentationManager.IsTodoPlaceholderFile()` method checks if a file starts with the TODO marker: + +```csharp +internal static bool IsTodoPlaceholderFile(string content) +{ + if (string.IsNullOrWhiteSpace(content)) + return false; + + var regex = new Regex( + @"^\s*\s*$", + RegexOptions.IgnoreCase + ); + + // Check first non-empty line + foreach (var line in content.Split('\n')) + { + var trimmed = line.Trim(); + if (!string.IsNullOrWhiteSpace(trimmed)) + return regex.IsMatch(trimmed); + } + + return false; +} +``` + + + The TODO marker must be on the **first non-empty line** of the file to be recognized as a placeholder. Once you start customizing content, **delete the TODO comment** so DotNetDocs knows the file contains real documentation. + + +## Using Markdown to Override Titles + +Conceptual documentation files support full Markdown syntax, including headers. Renderers respect the structure of your Markdown, allowing you to override default section titles and organize content hierarchically. + +### Default Titles + +By default, renderers use section names as titles: + +```markdown + +Describe how to use this API... +``` + +**Rendered as**: A section titled "Usage" with your content + +### Custom Titles with Markdown Headers + +Add your own headers to customize the title and create subsections: + +```markdown + +## Getting Started with DocumentationManager + +The `DocumentationManager` orchestrates the documentation pipeline... + +### Basic Configuration + +First, create a `ProjectContext`: + +### Processing Assemblies + +Call `ProcessAsync()` with your assembly paths: +``` + +**Rendered as**: Custom "Getting Started with DocumentationManager" title with "Basic Configuration" and "Processing Assemblies" subsections + +### Multi-Level Organization + +Create deep hierarchies for complex topics: + +```markdown + +## Architectural Patterns + +The DocumentationManager supports several patterns: + +### Pipeline Pattern + +#### Enrichment Stage +Enrichers add metadata from external sources... + +#### Transformation Stage +Transformers modify the documentation model... + +#### Rendering Stage +Renderers generate output formats... + +### Factory Pattern + +The `GetOrCreateAssemblyManager` method implements a factory pattern... +``` + +### Best Practices for Markdown Headers + + + + Start with `##` (H2) for main titles and nest logically with `###` (H3) and `####` (H4) for subsections. + + + + Use the same header style across all conceptual files in your project for a cohesive documentation experience. + + + + Reserve `#` (H1) for page titles. Start conceptual content with `##` (H2) to maintain proper document hierarchy. + + + + Use proper code fences with language identifiers for syntax highlighting: ` ```csharp ` + + + +## Including HTML and Components with `noescape` + +Conceptual documentation often needs to include rich HTML content, JSX components, or other markup that should not be escaped. DotNetDocs provides +the ` ```noescape ` code fence specifically for this purpose. + +### The Problem: HTML Gets Escaped + +By default, the `MarkdownXmlTransformer` escapes HTML tags in your conceptual content to prevent conflicts with Markdown rendering. This is useful +for XML documentation comments, but problematic when you want to include actual HTML or components: + +```markdown + + + This is a note component + + + +``` + +### The Solution: `noescape` Code Fences + +The `noescape` code fence tells the transformer to pass content through **without escaping** and **without code fence markers**: + +````markdown + +```noescape + + This is a note component that will render correctly! + +``` +```` + +**Result**: The HTML content is included in the output exactly as written, allowing components to render properly. + +### How It Works + +When the `MarkdownXmlTransformer` processes conceptual content: + +1. **Regular content**: HTML tags are escaped (`<` → `<`, `>` → `>`) +2. **Code fences**: Content is preserved with backticks for syntax highlighting +3. **`noescape` fences**: Content is extracted and passed through unchanged + +From `MarkdownXmlTransformer.cs:750-773`: + +```csharp +var isNoEscape = text.IndexOf("noescape", fenceStart, Math.Min(20, text.Length - fenceStart), + StringComparison.Ordinal) == fenceStart; + +if (isNoEscape) +{ + // Extract content without delimiters and without escaping + var contentStart = fenceStart + 8; // "noescape" is 8 chars + if (contentStart < text.Length && text[contentStart] == '\r') contentStart++; + if (contentStart < text.Length && text[contentStart] == '\n') contentStart++; + + var content = text.Substring(contentStart, closingPos - contentStart); + result.Append(content); +} +``` + +### Use Cases + + + + Include Mintlify's special components in your conceptual documentation: + + ````markdown + + ## Configuration Options + + ```noescape + + The directory where conceptual documentation files are stored. + + + + Controls whether placeholder content is included in documentation. + + ``` + ```` + + + + Embed custom HTML when your renderer supports it: + + ````markdown + + ## Interactive Demo + + ```noescape +
+ +
+
+ + + ``` + ```` + + + + Use callout components without worrying about escaping: + + ````markdown + + ## Performance Considerations + + ```noescape + + Assembly loading is expensive. Cache `AssemblyManager` instances when processing multiple assemblies. + + + + Set `ConceptualDocsEnabled = false` to skip placeholder generation and improve performance. + + ``` + ```` + + + + Create multi-step guides with structured components: + + ````markdown + + ## Setup Process + + ```noescape + + + Configure your `ProjectContext` with the required settings. + + + + Create a `DocumentationManager` with enrichers and renderers. + + + + Call `ProcessAsync()` with your assembly paths. + + + ``` + ```` + + + +### Best Practices + + + + Ensure your renderer (e.g., MintlifyRenderer) supports the components you're using. `noescape` only prevents escaping—rendering is up to your output format. + + + + For clarity, use separate `noescape` blocks for distinct components rather than grouping multiple components together. + + + + The transformer doesn't validate HTML. Ensure your markup is well-formed to avoid rendering issues. + + + + You can freely mix `noescape` blocks with regular Markdown content in the same file—only the content inside `noescape` fences is unescaped. + + + +### Example: Complete Conceptual File + +Here's a real-world example mixing Markdown and components: + +````markdown + +## Using the DocumentationManager + +The `DocumentationManager` orchestrates the entire documentation pipeline, from assembly loading through final output generation. + +### Basic Setup + +First, create and configure a `ProjectContext`: + +```csharp +var context = new ProjectContext +{ + ConceptualPath = "conceptual", + ShowPlaceholders = false, + OutputPath = "docs" +}; +``` + +### Configuration Options + +```noescape + + Directory where `.mdz` conceptual files are stored, relative to the documentation root. + + + + When `false`, placeholder files with TODO markers are excluded from output. + +``` + +### Processing Assemblies + +```noescape + + + The manager loads your compiled assembly and XML documentation. + + + + Missing conceptual files are created automatically (if enabled). + + + + XML documentation is converted to Markdown format. + + + + Final documentation is generated in your chosen format. + + +``` + +### Important Considerations + +```noescape + + Assembly reflection can trigger code execution. Only process assemblies from trusted sources. + +``` +```` + +### Technical Details + +The `noescape` feature is implemented in the `EscapeRemainingXmlTags` method of `MarkdownXmlTransformer`: + +- **Detection**: Checks for `noescape` immediately after the opening ` ``` ` (within the first 20 characters) +- **Extraction**: Skips the `noescape` keyword and any following newline, then extracts content up to the closing ` ``` ` +- **Processing**: Appends the content directly to the output without modifications +- **Preservation**: Regular code fences and inline code (single backticks) are preserved with their delimiters + + + The `noescape` functionality only applies to conceptual documentation properties that go through the `MarkdownXmlTransformer`. It does **not** + affect XML documentation comments, which always have HTML escaped for safety. + + +## Creating Conceptual Documentation + +### Automatic Placeholder Generation + +When you process an assembly with `ConceptualDocsEnabled = true`, DotNetDocs automatically creates placeholder files: + +```csharp +var context = new ProjectContext +{ + ConceptualPath = "conceptual", + ConceptualDocsEnabled = true +}; + +var manager = new DocumentationManager(context); + +// This generates placeholder files for all types and members +await manager.ProcessAsync("MyAssembly.dll", "MyAssembly.xml"); +``` + +After running, you'll find a complete folder structure in your `conceptual/` directory with placeholders for all sections. + +### Manual Placeholder Generation + +Generate placeholders without running the full pipeline: + +```csharp +// Only create placeholder files, don't run full pipeline +await manager.CreateConceptualFilesAsync("MyAssembly.dll", "MyAssembly.xml"); + +// For multiple assemblies +await manager.CreateConceptualFilesAsync(new[] +{ + ("Core.dll", "Core.xml"), + ("Extensions.dll", "Extensions.xml") +}); +``` + +### Customizing Conceptual Content + +To customize a placeholder: + +1. Open the `.mdz` file in your preferred Markdown editor +2. **Delete the TODO comment** from the first line +3. Replace the placeholder content with your documentation +4. Save the file + +The next time you process your assembly, DotNetDocs will load your customized content instead of the placeholder. + +## Workflow Example + +Here's a complete workflow for adding conceptual documentation to a project: + + + + ```csharp + var context = new ProjectContext + { + ConceptualPath = "conceptual", + ShowPlaceholders = true + }; + + var manager = new DocumentationManager(context); + await manager.CreateConceptualFilesAsync("MyLib.dll", "MyLib.xml"); + ``` + + + + ```bash + # Examine the generated folder structure + ls -R conceptual/ + + conceptual/MyNamespace/MyClass/ + ├── usage.mdz + ├── examples.mdz + ├── best-practices.mdz + ├── patterns.mdz + ├── considerations.mdz + └── related-apis.mdz + ``` + + + + Edit the most important conceptual files first (usually `usage.mdz` and `examples.mdz`), removing the TODO comments and adding your content. + + + + ```csharp + // Process with placeholders visible to see progress + await manager.ProcessAsync("MyLib.dll", "MyLib.xml"); + ``` + + Review the generated documentation to see which sections still need content. + + + + ```csharp + // Hide placeholders for production + context.ShowPlaceholders = false; + await manager.ProcessAsync("MyLib.dll", "MyLib.xml"); + ``` + + Only customized content appears in the final documentation. + + + +## Advanced Scenarios + +### Partial Documentation + +You don't need to fill in all seven sections for every API element. Only create the files that add value: + +``` +conceptual/ +└── MyNamespace/ + └── MyClass/ + ├── usage.mdz # Comprehensive usage guide + └── examples.mdz # Lots of examples + # No best-practices.mdz - not needed for this simple class +``` + +### Shared Content with Includes + +Some renderers (like MintlifyRenderer) support includes for reusing content across multiple files: + +```markdown + + + +## Using MyClass + +Now that you've completed setup, you can use MyClass... +``` + +### Multi-Assembly Projects + +When documenting multiple assemblies, organize conceptual content by assembly: + +``` +conceptual/ +├── MyProject.Core/ +│ └── CoreNamespace/ +│ └── CoreClass/ +│ └── usage.mdz +└── MyProject.Extensions/ + └── ExtensionsNamespace/ + └── ExtensionClass/ + └── usage.mdz +``` + +Then process assemblies together: + +```csharp +await manager.ProcessAsync(new[] +{ + ("MyProject.Core.dll", "MyProject.Core.xml"), + ("MyProject.Extensions.dll", "MyProject.Extensions.xml") +}); +``` + +## Integration with the Pipeline + +Conceptual content integrates seamlessly with DotNetDocs' transformation pipeline: + +```csharp +var manager = new DocumentationManager( + context, + enrichers: new IDocEnricher[] { /* enrichers */ }, + transformers: new IDocTransformer[] { /* transformers */ }, + renderers: new IDocRenderer[] { new MintlifyRenderer(context) } +); + +await manager.ProcessAsync("MyLib.dll", "MyLib.xml"); +``` + +**Pipeline execution order**: + +1. **Extract XML**: Load API metadata from XML comments +2. **Generate Placeholders**: Create missing conceptual files (if enabled) +3. **Load Conceptual**: Load conceptual content from `.mdz` files +4. **Merge Models**: Combine multiple assemblies if needed +5. **Enrich**: Run enrichers to add external metadata +6. **Transform**: Run transformers to modify the model +7. **Render**: Generate final documentation output + + + Conceptual content is loaded **after** placeholder generation but **before** enrichers and transformers run, allowing the entire pipeline to work with the complete documentation model. + + +## See Also + + + + Learn about the complete documentation pipeline + + + + See how conceptual content renders in Mintlify + + + + Technical specification for placeholder handling + + + + Complete XML and conceptual mapping reference + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/deployment.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/deployment.mdx new file mode 100644 index 0000000..06fdc0e --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/deployment.mdx @@ -0,0 +1,8 @@ +--- +title: Deployment +sidebarTitle: Deployment +description: How to deploy DotNetDocs in various hosting solutions +icon: conveyor-belt-boxes +--- + +## COMING SOON! \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Docs/guides/docsproj.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/docsproj.mdx similarity index 98% rename from src/CloudNimble.DotNetDocs.Docs/guides/docsproj.mdx rename to samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/docsproj.mdx index 00199c8..446ad8b 100644 --- a/src/CloudNimble.DotNetDocs.Docs/guides/docsproj.mdx +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/docsproj.mdx @@ -433,10 +433,10 @@ dotnet build -t:GenerateDocumentation ## Next Steps - + Learn how the documentation pipeline works - + Add conceptual documentation to your project diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/index.mdx new file mode 100644 index 0000000..6724258 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/index.mdx @@ -0,0 +1,64 @@ +--- +title: Guides +sidebarTitle: Overview +description: The Guides will help you get the most out of DotNetDocs. +icon: circle-info +--- + +Everything you need to master DotNetDocs, from getting started to advanced configuration and deployment. + +## Getting Started + + + + Complete command-line reference for managing documentation projects and generating docs from assemblies. + + + + Configure your documentation project with MSBuild properties and customize the generation pipeline. + + + + Understand how DotNetDocs transforms assemblies and XML docs into rich, multi-format documentation. + + + +## Advanced Topics + + + + Enrich your API reference with context-aware content that goes beyond XML documentation comments. + + + + Combine multiple documentation projects into unified portals for microservices, multi-product suites, and modular systems. + + + + Deploy your documentation to Mintlify, GitHub Pages, Azure Static Web Apps, and other hosting platforms. + + \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/path-rewriting-test.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/path-rewriting-test.mdx new file mode 100644 index 0000000..e6fec74 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/path-rewriting-test.mdx @@ -0,0 +1,88 @@ +--- +title: Path Rewriting Test +sidebarTitle: Path Test +description: A test page to verify path rewriting works correctly in documentation collections. +icon: flask-vial +--- + +import { ValueProposition } from '/snippets/test/ValueProposition.jsx'; + +# Path Rewriting Test Guide + +This guide tests various path patterns to ensure they are correctly rewritten when +documentation is included in a collection. + +## ES Import Test + +The component below is imported from `/snippets/ValueProposition.jsx`: + + + +## Markdown Image Tests + +### Basic Image + +Here's an image using standard Markdown syntax: + +![Hero Banner](/images/test/hero-banner.png) + +### Nested Image Path + +And an image in a subdirectory: + +![Pipeline Output](/images/test/screenshots/pipeline-output.png) + +## Markdown Link Tests + +### Internal Page Links + +- [Back to Home](/test/index) +- [Quickstart Guide](/test/quickstart) +- [API Reference](/test/api-reference/index) + +### Links with Anchors + +- [Pipeline Configuration](/test/guides/pipeline#configuration) +- [Deployment Options](/test/guides/deployment#docker) + +### Links with Query Strings + +- [API with Version](/test/api-reference/index?version=2) + +## JSX Attribute Tests + + + Learn how to get started with DotNetDocs in minutes. + + +Hero + +## Code Block Preservation Test + +Paths inside code blocks should NOT be rewritten: + +```javascript +// This import path should remain unchanged +import { Component } from '/snippets/Component.jsx'; + +// This image path should remain unchanged +const logo = '/images/logo.png'; +``` + +```bash +# These paths should also remain unchanged +curl https://api.example.com/images/test.png +cat /snippets/example.jsx +``` + +## CSS URL Test + +
+ +## Summary + +If this page renders correctly in a collection: +- Imports should work (component above should render) +- Images should display +- Links should navigate correctly (to `/test/...` paths) +- Code blocks should show original paths unchanged diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/pipeline.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/pipeline.mdx new file mode 100644 index 0000000..a4e3431 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/guides/pipeline.mdx @@ -0,0 +1,1113 @@ +--- +title: Documentation Pipeline +sidebarTitle: Doc Pipeline +description: Understand how the Documentation Pipeline works +icon: faucet-drip +--- + +## Overview + +The DotNetDocs pipeline is a flexible, extensible system for transforming .NET assemblies and XML documentation into rich, multi-format documentation. At its core, the pipeline follows a linear flow through five distinct stages, each building on the previous one to create comprehensive documentation from your code. + +```mermaid +flowchart LR + %% Main horizontal flow + C[Extract] --> D[Load Conceptual] --> E[Enrich] --> F[Transform] --> G[Render] + %% Inputs above the horizontal flow + A[Assembly DLL] --> C + B[XML Documentation] --> C + %% Output below the horizontal flow + G --> H[Output Files] +``` + +The pipeline is orchestrated by the `DocumentationManager`, which coordinates all stages and manages caching, parallel processing, and multi-assembly merging. + +## Pipeline Stages + +### Stage 1: Assembly Extraction + +**Purpose**: Load .NET assemblies and extract API metadata using Roslyn + +**Component**: `AssemblyManager` + +The first stage loads your compiled .NET assembly and uses Roslyn's powerful code analysis APIs to extract comprehensive metadata about every type, member, parameter, and attribute in your code. + + + + - **Namespaces**: Hierarchical organization of types + - **Types**: Classes, interfaces, structs, enums, delegates with full metadata + - **Members**: Methods, properties, fields, events, constructors + - **Parameters**: Method/constructor parameters with types and defaults + - **Type Parameters**: Generic type parameters with constraints + - **Attributes**: Custom attributes applied to code elements + - **Signatures**: Full method/property signatures with modifiers + - **Accessibility**: Public, internal, protected, private visibility + - **XML Comments**: Summary, remarks, examples, returns, exceptions, seealso + + All of this information is extracted from the compiled assembly's metadata, not from source code. + + + + If an XML documentation file is available, `AssemblyManager` parses it to extract: + + - ``: Brief description of what the API element IS + - ``: Additional detailed information + - ``: Code usage examples from XML + - ``: Method return value documentation + - ``: Parameter descriptions + - ``: Exception types and conditions + - ``: Generic type parameter descriptions + - ``: Property value descriptions + - ``: Cross-references to related APIs + + XML tags preserve their inner XML structure, allowing transformers to process them later. + + + + The `AssemblyManager` creates a Roslyn `Compilation` object to access symbol information: + + ```csharp + // Load assembly as a metadata reference + var assemblyRef = MetadataReference.CreateFromFile(assemblyPath); + + // Include project references for enhanced metadata + var references = projectContext.References + .Select(r => MetadataReference.CreateFromFile(r)) + .Prepend(assemblyRef); + + // Create compilation for symbol access + var compilation = CSharpCompilation.Create( + assemblyName, + references: references, + options: new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary) + ); + ``` + + This gives DotNetDocs full access to type hierarchies, member relationships, and semantic information. + + + + `AssemblyManager` implements smart caching to avoid redundant processing: + + - Tracks assembly file `LastModified` timestamp + - Compares `IncludedMembers` accessibility levels + - Only rebuilds the model when assembly changes or configuration changes + - Reuses existing `DocAssembly` model when possible + + ```csharp + var needsRebuild = Document is null || + currentModified > LastModified || + !includedMembers.SequenceEqual(PreviousIncludedMembers); + ``` + + + +**Output**: A `DocAssembly` object containing `DocNamespace` → `DocType` → `DocMember` hierarchy with XML documentation. + +### Stage 2: Conceptual Content Loading + +**Purpose**: Enrich API documentation with conceptual content from `.mdz` files + +**Component**: `DocumentationManager.LoadConceptualAsync()` + +After extracting API metadata, the pipeline loads conceptual documentation from the file system to add context-rich content that goes beyond XML comments. + + + + The `DocumentationManager` scans the configured `ConceptualPath` directory, looking for `.mdz` files organized by namespace/type/member: + + ``` + conceptual/ + ├── MyNamespace/ + │ ├── summary.mdz # Namespace summary + │ ├── usage.mdz # Namespace usage + │ ├── MyClass/ + │ │ ├── usage.mdz # Type usage + │ │ ├── examples.mdz # Type examples + │ │ ├── best-practices.mdz # Type best practices + │ │ └── MyMethod/ + │ │ └── usage.mdz # Member usage + ``` + + The pipeline walks this hierarchy, loading content for each API element. + + + + Seven conceptual sections can be loaded at different levels: + + | Section | File | Namespace | Type | Member | + |---------|------|-----------|------|--------| + | **Summary** | `summary.mdz` | ✅ | ❌ | ❌ | + | **Usage** | `usage.mdz` | ✅ | ✅ | ✅ | + | **Examples** | `examples.mdz` | ✅ | ✅ | ✅ | + | **Best Practices** | `best-practices.mdz` | ✅ | ✅ | ✅ | + | **Patterns** | `patterns.mdz` | ✅ | ✅ | ✅ | + | **Considerations** | `considerations.mdz` | ✅ | ✅ | ✅ | + | **Related APIs** | `related-apis.mdz` | ❌ | ✅ | ✅ | + + Each file contains Markdown content that renderers can format appropriately. + + + + The pipeline can generate placeholder files for missing conceptual content and control their visibility: + + **Placeholder Generation**: When `ConceptualDocsEnabled = true`, renderers create placeholder `.mdz` files marked with: + + ```markdown + + ``` + + **Placeholder Loading**: The `ShowPlaceholders` property controls whether placeholders appear in final documentation: + + - `ShowPlaceholders = true` (default): Load all conceptual content including placeholders + - `ShowPlaceholders = false`: Skip files containing the TODO marker + + ```csharp + if (!showPlaceholders && IsTodoPlaceholderFile(content)) + { + return; // Skip loading this placeholder + } + ``` + + This allows you to see documentation gaps during development but hide them in production builds. + + + + Conceptual content loading happens in parallel per assembly for performance: + + ```csharp + var assemblyTasks = docAssemblies.Select(async assembly => + { + // Generate placeholders for this assembly + await Task.WhenAll(renderers.Select(r => r.RenderPlaceholdersAsync(assembly))); + + // Load conceptual content for this assembly + await LoadConceptualAsync(assembly); + }); + + await Task.WhenAll(assemblyTasks); + ``` + + Each assembly has its own conceptual directory subtree, so parallel loading is safe. + + + +**Output**: The `DocAssembly` model now has both XML documentation AND conceptual content in each entity's properties. + +### Stage 3: Assembly Merging + +**Purpose**: Combine multiple assemblies into a unified documentation model + +**Component**: `DocumentationManager.MergeDocAssembliesAsync()` + +When documenting multiple assemblies together, the pipeline merges them into a single cohesive model before enrichment and transformation. + + + + Namespaces with the same fully qualified name are merged: + + ```csharp + var existingNamespace = mergedAssembly.Namespaces + .FirstOrDefault(ns => ns.Symbol.ToDisplayString() == sourceNamespace.Symbol.ToDisplayString()); + + if (existingNamespace is null) + { + mergedAssembly.Namespaces.Add(sourceNamespace); + } + else + { + // Merge types into existing namespace + } + ``` + + + + Types with the same fully qualified name are merged, combining their members: + + ```csharp + var existingType = mergedNamespace.Types + .FirstOrDefault(t => t.Symbol.ToDisplayString() == sourceType.Symbol.ToDisplayString()); + + if (existingType is null) + { + mergedNamespace.Types.Add(sourceType); + } + else + { + // Merge members into existing type + } + ``` + + + + Members with the same symbol signature are deduplicated: + + ```csharp + var existingMember = mergedType.Members + .FirstOrDefault(m => m.Symbol.ToDisplayString() == sourceMember.Symbol.ToDisplayString()); + + if (existingMember is null) + { + mergedType.Members.Add(sourceMember); + } + ``` + + + + + Merging happens AFTER conceptual content loading, so each assembly's conceptual documentation is preserved during the merge. Conflicting documentation prefers the first assembly encountered. + + +**Output**: A single merged `DocAssembly` containing all types and members from all processed assemblies. + +### Stage 4: Enrichment + +**Purpose**: Add or enhance documentation content from external sources + +**Component**: `IDocEnricher` implementations + +Enrichers augment the documentation model with additional content from sources beyond the assembly and conceptual files. + + + + Enrichers can add any type of content to `DocEntity` objects: + + - Generate documentation from AI services (e.g., Azure OpenAI) + - Pull examples from external code repositories + - Add version history from git logs + - Include performance benchmarks from test results + - Cross-reference related documentation from other systems + - Add compliance or security annotations + - Generate diagrams or visualizations + + Each enricher runs independently and can modify any property on any entity. + + + + Enrichers implement the `IDocEnricher` interface: + + ```csharp + public interface IDocEnricher + { + Task EnrichAsync(DocEntity entity); + } + ``` + + The pipeline calls each enricher with the root `DocAssembly` entity, allowing enrichers to traverse the entire model: + + ```csharp + public class MyCustomEnricher : IDocEnricher + { + public async Task EnrichAsync(DocEntity entity) + { + if (entity is DocAssembly assembly) + { + foreach (var ns in assembly.Namespaces) + { + foreach (var type in ns.Types) + { + // Enrich this type + type.BestPractices = await GetBestPracticesAsync(type); + } + } + } + } + } + ``` + + + + Enrichers execute sequentially in registration order: + + ```csharp + foreach (var enricher in enrichers) + { + await enricher.EnrichAsync(mergedModel); + } + ``` + + This allows later enrichers to build on the work of earlier ones. + + + +**Output**: The `DocAssembly` model enriched with additional content from all registered enrichers. + +### Stage 5: Transformation + +**Purpose**: Modify the documentation model before rendering + +**Component**: `IDocTransformer` implementations + +Transformers modify the documentation model structure or content, applying customizations and processing XML tags. + + + + Transformers can modify any aspect of the model: + + - Process XML documentation tags (e.g., `` to links) + - Implement inheritdoc behavior for inherited members + - Apply documentation overrides or customizations + - Reformat content for specific renderer requirements + - Filter or reorganize the model structure + - Apply naming conventions or style rules + - Inject boilerplate content + + Transformers prepare the model for the specific needs of each renderer. + + + + Transformers implement the `IDocTransformer` interface: + + ```csharp + public interface IDocTransformer + { + Task TransformAsync(DocEntity entity); + } + ``` + + Like enrichers, transformers receive the root entity and can traverse the entire model: + + ```csharp + public class MarkdownXmlTransformer : IDocTransformer + { + public async Task TransformAsync(DocEntity entity) + { + // Transform XML tags to Markdown + entity.Summary = ConvertXmlToMarkdown(entity.Summary); + entity.Remarks = ConvertXmlToMarkdown(entity.Remarks); + // ... transform other properties + } + } + ``` + + + + DotNetDocs includes the `MarkdownXmlTransformer` for processing XML documentation tags: + + - Converts `` to Markdown links + - Processes `` and `` tags to code formatting + - Handles ``, ``, and other structural tags + - Preserves semantic meaning while adapting to Markdown + + This transformer is automatically registered when using `UseMarkdownRenderer()`. + + + + Transformers execute sequentially in registration order: + + ```csharp + foreach (var transformer in transformers) + { + await transformer.TransformAsync(mergedModel); + } + ``` + + Transformer order matters when transformations build on each other. + + + +**Output**: The final transformed `DocAssembly` model ready for rendering. + +### Stage 6: Rendering + +**Purpose**: Generate output files in specific formats + +**Component**: `IDocRenderer` implementations + +Renderers take the final documentation model and generate output files in various formats like Markdown, JSON, YAML, or custom formats. + + + + Renderers traverse the documentation model and generate output files: + + - Create file/folder structure based on `FileNamingOptions` + - Format content appropriately for the target format + - Generate navigation files (e.g., `docs.json` for Mintlify) + - Include frontmatter, metadata, and formatting + - Create index files and cross-references + - Generate supplementary files (sidebars, TOCs, etc.) + + Each renderer has complete control over the output format and structure. + + + + Renderers implement the `IDocRenderer` interface: + + ```csharp + public interface IDocRenderer + { + Task RenderAsync(DocAssembly model); + Task RenderPlaceholdersAsync(DocAssembly model); + } + ``` + + - `RenderAsync()`: Generate final documentation output + - `RenderPlaceholdersAsync()`: Generate placeholder conceptual files + + Example renderer: + + ```csharp + public class MarkdownRenderer : IDocRenderer + { + public async Task RenderAsync(DocAssembly model) + { + foreach (var ns in model.Namespaces) + { + var filePath = GetNamespaceFilePath(ns); + var content = FormatNamespaceMarkdown(ns); + await File.WriteAllTextAsync(filePath, content); + + foreach (var type in ns.Types) + { + var typeFilePath = GetTypeFilePath(type); + var typeContent = FormatTypeMarkdown(type); + await File.WriteAllTextAsync(typeFilePath, typeContent); + } + } + } + } + ``` + + + + DotNetDocs Core includes three built-in renderers: + + **MarkdownRenderer**: Generates clean Markdown files + - Uses `FileNamingOptions` for file organization + - Supports both File and Folder namespace modes + - Includes frontmatter and metadata + - Cross-references between types + + **JsonRenderer**: Generates JSON representation + - Configurable via `JsonRendererOptions` + - Clean serialization with camelCase naming + - Null value handling + - Full model export for custom processing + + **YamlRenderer**: Generates YAML representation + - Human-readable structured format + - Suitable for static site generators + - Preserves model hierarchy + + + + You can register multiple renderers to generate multiple output formats simultaneously: + + ```csharp + services.AddDotNetDocsPipeline(pipeline => + { + pipeline + .UseMarkdownRenderer() + .UseJsonRenderer() + .AddRenderer(); + }); + ``` + + Each renderer runs independently and generates its own output files. + + + +**Output**: Documentation files written to disk in one or more formats. + +## Configuration + +### Using ProjectContext + +The `ProjectContext` class configures the entire pipeline. You can configure it either in code or declaratively using a `.docsproj` file with the DotNetDocs SDK: + + + + ```csharp + var context = new ProjectContext + { + // Paths + DocumentationRootPath = "docs", // Base output path + ApiReferencePath = "api-reference", // API docs subfolder + ConceptualPath = "conceptual", // Conceptual content folder + + // Accessibility + IncludedMembers = new List + { + Accessibility.Public, + Accessibility.Internal + }, + + // References + References = new List + { + "path/to/reference1.dll", + "path/to/reference2.dll" + }, + + // Features + ConceptualDocsEnabled = true, // Enable conceptual docs + ShowPlaceholders = false, // Hide placeholders in production + IncludeFields = false, // Exclude fields by default + + // File Organization + FileNamingOptions = new FileNamingOptions + { + NamespaceMode = NamespaceMode.Folder, // Use folder hierarchy + NamespaceSeparator = '-' // Separator for flat mode + }, + + // Type Filtering + ExcludedTypes = new HashSet + { + "*.MicrosoftTestingPlatformEntryPoint", + "System.Runtime.CompilerServices.*" + } + }; + ``` + + + + + ```xml Current (1.1.0) + + + + + Mintlify + true + + + Folder + + + true + false + + + Tests.Shared;*.Sdk + + + + My API Documentation + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + /images/logo-light.svg + /images/logo-dark.svg + + + + + + + + ``` + + ```xml Preview (1.2.0-preview.1) + + + + + Mintlify + true + + + Folder + + + true + false + + + Tests.Shared;*.Sdk + + + + My API Documentation + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + /images/logo-light.svg + /images/logo-dark.svg + + + + + + + + + ``` + + + **Build the documentation**: + ```bash + dotnet build MyDocs.docsproj + ``` + + The SDK automatically: + - Creates a `ProjectContext` from the properties + - Configures renderers based on `DocumentationType` + - Processes all `` references + - Outputs to `$(DocumentationRoot)` or `$(OutputPath)` + + + +### Dependency Injection Setup + +DotNetDocs integrates seamlessly with .NET dependency injection: + + + + ```csharp + // Add all built-in renderers + services.AddDotNetDocs(context => + { + context.DocumentationRootPath = "docs"; + context.ShowPlaceholders = false; + }); + ``` + + Registers: + - `ProjectContext` as Singleton + - `DocumentationManager` as Scoped + - All built-in renderers (Markdown, JSON, YAML) + - `MarkdownXmlTransformer` + + + + ```csharp + // Add only core services, manually add renderers + services.AddDotNetDocsCore(context => + { + context.ConceptualPath = "conceptual"; + }); + + services.AddMarkdownRenderer(); + services.AddJsonRenderer(options => + { + options.WriteIndented = true; + }); + ``` + + Gives you control over which renderers are registered. + + + + ```csharp + // Use fluent builder API + services.AddDotNetDocsPipeline(pipeline => + { + pipeline + .ConfigureContext(ctx => + { + ctx.DocumentationRootPath = "docs"; + ctx.ShowPlaceholders = false; + }) + .UseMarkdownRenderer() + .UseJsonRenderer(options => + { + options.WriteIndented = true; + }) + .AddEnricher() + .AddTransformer(); + }); + ``` + + Most flexible approach with full control over the pipeline. + + + + ```csharp + // Add custom enrichers, transformers, renderers + services.AddDotNetDocsCore(); + services.AddDocEnricher(); + services.AddDocTransformer(); + services.AddDocRenderer(); + ``` + + Extend the pipeline with your own components. + + + +### File Naming Options + +Control how documentation files are organized: + + + + ```csharp + context.FileNamingOptions = new FileNamingOptions + { + NamespaceMode = NamespaceMode.Folder + }; + ``` + + **Result**: Namespace hierarchy as folders + + ``` + docs/ + ├── System/ + │ ├── Collections/ + │ │ ├── Generic/ + │ │ │ ├── index.md (namespace) + │ │ │ ├── List.md (type) + │ │ │ └── Dictionary.md (type) + ``` + + **Best for**: Sites with many types, hierarchical navigation + + + + ```csharp + context.FileNamingOptions = new FileNamingOptions + { + NamespaceMode = NamespaceMode.File, + NamespaceSeparator = '-' + }; + ``` + + **Result**: Flat file structure with separators + + ``` + docs/ + ├── System-Collections-Generic.md (namespace) + ├── System-Collections-Generic-List.md + ├── System-Collections-Generic-Dictionary.md + ``` + + **Best for**: Smaller projects, simpler file organization + + + +## Pipeline Execution + +### Basic Usage + +Process a single assembly: + +```csharp +// Resolve from DI +var manager = serviceProvider.GetRequiredService(); + +// Process assembly +await manager.ProcessAsync("MyLibrary.dll", "MyLibrary.xml"); +``` + +### Multi-Assembly Processing + +Process multiple assemblies together: + +```csharp +var assemblies = new[] +{ + ("Core.dll", "Core.xml"), + ("Extensions.dll", "Extensions.xml"), + ("Utilities.dll", "Utilities.xml") +}; + +await manager.ProcessAsync(assemblies); +``` + +Assemblies are merged into a unified model after conceptual loading. + +### Manual Control + +Separate conceptual placeholder generation from full processing: + +```csharp +// Generate placeholders only +await manager.CreateConceptualFilesAsync("MyLibrary.dll", "MyLibrary.xml"); + +// Later: process with full pipeline +await manager.ProcessAsync("MyLibrary.dll", "MyLibrary.xml"); +``` + +### Direct Instantiation + +Use the pipeline without dependency injection: + +```csharp +var context = new ProjectContext +{ + DocumentationRootPath = "docs", + ShowPlaceholders = false +}; + +var enrichers = new IDocEnricher[] { /* custom enrichers */ }; +var transformers = new IDocTransformer[] { new MarkdownXmlTransformer() }; +var renderers = new IDocRenderer[] { new MarkdownRenderer(context) }; + +var manager = new DocumentationManager(context, enrichers, transformers, renderers); +await manager.ProcessAsync("MyLibrary.dll", "MyLibrary.xml"); +``` + +## Advanced Scenarios + +### Custom Enricher Example + +Create an enricher that adds AI-generated best practices: + +```csharp +public class AiBestPracticesEnricher : IDocEnricher +{ + private readonly IAiService _aiService; + + public AiBestPracticesEnricher(IAiService aiService) + { + _aiService = aiService; + } + + public async Task EnrichAsync(DocEntity entity) + { + if (entity is DocAssembly assembly) + { + foreach (var ns in assembly.Namespaces) + { + foreach (var type in ns.Types) + { + // Only add if not already present + if (string.IsNullOrWhiteSpace(type.BestPractices)) + { + type.BestPractices = await _aiService.GenerateBestPracticesAsync( + type.Name, + type.Summary, + type.Members.Select(m => m.Name) + ); + } + } + } + } + } +} + +// Register +services.AddDocEnricher(); +``` + +### Custom Transformer Example + +Create a transformer that adds version badges: + +```csharp +public class VersionBadgeTransformer : IDocTransformer +{ + public Task TransformAsync(DocEntity entity) + { + if (entity is DocType type) + { + // Add version badge to summary + var versionBadge = GetVersionBadge(type); + if (!string.IsNullOrWhiteSpace(versionBadge)) + { + type.Summary = $"{versionBadge}\n\n{type.Summary}"; + } + } + + return Task.CompletedTask; + } + + private string GetVersionBadge(DocType type) + { + // Check for [Obsolete] attribute + if (type.Symbol.GetAttributes().Any(a => a.AttributeClass?.Name == "ObsoleteAttribute")) + { + return "⚠️ **Deprecated**"; + } + + // Check for custom version attributes + var versionAttr = type.Symbol.GetAttributes() + .FirstOrDefault(a => a.AttributeClass?.Name == "ApiVersionAttribute"); + + if (versionAttr?.ConstructorArguments.Length > 0) + { + var version = versionAttr.ConstructorArguments[0].Value; + return $"✨ **Since v{version}**"; + } + + return string.Empty; + } +} + +// Register +services.AddDocTransformer(); +``` + +### Custom Renderer Example + +Create a renderer that generates HTML: + +```csharp +public class HtmlRenderer : RendererBase, IDocRenderer +{ + public HtmlRenderer(ProjectContext context) : base(context) + { + } + + public async Task RenderAsync(DocAssembly model) + { + var outputPath = Path.Combine(Context.DocumentationRootPath, "html"); + Directory.CreateDirectory(outputPath); + + foreach (var ns in model.Namespaces) + { + var html = GenerateNamespaceHtml(ns); + var filePath = Path.Combine(outputPath, $"{ns.Name}.html"); + await File.WriteAllTextAsync(filePath, html); + + foreach (var type in ns.Types) + { + var typeHtml = GenerateTypeHtml(type); + var typeFilePath = Path.Combine(outputPath, $"{type.FullName}.html"); + await File.WriteAllTextAsync(typeFilePath, typeHtml); + } + } + } + + public Task RenderPlaceholdersAsync(DocAssembly model) + { + // HTML renderer doesn't generate placeholders + return Task.CompletedTask; + } + + private string GenerateNamespaceHtml(DocNamespace ns) + { + return $@" + + + {ns.Name} + +

{ns.Name}

+

{ns.Summary}

+

Types

+
    + {string.Join("\n", ns.Types.Select(t => + $"
  • {t.Name}
    • "))} +
+ + + "; + } + + private string GenerateTypeHtml(DocType type) + { + // Generate full HTML for type... + return $"..."; + } +} + +// Register +services.AddDocRenderer(); +``` + +## Performance Considerations + + + + `AssemblyManager` caches compiled assemblies and only rebuilds when files change or configuration changes. Reuse `AssemblyManager` instances for incremental builds. + + + + Conceptual content loading happens in parallel per assembly. Multiple assemblies process simultaneously without blocking. + + + + `DocumentationManager`, enrichers, transformers, and renderers are registered as Scoped to enable parallel processing in web scenarios. + + + + Dispose of `DocumentationManager` when done to release assembly manager caches and free memory. Use `using` statements or DI scope disposal. + + + +## Troubleshooting + + + + **Problem**: Assembly processes but has no XML documentation + + **Solution**: + - Ensure XML file path is correct + - Check that `GenerateDocumentationFile` is enabled in your `.csproj` + - Verify XML file is copied to output directory + - Check the `Errors` collection on `AssemblyManager` for warnings + + + + **Problem**: Internal types don't appear in documentation + + **Solution**: + ```csharp + context.IncludedMembers = new List + { + Accessibility.Public, + Accessibility.Internal // Add this + }; + ``` + + Make sure your assembly has `[assembly: InternalsVisibleTo("DotNetDocs")]`. + + + + **Problem**: Conceptual `.mdz` files aren't appearing in output + + **Solution**: + - Verify `ConceptualDocsEnabled = true` + - Check that `ConceptualPath` points to the correct directory + - Ensure `.mdz` files are in the correct namespace/type/member hierarchy + - If using `ShowPlaceholders = false`, remove the TODO comment from files + + + + **Problem**: Renderers overwriting each other's output + + **Solution**: Configure different output paths for each renderer: + + ```csharp + services.AddDotNetDocsPipeline(pipeline => + { + pipeline + .ConfigureContext(ctx => ctx.DocumentationRootPath = "docs/markdown") + .UseMarkdownRenderer(); + }); + + services.Configure(options => + { + options.OutputPath = "docs/json"; + }); + ``` + + + + **Problem**: Pipeline runs out of memory processing large assemblies + + **Solution**: + - Process assemblies one at a time instead of all together + - Disable conceptual docs if not needed: `ConceptualDocsEnabled = false` + - Dispose of `DocumentationManager` after each assembly + - Reduce `IncludedMembers` to only public members + + + +## See Also + + + + Learn about the conceptual documentation system + + + + Use the Mintlify renderer for beautiful docs + + + + Complete ProjectContext API reference + + + + Complete DocumentationManager API reference + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/index.mdx new file mode 100644 index 0000000..4dc5f77 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/index.mdx @@ -0,0 +1,21 @@ +--- +title: DotNetDocs - Documentation That Ships With Your Code +sidebarTitle: Home +description: Transform your .NET XML comments into stunning, searchable documentation sites. Zero config. Full control. +mode: "custom" +icon: house +--- + +import { SaaSHero } from '/snippets/test/SaaSHero.jsx'; +import { ValueProposition } from '/snippets/test/ValueProposition.jsx'; +import { FeatureShowcase } from '/snippets/test/FeatureShowcase.jsx'; +import { MintlifyPartnership } from '/snippets/test/MintlifyPartnership.jsx'; +import { CTASection } from '/snippets/test/CTASection.jsx'; + +
+ + + + + +
\ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/bridge-assemblies.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/bridge-assemblies.mdx new file mode 100644 index 0000000..4dcf7a5 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/bridge-assemblies.mdx @@ -0,0 +1,384 @@ +--- +title: "Bridge Assemblies: The Key to LLM-Ready Internal Documentation" +sidebarTitle: Bridge Assemblies +description: "How we solved the InternalsVisibleTo limitation to help internal teams create comprehensive documentation that supercharges LLM-assisted development." +icon: "bridge" +--- + +Picture this: You're part of an internal development team that's built an amazing library with thoughtful internal APIs, well-structured helper classes, +and carefully designed implementation patterns. Your team wants to leverage AI coding assistants like GitHub Copilot or Claude to help write better code +against your internal systems. + +But there's a problem. **LLMs can only help you with what they can see.** And traditional documentation tools? They can only document public APIs, leaving +a massive blind spot in your internal architecture. + +This is the story of how we solved that problem with a technique we call "bridge assemblies" - and why it matters more now than ever in the age of +LLM-assisted development. + + +This technique is designed specifically for documentation generation and analysis tools. It should not be used in production code to bypass normal +encapsulation principles. + + +## The Internal Documentation Problem + +It used to be that great documentation was only really needed for Component Libraries. For 25 years, internal teams got the short shrift when it came to +docs. So when looking at everything we wanted in a modern documentation system, we wanted it to build beautiful content for internal teams as well. + +We'd seen too many organizations struggle with incomplete documentation that left developers guessing about implementation details. The promise was simple: +**create comprehensive documentation that would make LLMs incredibly effective at helping teams write code against their internal systems.** + +But we quickly hit a wall. Consider this typical internal library structure: + +```csharp +namespace MyCompany.PaymentProcessing +{ + /// + /// Processes payment requests with comprehensive validation and error handling. + /// + /// + /// This processor uses internal validation logic and error handling patterns + /// that are crucial for understanding the complete payment flow. + /// + public class PaymentProcessor + { + /// + /// Processes a payment request asynchronously with full validation. + /// + /// The payment request containing all necessary payment information. + /// A task representing the asynchronous operation, containing the payment result. + /// Thrown when is null. + public async Task ProcessPaymentAsync(PaymentRequest request) + { + var validator = new PaymentValidator(); // ❌ Internal class - invisible + var result = await validator.ValidateAsync(request); + + if (!result.IsValid) + return PaymentResult.Failed(result.Errors); + + return await ExecutePaymentAsync(request); // ❌ Internal method - invisible + } + + /// + /// Executes the actual payment processing after validation. + /// + /// The validated payment request. + /// The payment processing result. + /// + /// This method handles the core payment logic including gateway communication, + /// retry logic, and transaction logging. + /// + internal async Task ExecutePaymentAsync(PaymentRequest request) + { + // Core payment processing logic + return PaymentResult.Success(); + } + } + + /// + /// Provides comprehensive validation for payment requests. + /// + /// + /// ❌ Completely invisible to documentation tools + /// + internal class PaymentValidator + { + /// + /// Validates a payment request against all business rules and compliance requirements. + /// + /// The payment request to validate. + /// A task containing the validation result with detailed error information. + /// Thrown when is null. + internal async Task ValidateAsync(PaymentRequest request) + { + // Rich validation logic that developers need to understand + return await PerformComplexValidation(request); + } + + /// + /// Performs complex validation including fraud detection and compliance checks. + /// + /// The payment request to validate. + /// A detailed validation result. + private async Task PerformComplexValidation(PaymentRequest request) + { + // Implementation details that help understand the validation patterns + return ValidationResult.Valid(); + } + } +} +``` + +Traditional documentation tools would generate docs showing only the public `ProcessPaymentAsync` method. But developers working with this system need to +understand: + +- How validation works internally +- What helper classes are available +- The patterns used for error handling +- The complete flow of payment processing + +Without this context, LLMs can only provide generic suggestions instead of system-specific guidance. + +## The Traditional Solution: InternalsVisibleTo + +.NET provides `InternalsVisibleTo` for scenarios where you need to expose internal members: + +```csharp +// In AssemblyInfo.cs or as an assembly attribute +[assembly: InternalsVisibleTo("MyCompany.PaymentProcessing.Tests")] +[assembly: InternalsVisibleTo("MyCompany.PaymentProcessing.Documentation")] +``` + +This approach works great when you know the target assembly name at compile time. The problem? **DotNetDocs runs as a post-build tool, analyzing +already-compiled assemblies.** We can't predict what our tool will be called, and we certainly can't ask every team to modify their `AssemblyInfo.cs` +just to generate better documentation. + +Plus, `InternalsVisibleTo` requires the source assembly to be recompiled with knowledge of the consuming assembly. That's exactly the opposite of what we +needed - we wanted to analyze existing assemblies without any modifications. + +## Enter the Strathweb Solution + +Our breakthrough came from an ingenious blog post by Filip W on [bypassing C# visibility rules with Roslyn](https://www.strathweb.com/2018/10/no-internalvisibleto-no-problem-bypassing-c-visibility-rules-with-roslyn/). +Filip discovered that the .NET runtime includes a little-known attribute called `IgnoresAccessChecksToAttribute` that can bypass visibility checks entirely. + +Here's the key insight: while `InternalsVisibleTo` works at compile-time and requires the source assembly to "opt-in" to visibility, +`IgnoresAccessChecksToAttribute` works at the consumer side - the assembly that wants to see internals declares that it should ignore access checks for a +specific target assembly. + +Filip's original example showed how to access internal members of a third-party library: + +```csharp +// This is what Filip demonstrated +namespace System.Runtime.CompilerServices +{ + [AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)] + internal sealed class IgnoresAccessChecksToAttribute : Attribute + { + public string AssemblyName { get; } + public IgnoresAccessChecksToAttribute(string assemblyName) + { + AssemblyName = assemblyName; + } + } +} + +// Apply it to gain access +[assembly: IgnoresAccessChecksTo("ThirdPartyLibrary")] +``` + +But Filip's approach still required knowing the target assembly at compile time. We needed something more dynamic. + +## Our Innovation: Dynamic Bridge Assemblies + +The breakthrough was realizing we could create these "bridge" assemblies dynamically using Roslyn. Instead of pre-compiling an assembly with +`IgnoresAccessChecksTo`, we generate the bridge assembly on-the-fly for each target assembly we want to document. + +Here's how our `CreateCompilationAsync` method works: + +```csharp +internal async Task CreateCompilationAsync(IEnumerable references) +{ + // Step 1: Generate the IgnoresAccessChecksTo attribute dynamically + // We can't rely on it being available in all target frameworks + var ignoresAccessChecksSource = @" + namespace System.Runtime.CompilerServices + { + [System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple = true)] + internal sealed class IgnoresAccessChecksToAttribute : System.Attribute + { + public string AssemblyName { get; } + public IgnoresAccessChecksToAttribute(string assemblyName) + { + AssemblyName = assemblyName; + } + } + }"; + + // Step 2: Create a bridge assembly that references the target + var assemblyName = Path.GetFileNameWithoutExtension(AssemblyPath); + var bridgeSource = $@" + using System.Runtime.CompilerServices; + [assembly: IgnoresAccessChecksTo(""{assemblyName}"")]"; + + // Step 3: Parse both pieces of source code + var syntaxTrees = new[] + { + CSharpSyntaxTree.ParseText(ignoresAccessChecksSource), + CSharpSyntaxTree.ParseText(bridgeSource) + }; + + // Step 4: Create compilation with enhanced metadata import + var compilationOptions = new CSharpCompilationOptions( + OutputKind.DynamicallyLinkedLibrary, + metadataImportOptions: MetadataImportOptions.All); // 🔑 Critical setting + + var compilation = CSharpCompilation.Create($"{AssemblyName}.DocumentationBridge") + .WithOptions(compilationOptions) + .AddSyntaxTrees(syntaxTrees) + .AddReferences(targetReference); + + return compilation; +} +``` + +### Why Dynamic Generation? + +You might wonder: "Why not just add `IgnoresAccessChecksToAttribute` directly to DotNetDocs.Core?" The answer reveals a fundamental limitation of how .NET +assembly loading works: + +1. **Assembly Identity Matters**: The `IgnoresAccessChecksTo` attribute must be applied to the assembly that's requesting access. We can't pre-compile this +into DotNetDocs.Core because we don't know what assemblies we'll be analyzing. + +2. **Runtime vs. Compile-time**: The attribute needs to be present when the Roslyn compilation analyzes the target assembly. By generating it dynamically, +we create a fresh "bridge" compilation for each target. + +3. **Framework Compatibility**: The `IgnoresAccessChecksToAttribute` isn't available in all .NET versions. By generating it ourselves, we ensure compatibility +across frameworks. + +4. **Symbol Resolution**: The combination of `MetadataImportOptions.All` and the bridge assembly tells Roslyn's symbol resolution engine to treat internal +members as accessible. + +## The Magic Behind the Scenes + + + + DotNetDocs loads the target assembly and extracts its name for the bridge compilation. + + + + We dynamically generate the `IgnoresAccessChecksToAttribute` since it's not universally available. + + + + A new Roslyn compilation is created that applies the attribute to ignore access checks for the specific target assembly. + + + + With `MetadataImportOptions.All` and the bridge attribute, Roslyn's symbol API now treats internal members as accessible. + + + + We can now traverse and document the complete API surface, including internal implementations. + + + +## Real-World Impact for LLM-Assisted Development + +This technique transforms what's possible with LLM-assisted development for internal teams. Consider how much more helpful an AI coding assistant becomes +when it has access to complete API documentation: + + + + ```typescript + // LLM can only suggest generic patterns + User: "How do I validate a payment request?" + + LLM: "You can call ProcessPaymentAsync() but I don't have + information about the validation logic or error handling patterns." + ``` + + + ```typescript + // LLM has full context of internal APIs + User: "How do I validate a payment request?" + + LLM: "Based on your PaymentProcessor implementation, you can: + 1. Use PaymentValidator.ValidateAsync() for the same validation logic + 2. Handle ValidationResult.Errors for consistent error messaging + 3. Follow the ComplexValidation pattern for custom rules + + Here's an example using your internal APIs..." + ``` + + + +The documentation generated with bridge assemblies includes: + + + + Complete method signatures, parameter details, and usage patterns for internal helper classes + + + + Utility classes and their methods that teams can leverage in their own code + + + + +## Technical Deep Dive + +### Performance Considerations + + +Bridge compilations are cached based on the target assembly's last modified time and the set of included members. This means we only regenerate the bridge when the target assembly actually changes, making incremental builds very fast. + + + +The `AssemblyManager` implements `IDisposable` to properly clean up the Roslyn compilation and associated memory. This is crucial when processing multiple assemblies in batch operations. + + +### Security and Boundaries + + +The bridge assembly technique only works during documentation generation. It doesn't create runtime access to internal members - the generated documentation simply describes what's available. + + + +Our documentation clearly marks internal APIs as such, warning developers that these are implementation details that may change. We're not encouraging misuse of internal APIs, just providing complete context. + + +## Best Practices for Internal Teams + +When using DotNetDocs with bridge assemblies for internal documentation: + + + + - Use comprehensive XML documentation on internal members + - Structure internal APIs with the same care as public ones + - Include examples in internal API documentation + - Consider internal APIs as part of your team's knowledge base + - Use the generated docs to onboard new team members + + + + - Documenting truly sensitive internal details + - Treating internal APIs as stable public contracts + - Bypassing normal code review for internal changes + - Using this technique in production application code + + + +## Looking Forward: The LLM Documentation Revolution + +As LLMs become increasingly central to software development, the quality and completeness of our documentation becomes a competitive advantage. Teams with +comprehensive internal documentation can leverage AI assistants much more effectively than those with incomplete docs. + +Bridge assemblies represent just one piece of this puzzle, but it's a crucial one. By giving LLMs complete context about how our systems work internally, we +enable them to provide much more valuable assistance. + + +This is why we built DotNetDocs specifically for internal teams. Public API documentation is a solved problem - but helping teams document and leverage their +internal systems? That's where the real productivity gains live. + + +## Conclusion + +The bridge assembly technique started as a solution to a technical problem: how do you document internal APIs when traditional tools can't see them? But it's +evolved into something much more significant - a key enabler for LLM-assisted development in enterprise environments. + +By dynamically generating `IgnoresAccessChecksTo` attributes through Roslyn compilations, we've unlocked the ability to create comprehensive documentation +that tells the complete story of how internal systems work. This isn't just about better docs - it's about making AI coding assistants exponentially more +helpful for internal development teams. + +The next time you're working with an AI coding assistant and wish it understood your internal systems better, remember: the quality of the assistant's help +is directly related to the quality of the documentation it can access. Bridge assemblies help ensure that documentation tells the whole story. + + +Want to see this technique in action? Check out our [AssemblyManager implementation](https://github.com/CloudNimble/DotNetDocs) for the complete source code, +or try DotNetDocs on your own internal libraries. + + +--- + +*This technique builds on Filip W's excellent research on [bypassing C# visibility rules with Roslyn](https://www.strathweb.com/2018/10/no-internalvisibleto-no-problem-bypassing-c-visibility-rules-with-roslyn/). +We've adapted and extended his approach specifically for dynamic documentation generation scenarios.* \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/converter-infinite-recursion.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/converter-infinite-recursion.mdx new file mode 100644 index 0000000..24e6242 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/converter-infinite-recursion.mdx @@ -0,0 +1,445 @@ +--- +title: "Taming System.Text.Json Infinite Recursion in Custom Converters" +sidebarTitle: Converter Recursion +description: "How we solved a critical infinite recursion bug in JSON serialization that was causing stack overflows during documentation generation, and the elegant solution that prevents it." +icon: "arrows-spin" +--- + +You're deep in a complex C# project when suddenly your JSON serialization starts throwing `StackOverflowException`. The stack trace shows your custom `JsonConverter` calling itself infinitely. Sound familiar? + +This is the story of how we discovered, diagnosed, and solved a subtle but critical bug in our JSON serialization pipeline that was causing documentation generation to fail spectacularly - and how our solution can prevent similar issues in any System.Text.Json-based application. + + +This problem affects any System.Text.Json custom converter that calls `JsonSerializer.Serialize()` or `JsonSerializer.Deserialize()` with the same `JsonSerializerOptions` that contains the converter itself. + + +## The Problem: When Good Converters Go Bad + +Our DotNetDocs system uses a sophisticated JSON serialization pipeline for handling Mintlify documentation configuration. We had custom converters for polymorphic types like icons (which could be simple strings or complex objects), API configurations, and background images. + +Everything worked perfectly until we started implementing ServerConfig support with implicit operators, following the same pattern as our successful IconConfig implementation. That's when the documentation generation process started crashing with stack overflow errors during the final serialization step. + +Here's what a typical problematic converter looked like: + +```csharp +public class IconConverter : JsonConverter +{ + public override IconConfig? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return reader.TokenType switch + { + JsonTokenType.String => new IconConfig { Name = reader.GetString() ?? string.Empty }, + JsonTokenType.StartObject => JsonSerializer.Deserialize(ref reader, options), // ⚠️ Problem! + JsonTokenType.Null => null, + _ => throw new JsonException($"Unexpected token type for icon: {reader.TokenType}") + }; + } + + public override void Write(Utf8JsonWriter writer, IconConfig? value, JsonSerializerOptions options) + { + if (value is null) + { + writer.WriteNullValue(); + return; + } + + // If only Name is set (simple icon), write as string + if (!string.IsNullOrWhiteSpace(value.Name) && + string.IsNullOrWhiteSpace(value.Library) && + string.IsNullOrWhiteSpace(value.Style)) + { + writer.WriteStringValue(value.Name); + } + else + { + // Write as object for complex configurations + JsonSerializer.Serialize(writer, value, options); // ⚠️ Problem! + } + } +} +``` + +The issue was subtle but deadly: **both the `Read` and `Write` methods were passing the same `options` parameter back to `JsonSerializer`, which included the converter itself, creating infinite recursion.** + +## The Diagnosis: Stack Overflow Detective Work + +Initially, we thought the problem was with our new ServerConfig implementation. The error messages pointed to MdxConfig.Server serialization failures, and the timing coincided with our ServerConfig changes. + +But as we dug deeper, we realized this was a fundamental flaw in how we were implementing our custom converters. The stack trace revealed the true culprit: + +``` +Stack overflow. + at Mintlify.Core.Converters.IconConverter.Read(...) + at System.Text.Json.JsonSerializer.Deserialize(...) + at Mintlify.Core.Converters.IconConverter.Read(...) + at System.Text.Json.JsonSerializer.Deserialize(...) + [... repeats infinitely] +``` + +The recursion happened because: + + + + Our converter was registered in `MintlifyConstants.JsonSerializerOptions` + + + + When serializing an object containing an IconConfig, the converter's `Write` method was called + + + + The converter called `JsonSerializer.Serialize(writer, value, options)` with the same options + + + + Since the options contained the same converter, it immediately called the converter again + + + + This process repeated until the stack overflowed + + + +## The Research: Learning from the Community + +A deep dive into System.Text.Json documentation and Stack Overflow revealed this is a well-known problem. The core issue is that **when you call `JsonSerializer.Serialize()` or `JsonSerializer.Deserialize()` from within a converter, you must be careful about which options you pass**. + +The most common solutions were: + +1. **Pass no options**: `JsonSerializer.Serialize(writer, value)` - loses all configuration +2. **Create new options**: Build a fresh `JsonSerializerOptions` without converters +3. **Use proxy types**: Create wrapper types without the `[JsonConverter]` attribute +4. **Manual serialization**: Write JSON properties manually without using the serializer + +Each approach had trade-offs, but none felt elegant for our complex nested object scenarios. + +## Our Innovation: Self-Excluding Options + +The breakthrough came from a simple but powerful insight: **what if each converter maintained its own copy of the serialization options with itself removed?** + +This approach would: +- ✅ Preserve all other converters for nested objects +- ✅ Maintain the same configuration (naming policies, etc.) +- ✅ Be thread-safe through lazy initialization +- ✅ Be testable and verifiable + +Here's our solution: + +```csharp +public class IconConverter : JsonConverter +{ + #region Private Fields + + /// + /// Lazy-initialized JsonSerializerOptions that excludes this converter to prevent infinite recursion. + /// + private static readonly Lazy _optionsWithoutThis = new Lazy(() => + { + var options = new JsonSerializerOptions(MintlifyConstants.JsonSerializerOptions); + // Remove this converter to prevent recursion + for (int i = options.Converters.Count - 1; i >= 0; i--) + { + if (options.Converters[i] is IconConverter) + { + options.Converters.RemoveAt(i); + } + } + return options; + }); + + /// + /// Gets the JsonSerializerOptions instance without this converter to prevent infinite recursion. + /// + internal static JsonSerializerOptions OptionsWithoutThis => _optionsWithoutThis.Value; + + #endregion + + public override IconConfig? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + return reader.TokenType switch + { + JsonTokenType.String => new IconConfig { Name = reader.GetString() ?? string.Empty }, + JsonTokenType.StartObject => JsonSerializer.Deserialize(ref reader, OptionsWithoutThis), // ✅ Fixed! + JsonTokenType.Null => null, + _ => throw new JsonException($"Unexpected token type for icon: {reader.TokenType}") + }; + } + + public override void Write(Utf8JsonWriter writer, IconConfig? value, JsonSerializerOptions options) + { + if (value is null) + { + writer.WriteNullValue(); + return; + } + + if (!string.IsNullOrWhiteSpace(value.Name) && + string.IsNullOrWhiteSpace(value.Library) && + string.IsNullOrWhiteSpace(value.Style)) + { + writer.WriteStringValue(value.Name); + } + else + { + JsonSerializer.Serialize(writer, value, OptionsWithoutThis); // ✅ Fixed! + } + } +} +``` + +### Why This Approach Works + + + + Each converter creates options that exclude only itself, preventing direct recursion while preserving all other converters + + + + Complex objects can still use other converters for their properties (like GroupConfig with Icon properties) + + + + All JsonSerializerOptions settings (naming policy, null handling, etc.) are preserved + + + + Lazy initialization ensures the options are created once and safely shared across threads + + + +## Verification Through Testing + +To ensure our solution worked correctly, we created comprehensive unit tests that verify both the recursion prevention and the functional correctness: + +```csharp +[TestMethod] +public void OptionsWithoutThis_ExcludesIconConverter() +{ + var originalOptions = MintlifyConstants.JsonSerializerOptions; + var optionsWithoutThis = IconConverter.OptionsWithoutThis; + + // Should not be the same instance + optionsWithoutThis.Should().NotBeSameAs(originalOptions); + + // Original should have IconConverter + originalOptions.Converters.Should().Contain(c => c is IconConverter); + + // OptionsWithoutThis should NOT have IconConverter + optionsWithoutThis.Converters.Should().NotContain(c => c is IconConverter); + + // Should preserve other important settings + optionsWithoutThis.PropertyNamingPolicy.Should().Be(originalOptions.PropertyNamingPolicy); + optionsWithoutThis.DefaultIgnoreCondition.Should().Be(originalOptions.DefaultIgnoreCondition); +} + +[TestMethod] +public void Serialize_GroupConfigWithIcon_NoStackOverflow() +{ + var group = new GroupConfig + { + Group = "API Reference", + Icon = new IconConfig { Name = "folder" } + }; + + var act = () => JsonSerializer.Serialize(group, MintlifyConstants.JsonSerializerOptions); + + act.Should().NotThrow(); // This would throw StackOverflowException before the fix + var json = act(); + json.Should().Contain("\"group\": \"API Reference\""); + json.Should().Contain("\"icon\": \"folder\""); +} +``` + +These tests proved that: +- ✅ The converter exclusion logic works correctly +- ✅ Nested objects serialize without stack overflow +- ✅ Both simple and complex serialization scenarios work +- ✅ Configuration settings are preserved + +## Real-World Impact + +The fix resolved several critical issues in our documentation generation pipeline: + + + + ```bash + # Documentation generation would fail with: + Stack overflow. + at Mintlify.Core.Converters.IconConverter.Write(...) + at System.Text.Json.JsonSerializer.Serialize(...) + [... infinite recursion] + + # Result: No documentation generated, complete build failure + ``` + + + ```bash + # Documentation generation succeeds: + 📊 Documentation Statistics: + 📄 Documentation type: Mintlify + 📦 Assemblies processed: 5 + 📝 Files generated: 125 + ✅ Documentation generation completed successfully + + # Result: Complete documentation with preserved template structure + ``` + + + +### Performance Benefits + + +The options are computed once per converter type and cached, making subsequent serializations very fast. The overhead is minimal - just one additional property access. + + + +Each converter type maintains only one additional JsonSerializerOptions instance, and the lazy initialization ensures they're only created when actually needed. + + +## Implementation Guide + +To implement this pattern in your own converters: + + + + Create a lazy-initialized field that copies your main options and removes the current converter: + ```csharp + private static readonly Lazy _optionsWithoutThis = + new Lazy(() => + { + var options = new JsonSerializerOptions(YourConstants.JsonSerializerOptions); + for (int i = options.Converters.Count - 1; i >= 0; i--) + { + if (options.Converters[i] is YourConverter) + { + options.Converters.RemoveAt(i); + } + } + return options; + }); + ``` + + + + Add a property (make it internal for testing): + ```csharp + internal static JsonSerializerOptions OptionsWithoutThis => _optionsWithoutThis.Value; + ``` + + + + Replace any calls to `JsonSerializer` that pass the original options: + ```csharp + // Replace this: + JsonSerializer.Deserialize(ref reader, options) + + // With this: + JsonSerializer.Deserialize(ref reader, OptionsWithoutThis) + ``` + + + + Create tests to verify the converter exclusion works and serialization doesn't cause stack overflow + + + +## Anti-Patterns to Avoid + + + + ```csharp + // Passing the same options that contain your converter + JsonSerializer.Serialize(writer, value, options); + + // Creating options without any converters + JsonSerializer.Serialize(writer, value, new JsonSerializerOptions()); + + // Manually checking for recursion with static flags + private static bool _isSerializing = false; + ``` + + + + ```csharp + // Use options that exclude your converter + JsonSerializer.Serialize(writer, value, OptionsWithoutThis); + + // Preserve configuration while excluding problematic converters + var safeOptions = new JsonSerializerOptions(originalOptions); + // ... remove only the problematic converters + + // Use lazy initialization for thread safety and performance + private static readonly Lazy _safeOptions = ... + ``` + + + +## Advanced Considerations + +### Multiple Converter Dependencies + +If your converters depend on each other, you might need more sophisticated exclusion logic: + +```csharp +private static readonly Lazy _optionsWithoutThis = + new Lazy(() => + { + var options = new JsonSerializerOptions(MintlifyConstants.JsonSerializerOptions); + + // Remove converters that could cause recursion + for (int i = options.Converters.Count - 1; i >= 0; i--) + { + var converter = options.Converters[i]; + if (converter is IconConverter or RelatedConverter) + { + options.Converters.RemoveAt(i); + } + } + return options; + }); +``` + +### Framework Compatibility + +This pattern works across all .NET versions that support System.Text.Json, including: +- ✅ .NET 8.0+ +- ✅ .NET Core 3.1+ +- ✅ .NET Framework 4.6.2+ (with NuGet package) + +## Looking Forward: Preventing Future Issues + +This experience taught us valuable lessons about System.Text.Json converter development: + + + + Every custom converter should have unit tests that verify it doesn't cause stack overflow in nested scenarios + + + + Maintain clear patterns for how JsonSerializerOptions are used within converters + + + + Use lazy initialization for computed options to ensure thread safety and performance + + + + Make critical internal logic testable with internal access modifiers + + + +## Conclusion + +The infinite recursion bug in our JSON converters was a subtle but critical issue that completely broke our documentation generation pipeline. What started as a mysterious stack overflow turned into an opportunity to create a robust, testable solution that prevents similar issues across our entire codebase. + +The key insight was that **converters need to exclude themselves from recursive serialization calls while preserving all other configuration**. Our self-excluding options pattern achieves this elegantly with minimal performance overhead and maximum maintainability. + +This isn't just about fixing a bug - it's about understanding the fundamental principles of how System.Text.Json converters work and building resilient patterns that prevent entire categories of problems. The lazy-initialized, self-excluding options approach can be applied to any custom converter that needs to call back into the serializer. + + +The complete source code for our converter implementations is available in the [DotNetDocs repository](https://github.com/CloudNimble/DotNetDocs), including all unit tests that verify the recursion prevention works correctly. + + +--- + +*Special thanks to the System.Text.Json team and the broader .NET community whose documentation and Stack Overflow answers helped us understand the underlying principles that made this solution possible.* \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/sdk-packaging.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/sdk-packaging.mdx new file mode 100644 index 0000000..db81e79 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/learnings/sdk-packaging.mdx @@ -0,0 +1,287 @@ +--- +title: Packaging Project-Style SDKs +sidebarTitle: Packaging SDK Projects +description: Learn how to properly structure and package MSBuild SDKs with compiled tasks to avoid file lock issues +icon: boxes-packing +--- + +# MSBuild SDK Packaging Best Practices + +Building MSBuild SDKs with compiled tasks presents unique challenges, particularly around file locking during development. This guide documents Microsoft's patterns and best practices for creating robust, maintainable MSBuild SDK packages. + +## The File Lock Problem + +When developing MSBuild SDKs that include compiled tasks, a common issue arises: + +1. The SDK project compiles its task assemblies +2. The same build process attempts to load those assemblies +3. MSBuild locks the loaded assemblies in memory +4. Subsequent builds fail because the compiler cannot overwrite locked files + +This creates a frustrating development cycle where you must kill MSBuild processes or restart Visual Studio between builds. + +## Microsoft's Solution Pattern + +Microsoft addresses this challenge through architectural separation and careful build orchestration. + +### 1. Separation of Concerns Architecture + +Microsoft separates SDK projects into distinct components: + +- **Task Projects** (`Microsoft.NET.Build.Tasks`) - Contains compiled MSBuild tasks +- **SDK Projects** (`Microsoft.Build.NoTargets`) - Contains props/targets files and SDK structure +- **Test Projects** - Separate unit test projects for each component + +This separation ensures that task compilation and SDK packaging never occur in the same build context. + +### 2. The NoTargets Pattern + +Microsoft created `Microsoft.Build.NoTargets` specifically for projects that don't compile assemblies but need MSBuild integration: + +```xml + + + netstandard2.0 + MSBuildSdk + true + true + + +``` + +This SDK type prevents assembly compilation while maintaining full MSBuild extensibility. + +### 3. Task Assembly Packaging Configuration + +For SDKs with compiled tasks, Microsoft uses specific packaging properties: + +```xml + + + tasks + + + true + MSBuildSdk + + + true + + + $(NoWarn);NU5128;NU5100 + + + false + +``` + +### 4. Standard Directory Structure + +Microsoft's SDK packages follow this consistent structure: + +``` +package/ +├── Sdk/ +│ ├── Sdk.props # Imported at project start +│ └── Sdk.targets # Imported at project end +├── tasks/ +│ ├── net472/ # .NET Framework tasks +│ │ ├── TaskAssembly.dll +│ │ └── Dependencies.dll +│ └── net8.0/ # .NET Core/5+ tasks +│ ├── TaskAssembly.dll +│ └── Dependencies.dll +├── build/ +│ ├── PackageName.props +│ └── PackageName.targets +└── buildMultiTargeting/ + ├── PackageName.props + └── PackageName.targets +``` + +### 5. Multi-Stage Build Process + +Microsoft avoids file locks through a multi-stage approach: + +1. **Stage 1**: Build task assemblies in an isolated project +2. **Stage 2**: Package pre-built assemblies into the SDK +3. **Stage 3**: Test the packaged SDK in a separate solution + +The key insight: **The SDK project never compiles and uses its own tasks simultaneously**. + +### 6. Runtime-Aware Task Loading + +In Sdk.targets files, Microsoft uses runtime detection for task loading: + +```xml + + + <_DotNetDocsTaskFramework Condition="'$(MSBuildRuntimeType)' == 'Core'">net8.0 + <_DotNetDocsTaskFramework Condition="'$(MSBuildRuntimeType)' == 'Full'">net472 + <_DotNetDocsTaskFramework Condition="'$(_DotNetDocsTaskFramework)' == ''">net8.0 + + + <_DotNetDocsTasksFolder>$(MSBuildThisFileDirectory)..\tasks\$(_DotNetDocsTaskFramework) + <_DotNetDocsTasksAssembly>$(_DotNetDocsTasksFolder)\CloudNimble.DotNetDocs.Sdk.dll + + + + +``` + +### 7. Development vs. Package Detection + +Microsoft SDKs intelligently detect their execution context: + +```xml + + + <_IsPackaged Condition="Exists('$(MSBuildThisFileDirectory)..\tasks')">true + + + <_IsDevelopment Condition="Exists('$(MSBuildThisFileDirectory)..\Tasks\*.cs')">true + + + <_TaskAssembly Condition="'$(_IsPackaged)' == 'true'"> + $(MSBuildThisFileDirectory)..\tasks\$(_TaskFramework)\Assembly.dll + + <_TaskAssembly Condition="'$(_IsDevelopment)' == 'true'"> + $(MSBuildThisFileDirectory)..\bin\$(Configuration)\$(_TaskFramework)\Assembly.dll + + +``` + +### 8. Preventing Circular Dependencies + +The fundamental principle: **The SDK project must never load its own compiled tasks during its own build**. + +Strategies to achieve this: + +```xml + + + false + true + + + +``` + +## Recommended Solution Architecture + +For a robust MSBuild SDK with compiled tasks, use this three-project structure: + +### Project 1: Task Library +`CloudNimble.DotNetDocs.Sdk.Tasks.csproj` +```xml + + + net472;net8.0 + false + + + + + + + +``` + +### Project 2: SDK Package +`CloudNimble.DotNetDocs.Sdk.csproj` +```xml + + + netstandard2.0 + MSBuildSdk + true + true + + + + + + + + + + + +``` + +### Project 3: Integration Tests +`CloudNimble.DotNetDocs.Sdk.Tests.csproj` +```xml + + + net8.0 + + + + + + + +``` + +## Development Workflow + +1. **Build Tasks First**: Always build the tasks project independently +2. **Then Package**: Build the SDK project to create the package +3. **Test Separately**: Use a different solution to test the packaged SDK +4. **Use Local Feeds**: Configure a local NuGet feed for development testing + +```bash +# Build script example +dotnet build CloudNimble.DotNetDocs.Sdk.Tasks.csproj -c Release +dotnet pack CloudNimble.DotNetDocs.Sdk.csproj -c Release +dotnet nuget push *.nupkg -s local-feed +``` + +## Additional Best Practices + +### Disable Node Reuse During Development + +Add to `Directory.Build.props` in your development folder: + +```xml + + 1 + +``` + +### Use Intermediate Output Directories + +Avoid conflicts by using unique output paths: + +```xml + + $(MSBuildThisFileDirectory)obj\$(MSBuildProjectName)\ + $(MSBuildThisFileDirectory)bin\$(MSBuildProjectName)\ + +``` + +### Version Your Task Assemblies + +Include version numbers in task assembly paths during development: + +```xml + + 1.0.0 + <_TaskAssembly>$(MSBuildThisFileDirectory)..\tasks\$(TaskVersion)\$(_TaskFramework)\Assembly.dll + +``` + +## Conclusion + +By following Microsoft's patterns of separation, staged builds, and careful dependency management, you can create robust MSBuild SDKs without encountering file lock issues. The key is ensuring your SDK project never attempts to compile and load its own tasks within the same build context. + +Remember: **Separate concerns, build in stages, and test in isolation**. \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/plugins/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/plugins/index.mdx new file mode 100644 index 0000000..61ae1ad --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/plugins/index.mdx @@ -0,0 +1,5 @@ +--- +title: Coming Soon! +sidebarTitle: Coming Soon! +icon: rocket +--- \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/index.mdx new file mode 100644 index 0000000..16342e8 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/index.mdx @@ -0,0 +1,6 @@ +--- +title: Documentation Providers +sidebarTitle: Overview +description: Go beyond the basics to get the most out of your documentation host. +icon: rocket +--- \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/dotnet-library.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/dotnet-library.mdx new file mode 100644 index 0000000..cdfd10f --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/dotnet-library.mdx @@ -0,0 +1,938 @@ +--- +title: .NET Library for Mintlify +sidebarTitle: .NET Library +description: Use Mintlify.Core to programmatically create, validate, and manage Mintlify docs.json configurations in C# with full type safety and IntelliSense support +icon: code +--- + +Mintlify.Core is a comprehensive .NET library that provides strongly-typed models, validation, and management tools for Mintlify documentation configurations. Built by the +CloudNimble team and used by DotNetDocs, it enables C# developers to programmatically generate, modify, and validate `docs.json` files with full IntelliSense support. + +## Why Use Mintlify.Core? + + + + Strongly-typed C# models for every Mintlify configuration option with compile-time validation + + + Full XML documentation on every property with examples and schema references + + + Comprehensive validation against Mintlify schema ensures configurations will work before deployment + + + Targets .NET Standard 2.0, .NET 8, .NET 9, and .NET 10 for maximum compatibility + + + Advanced DocsJsonManager for intelligent navigation merging and duplicate detection + + + Battle-tested in DotNetDocs and used by Sustainment for managing complex documentation sites + + + +## Installation + +Install via NuGet Package Manager or .NET CLI: + + +```bash .NET CLI +dotnet add package Mintlify.Core +``` + +```xml PackageReference + +``` + +```powershell Package Manager +Install-Package Mintlify.Core +``` + + +## Quick Start + +Create a basic Mintlify configuration programmatically: + +```csharp +using Mintlify.Core; +using Mintlify.Core.Models; + +// Create a default configuration +var config = DocsJsonManager.CreateDefault("My Project", "maple"); + +// Customize colors +config.Colors.Primary = "#419AC5"; +config.Colors.Light = "#419AC5"; +config.Colors.Dark = "#3CD0E2"; + +// Add logo +config.Logo = new LogoConfig +{ + Light = "/images/logo-light.svg", + Dark = "/images/logo-dark.svg" +}; + +// Create navigation groups +config.Navigation.Pages = new List +{ + new GroupConfig + { + Group = "Getting Started", + Icon = new IconConfig { Name = "rocket" }, + Pages = new List { "index", "quickstart", "installation" } + }, + new GroupConfig + { + Group = "API Reference", + Icon = new IconConfig { Name = "code" }, + Pages = new List { "api-reference/index" } + } +}; + +// Serialize to JSON +var json = JsonSerializer.Serialize(config, MintlifyConstants.JsonSerializerOptions); +File.WriteAllText("docs.json", json); +``` + +## Core Components + +### DocsJsonConfig + +The root configuration object representing the complete `docs.json` schema: + +```csharp +public class DocsJsonConfig +{ + [NotNull] public string Name { get; set; } // Required + [NotNull] public string Theme { get; set; } // Required: mint, maple, palm, etc. + [NotNull] public ColorsConfig Colors { get; set; } // Required: Primary color minimum + [NotNull] public NavigationConfig Navigation { get; set; } // Required + + public string? Description { get; set; } // SEO description + public LogoConfig? Logo { get; set; } // Light/dark logos + public FaviconConfig? Favicon { get; set; } // Favicon paths + public FooterConfig? Footer { get; set; } // Footer configuration + public NavbarConfig? Navbar { get; set; } // Top navigation + public ApiConfig? Api { get; set; } // API playground settings + public SeoConfig? Seo { get; set; } // SEO settings + public AppearanceConfig? Appearance { get; set; } // Light/dark mode + public StylingConfig? Styling { get; set; } // Custom CSS/styling + public IntegrationsConfig? Integrations { get; set; } // Analytics, support, etc. + // ... and 10+ more optional configuration properties +} +``` + + +All required properties are marked with `[NotNull]` and will generate compiler warnings if not set. Use the `DocsJsonValidator` to catch configuration issues at runtime. + + +### NavigationConfig + +Defines the documentation structure with support for pages, groups, tabs, anchors, and more: + +```csharp +public class NavigationConfig +{ + public List? Pages { get; set; } // Mix of strings and GroupConfig + public List? Groups { get; set; } // Named groups + public List? Tabs { get; set; } // Top-level tabs + public List? Anchors { get; set; } // Sidebar anchors + public List? Dropdowns { get; set; } // Dropdown menus + public List? Languages { get; set; } // Language switcher + public List? Versions { get; set; } // Version switcher + public GlobalNavigationConfig? Global { get; set; } // Global nav items +} +``` + +**Pages Property:** The `Pages` property is polymorphic - it can contain both `string` (page paths) and `GroupConfig` objects (nested groups): + +```csharp +config.Navigation.Pages = new List +{ + "index", // Simple page reference + "quickstart", + new GroupConfig // Nested group + { + Group = "Guides", + Pages = new List { "guides/intro", "guides/advanced" } + } +}; +``` + +### GroupConfig + +Organizes pages into collapsible sections: + +```csharp +public class GroupConfig +{ + [NotNull] public string Group { get; set; } // Group title (required) + public List? Pages { get; set; } // Nested pages/groups + public IconConfig? Icon { get; set; } // Group icon + public string? Tag { get; set; } // Badge text (e.g., "NEW", "BETA") + public string? Root { get; set; } // Root page URL + public bool? Hidden { get; set; } // Hide from navigation + public ApiSpecConfig? OpenApi { get; set; } // OpenAPI spec path + public ApiSpecConfig? AsyncApi { get; set; } // AsyncAPI spec path +} +``` + +**Nested Groups:** Groups can contain other groups for hierarchical navigation: + +```csharp +new GroupConfig +{ + Group = "API Reference", + Pages = new List + { + "api/overview", + new GroupConfig + { + Group = "Authentication", + Pages = new List { "api/auth/oauth", "api/auth/api-keys" } + } + } +} +``` + +### ColorsConfig + +Theme color configuration with hex color validation: + +```csharp +public class ColorsConfig +{ + [NotNull] public string Primary { get; set; } = "#000000"; // Required + public string? Light { get; set; } // Light mode accent (used in dark mode) + public string? Dark { get; set; } // Dark mode accent (used in light mode) +} +``` + + +All colors must be valid hex format: `#RRGGBB` or `#RGB`. The validator will catch invalid formats. + + +## DocsJsonManager + +The `DocsJsonManager` class provides advanced navigation management with intelligent merging and duplicate detection: + +### Key Features + +**Load & Save** + +```csharp +var manager = new DocsJsonManager(); + +// Load from file +manager = new DocsJsonManager("path/to/docs.json"); +manager.Load(); + +// Load from string +manager.Load(jsonString); + +// Load from config object +manager.Load(docsConfig); + +// Save back to file +manager.Save(); +manager.Save("path/to/output.json"); +``` + +**Create Default Configuration** + +```csharp +var config = DocsJsonManager.CreateDefault("Project Name", "maple"); +// Returns a DocsJsonConfig with sensible defaults: +// - Basic Getting Started and API Reference groups +// - Default color scheme +// - Standard navigation structure +``` + +**Navigation Discovery** + +```csharp +manager.Load(config); + +// Scan directory for .mdx files and populate navigation +manager.PopulateNavigationFromPath( + path: "./docs", + fileExtensions: new[] { ".mdx" }, + includeApiReference: false, // Exclude api-reference folder + preserveExisting: true, // Merge with existing navigation + allowDuplicatePaths: false // Skip duplicate pages +); + +manager.Save("docs.json"); +``` + +**Smart Navigation Merging** + +```csharp +// Load base configuration +manager.Load(baseConfig); + +// Merge another configuration +manager.Merge(otherConfig, combineBaseProperties: true); + +// Merge just navigation from a file +manager.MergeNavigation("external-docs.json"); + +// Merge navigation from a config object +manager.MergeNavigation(externalConfig.Navigation); +``` + +**Add Pages Safely** + +```csharp +// Add page to navigation root +manager.AddPage(manager.Configuration.Navigation.Pages, "new-page"); + +// Add page to specific group path +manager.AddPage("Getting Started/Tutorials", "tutorial-1"); + +// Add page to group with duplicate detection +var group = manager.FindOrCreateGroup(pages, "My Group"); +if (manager.AddPageToGroup(group, "my-page")) +{ + Console.WriteLine("Page added successfully"); +} +else +{ + Console.WriteLine("Page already exists, skipped"); +} +``` + +**Check Known Paths** + +```csharp +// The manager tracks all added paths internally +if (manager.IsPathKnown("api-reference/index")) +{ + Console.WriteLine("This page is already in navigation"); +} +``` + +### Duplicate Detection + +The `DocsJsonManager` maintains an internal `_knownPagePaths` HashSet that tracks every page path added to navigation: + +```csharp +var manager = new DocsJsonManager(); +manager.Load(config); // Scans existing navigation, populates _knownPagePaths + +// Attempt to add duplicate +var added = manager.AddPage(pages, "quickstart"); // Returns false if already exists + +// Check before adding +if (!manager.IsPathKnown("new-guide")) +{ + manager.AddPage(pages, "new-guide"); +} +``` + + +Duplicate detection is case-insensitive and works across all navigation levels (root pages, grouped pages, nested groups). + + +## DocsJsonValidator + +Comprehensive validation against the Mintlify schema: + +```csharp +using Mintlify.Core; +using Mintlify.Core.Models; + +var validator = new DocsJsonValidator(); +var errors = validator.Validate(config); + +if (errors.Count > 0) +{ + Console.WriteLine("Configuration errors:"); + foreach (var error in errors) + { + Console.WriteLine($" - {error}"); + } +} +``` + +### Validation Rules + +The validator checks: + +**Required Fields** +- `Name` must be set +- `Theme` must be set and valid +- `Colors.Primary` must be a valid hex color +- `Navigation` must have at least one navigation element + +**Theme Validation** +- Must be one of: `mint`, `maple`, `palm`, `willow`, `linden`, `almond`, `aspen` + +**Color Validation** +- All colors must match regex: `^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$` +- Examples: `#FF0000`, `#F00`, `#419AC5` + +**Navigation Validation** +- Must contain at least one of: `pages`, `groups`, `anchors`, `tabs`, `dropdowns`, `languages`, `versions` +- Group names cannot be null (Mintlify will reject the config) +- Empty group names generate warnings (treated as separate ungrouped sections) + +**API Configuration Validation** +- Auth methods: `bearer`, `basic`, `key`, `cobo` +- Playground display: `interactive`, `simple`, `none` +- Examples defaults: `all`, `required` + +**Appearance Validation** +- Default mode: `system`, `light`, `dark` + +**Icons Validation** +- Library: `fontawesome`, `lucide` + +**SEO Validation** +- Indexing: `navigable`, `all` + +### Example Validation Output + +```csharp +var config = new DocsJsonConfig +{ + Name = "", // Invalid: empty + Theme = "custom", // Invalid: not a valid theme + Colors = new ColorsConfig { Primary = "blue" } // Invalid: not hex format +}; + +var errors = validator.Validate(config); +// Returns: +// - "Name is required." +// - "Invalid theme 'custom'. Valid themes are: mint, maple, palm, willow, linden, almond, aspen" +// - "Primary color 'blue' must be a valid hex color (e.g., #FF0000 or #F00)." +``` + +## MintlifyConstants + +Provides shared configuration for consistent JSON serialization: + +```csharp +public static class MintlifyConstants +{ + public static JsonSerializerOptions JsonSerializerOptions { get; } +} +``` + +The `JsonSerializerOptions` instance includes: +- **Indented formatting** for readable JSON output +- **CamelCase property naming** to match Mintlify schema +- **Null value ignoring** to omit optional properties +- **Custom converters** for polymorphic types: + - `NavigationJsonConverter` - Handles complex navigation structures + - `NavigationPageListConverter` - Handles mixed string/GroupConfig lists + - `IconConverter` - Supports both string and object icon formats + - `ColorConverter` - Handles color pairs and single values + - `ApiConfigConverter` - Handles API spec configuration formats + +### Usage + +```csharp +using System.Text.Json; +using Mintlify.Core; + +// Serialize with proper formatting +var json = JsonSerializer.Serialize(config, MintlifyConstants.JsonSerializerOptions); + +// Deserialize with proper type handling +var config = JsonSerializer.Deserialize(json, MintlifyConstants.JsonSerializerOptions); +``` + +## Configuration Models Reference + +Mintlify.Core includes 50+ strongly-typed models covering every Mintlify configuration option: + +### Theme & Appearance + + + + Theme color configuration + + **Properties:** + - `Primary` (required): Main theme color + - `Light`: Light mode accent + - `Dark`: Dark mode accent + + ```csharp + config.Colors = new ColorsConfig + { + Primary = "#419AC5", + Light = "#419AC5", + Dark = "#3CD0E2" + }; + ``` + + + + Logo configuration for light and dark modes + + **Properties:** + - `Light`: Path to light mode logo + - `Dark`: Path to dark mode logo + - `Href`: URL logo links to + + ```csharp + config.Logo = new LogoConfig + { + Light = "/images/logo-light.svg", + Dark = "/images/logo-dark.svg", + Href = "https://example.com" + }; + ``` + + + + Favicon paths for different modes + + **Properties:** + - `Light`: Light mode favicon + - `Dark`: Dark mode favicon + + ```csharp + config.Favicon = new FaviconConfig + { + Light = "/favicon-light.png", + Dark = "/favicon-dark.png" + }; + ``` + + + + Appearance and color mode settings + + **Properties:** + - `Default`: Default mode (`system`, `light`, `dark`) + - `Toggle`: Show dark mode toggle + + ```csharp + config.Appearance = new AppearanceConfig + { + Default = "dark", + Toggle = true + }; + ``` + + + + Custom styling and CSS + + **Properties:** + - `StylesheetPaths`: Array of custom CSS file paths + - `Codeblocks`: Code block styling options + + ```csharp + config.Styling = new StylingConfig + { + StylesheetPaths = new List { "/styles/custom.css" } + }; + ``` + + + +### Navigation Components + + + + Top-level navigation tabs + + **Properties:** + - `Tab`: Tab title + - `Href`: Tab URL + - `Pages`: Tab pages + - `Groups`: Tab groups + - `Icon`: Tab icon + + ```csharp + new TabConfig + { + Tab = "API", + Href = "/api", + Icon = new IconConfig { Name = "code" }, + Pages = new List { "api/overview" } + } + ``` + + + + Sidebar anchor links + + **Properties:** + - `Anchor`: Link text + - `Href`: Link URL + - `Icon`: Anchor icon + + ```csharp + new AnchorConfig + { + Anchor = "Community", + Href = "https://community.example.com", + Icon = new IconConfig { Name = "users" } + } + ``` + + + + Dropdown navigation menus + + **Properties:** + - `Dropdown`: Dropdown title + - `Href`: Optional direct link + - `Items`: Dropdown items + + ```csharp + new DropdownConfig + { + Dropdown = "Resources", + Items = new List + { + new NavbarLink { Name = "Blog", Href = "/blog" }, + new NavbarLink { Name = "Docs", Href = "/docs" } + } + } + ``` + + + +### API & Integration + + + + API playground and documentation settings + + **Properties:** + - `Mdx`: MDX API configuration + - `Playground`: Playground display settings + - `Examples`: Example configuration + - `Params`: Parameter settings + + ```csharp + config.Api = new ApiConfig + { + Playground = new ApiPlaygroundConfig + { + Display = "interactive" + } + }; + ``` + + + + Analytics and third-party integrations + + **Properties:** + - `GoogleAnalytics`: GA tracking ID + - `GoogleTagManager`: GTM ID + - `Mixpanel`: Mixpanel project token + - `Segment`: Segment write key + - `Intercom`: Intercom app ID + - And 10+ more integrations + + ```csharp + config.Integrations = new IntegrationsConfig + { + GoogleAnalytics = "G-XXXXXXXXXX", + Intercom = "app_id_here" + }; + ``` + + + + SEO and indexing settings + + **Properties:** + - `Indexing`: Indexing mode (`navigable`, `all`) + - `Sitemap`: Custom sitemap URL + + ```csharp + config.Seo = new SeoConfig + { + Indexing = "all", + Sitemap = "https://example.com/sitemap.xml" + }; + ``` + + + +### Advanced Features + + + + Footer configuration with social links + + **Properties:** + - `Socials`: Social media links + - `Links`: Custom footer links + + ```csharp + config.Footer = new FooterConfig + { + Socials = new Dictionary + { + { "twitter", "https://twitter.com/example" }, + { "github", "https://github.com/example" } + } + }; + ``` + + + + Top banner configuration + + **Properties:** + - `Text`: Banner text + - `Link`: Banner link URL + - `Color`: Banner color + + ```csharp + config.Banner = new BannerConfig + { + Text = "New version available!", + Link = "/changelog", + Color = "#419AC5" + }; + ``` + + + + URL redirects + + **Properties:** + - `Source`: Source path + - `Destination`: Destination path + + ```csharp + config.Redirects = new List + { + new RedirectConfig + { + Source = "/old-path", + Destination = "/new-path" + } + }; + ``` + + + + Search configuration + + **Properties:** + - `Provider`: Search provider + - `AlgoliaConfig`: Algolia settings + + ```csharp + config.Search = new SearchConfig + { + Provider = "algolia" + }; + ``` + + + +## Advanced Scenarios + +### Building Multi-Project Documentation + +```csharp +var manager = new DocsJsonManager(); + +// Create base configuration +var baseConfig = DocsJsonManager.CreateDefault("Multi-Project Docs", "maple"); +manager.Load(baseConfig); + +// Add Project A navigation +var projectANav = new NavigationConfig +{ + Pages = new List + { + new GroupConfig + { + Group = "Project A", + Pages = new List { "project-a/overview", "project-a/api" } + } + } +}; +manager.MergeNavigation(projectANav); + +// Add Project B navigation +var projectBNav = new NavigationConfig +{ + Pages = new List + { + new GroupConfig + { + Group = "Project B", + Pages = new List { "project-b/overview", "project-b/api" } + } + } +}; +manager.MergeNavigation(projectBNav); + +manager.Save("docs.json"); +``` + +### Custom Navigation Override + +```csharp +// Create custom navigation for a specific directory +var customGroup = new GroupConfig +{ + Group = "Advanced Topics", + Icon = new IconConfig { Name = "graduation-cap" }, + Pages = new List + { + "advanced/architecture", + "advanced/performance", + new GroupConfig + { + Group = "Security", + Pages = new List + { + "advanced/security/authentication", + "advanced/security/authorization" + } + } + } +}; + +// Serialize to navigation.json +var json = JsonSerializer.Serialize(customGroup, MintlifyConstants.JsonSerializerOptions); +File.WriteAllText("docs/advanced/navigation.json", json); +``` + +### Programmatic Theme Configuration + +```csharp +var config = DocsJsonManager.CreateDefault("My Docs", "maple"); + +// Configure complete theme +config.Colors = new ColorsConfig +{ + Primary = "#419AC5", + Light = "#419AC5", + Dark = "#3CD0E2" +}; + +config.Logo = new LogoConfig +{ + Light = "/images/logo-light.svg", + Dark = "/images/logo-dark.svg" +}; + +config.Favicon = new FaviconConfig +{ + Light = "/favicon-light.png", + Dark = "/favicon-dark.png" +}; + +config.Appearance = new AppearanceConfig +{ + Default = "system", + Toggle = true +}; + +config.Footer = new FooterConfig +{ + Socials = new Dictionary + { + { "twitter", "https://twitter.com/myproject" }, + { "github", "https://github.com/myproject" }, + { "discord", "https://discord.gg/myproject" } + } +}; +``` + +### Validation Pipeline + +```csharp +public bool ValidateAndSaveConfig(DocsJsonConfig config, string outputPath) +{ + var validator = new DocsJsonValidator(); + var errors = validator.Validate(config); + + if (errors.Count > 0) + { + Console.WriteLine("L Configuration validation failed:"); + foreach (var error in errors) + { + Console.WriteLine($" {error}"); + } + return false; + } + + try + { + var json = JsonSerializer.Serialize(config, MintlifyConstants.JsonSerializerOptions); + File.WriteAllText(outputPath, json); + Console.WriteLine($" Configuration saved to {outputPath}"); + return true; + } + catch (Exception ex) + { + Console.WriteLine($"L Failed to save configuration: {ex.Message}"); + return false; + } +} +``` + +## Best Practices + + + + Use `DocsJsonValidator` before saving configurations to catch errors early. Invalid configs will be rejected by Mintlify. + + + + Leverage `DocsJsonManager` for navigation operations instead of manually manipulating collections. It handles duplicate detection automatically. + + + + When using `PopulateNavigationFromPath`, set `preserveExisting: true` to merge discovered content with template navigation. + + + + Use `IsPathKnown()` before adding pages to avoid duplicates. The manager tracks all paths internally. + + + + Always use `MintlifyConstants.JsonSerializerOptions` for consistent JSON formatting and proper converter handling. + + + + Initialize `Name`, `Theme`, `Colors.Primary`, and `Navigation` before other properties. These are required by Mintlify. + + + +## Multi-Platform Support + +Mintlify.Core targets multiple .NET platforms for maximum compatibility: + +| Framework | Version | Use Case | +|-----------|---------|----------| +| .NET 10.0 | Latest | Bleeding-edge projects | +| .NET 9.0 | Current | Modern .NET applications | +| .NET 8.0 | LTS | Enterprise production apps | +| .NET Standard 2.0 | Legacy | Maximum compatibility | + +All core functionality works identically across platforms, with some optimizations for modern frameworks (e.g., source-generated regex in .NET 7+). + +## See Also + + + + Learn how MintlifyRenderer uses DocsJsonManager to build navigation + + + Complete guide to the Mintlify provider features + + + Full API reference for DocsJsonManager class + + + Official Mintlify docs.json schema reference + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/index.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/index.mdx new file mode 100644 index 0000000..3c4d8c9 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/index.mdx @@ -0,0 +1,558 @@ +--- +title: Mintlify-Enhanced Docs +sidebarTitle: Overview +description: Transform your .NET XML documentation into beautiful, AI-ready Mintlify documentation sites with smart navigation, context-aware icons, and rich MDX features +icon: sparkles +--- + + + + Auto-generated frontmatter with icons, tags, SEO metadata, and keywords for every API page + + + Automatic docs.json generation with hierarchical namespace organization and flexible navigation modes + + + 50+ FontAwesome icons automatically assigned based on type characteristics and naming patterns + + + Embed custom React components directly in your MDX files for interactive documentation + + + +## Overview + +The DotNetDocs Mintlify provider transforms your .NET XML documentation comments into production-ready Mintlify documentation sites. Built specifically for .NET developers, it generates MDX files with comprehensive frontmatter, organizes your API into intuitive navigation structures, and applies context-aware icons to make your documentation visually scannable. + + +The Mintlify provider is the most feature-rich renderer in DotNetDocs, with built-in support for AI discoverability, SEO optimization, and rich interactive components. + + +## Key Features + +### MDX Generation with Rich Frontmatter + +Every generated MDX file includes comprehensive frontmatter: + +- **Title & Description**: SEO-optimized 160-character descriptions for every API member +- **Icons**: Context-aware FontAwesome icons based on type characteristics +- **Tags**: Automatic categorization (class, interface, method, property, etc.) +- **Keywords**: Extracted from XML documentation for enhanced searchability +- **Mode**: Wide layout for types, standard for members +- **OpenGraph Metadata**: Ready for social media sharing + + +```mdx Example Class Frontmatter +--- +title: PaymentProcessor +description: Processes payment transactions with support for multiple payment gateways, automatic retry logic, and comprehensive audit logging +icon: credit-card +tags: [class, public] +mode: wide +keywords: payment, transaction, gateway, processing +--- +``` + +```mdx Example Method Frontmatter +--- +title: ProcessPaymentAsync +description: Asynchronously processes a payment transaction through the configured gateway with automatic retry on transient failures +icon: bolt +tags: [method, public, async] +keywords: payment, async, transaction, process +--- +``` + + +### Hierarchical Navigation Generation + +The Mintlify provider generates `docs.json` navigation files that organize your API documentation into logical hierarchies. Choose between two navigation modes: + + + + Creates a single navigation tree with all namespaces organized hierarchically under one group. + + ```json + { + "group": "API Reference", + "pages": [ + { + "group": "CloudNimble.DotNetDocs", + "pages": [ + { + "group": "Core", + "pages": ["api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager"] + } + ] + } + ] + } + ``` + + + + Creates separate navigation groups for each assembly, ideal for multi-project solutions. + + ```json + [ + { + "group": "MyProject.Core", + "pages": ["api-reference/MyProject/Core/..."] + }, + { + "group": "MyProject.Extensions", + "pages": ["api-reference/MyProject/Extensions/..."] + } + ] + ``` + + + +### 50+ Context-Aware Icons + +Icons are automatically assigned based on type characteristics, member types, and naming patterns: + +- **Type-based**: Classes get `cube`, interfaces get `layer-group`, enums get `list-ol` +- **Pattern-based**: Managers get `gears`, services get `server`, repositories get `database` +- **Member-based**: Methods get `function`, properties get `sliders`, events get `bolt` +- **Modifier-based**: Static members get `s`, abstract types get `shapes` + +See the [complete icon reference](#icon-reference) below for all available icons. + +### Flexible Output Modes + +Control how namespaces are organized in the file system: + +- **File Mode (Default)**: Each namespace gets a single MDX file with all members +- **Folder Mode**: Each namespace becomes a folder with separate files per type + + +```plaintext File Mode Structure +api-reference/ + MyNamespace.mdx + MyNamespace.SubNamespace.mdx +``` + +```plaintext Folder Mode Structure +api-reference/ + MyNamespace/ + index.mdx + MyClass.mdx + MyInterface.mdx + SubNamespace/ + index.mdx + AnotherClass.mdx +``` + + +### DocsJson Template Customization + +Customize the generated `docs.json` configuration by providing a template with pre-configured settings: + +- Set global appearance, colors, and theme +- Configure integrations (Google Analytics, etc.) +- Define custom logos and favicons +- Pre-populate navigation structure +- Control navigation type (Pages, Tabs, or Products) + +```csharp +services.AddDotNetDocsMintlify(options => +{ + options.Template = new DocsJsonConfig + { + Name = "My API", + Theme = "quill", + NavigationType = "Tabs", // NEW: Control root nav placement + NavigationName = "My API Reference", // NEW: Custom name for tab/product + Colors = new ColorsConfig + { + Primary = "#007ACC", + Light = "#50A3D0", + Dark = "#004B87" + }, + Integrations = new IntegrationsConfig + { + Ga4 = new GoogleAnalytics4Config { MeasurementId = "G-XXXXXXXXXX" } + } + }; + options.IncludeIcons = true; + options.GenerateDocsJson = true; +}); +``` + + +Set `NavigationType` to control whether the root project appears in main navigation (`Pages`), as a top-level tab (`Tabs`), or in the products section (`Products`). This is particularly useful for multi-project documentation collections. + + +### React Component Support + +Mintlify MDX supports embedding custom React components directly in your documentation: + +- Import components from the `snippets` folder +- Use React hooks (useState, useEffect, etc.) +- Create interactive demos, calculators, and visualizations +- Build reusable component libraries + +```jsx snippets/ColorPicker.jsx +export const ColorPicker = () => { + const [color, setColor] = React.useState('#3CD0E2'); + + return ( +
+ setColor(e.target.value)} + /> +

Selected: {color}

+
+ ); +}; +``` + +```mdx Using the Component +import { ColorPicker } from '/snippets/ColorPicker'; + +## Try It Out + + +``` + + +React components must be placed in the `snippets` folder and exported as named exports. You cannot import components from arbitrary MDX files. + + +## Getting Started + + + + Install the `CloudNimble.DotNetDocs.Mintlify` package: + + ```bash + dotnet add package CloudNimble.DotNetDocs.Mintlify + ``` + + + + Register the Mintlify renderer in your documentation pipeline: + + + ```csharp Default Configuration + var builder = new DotNetDocsBuilder() + .AddDefaultPipeline() + .AddMintlifyRenderer(); + + var result = await builder.BuildAsync(); + ``` + + ```csharp Custom Configuration + var builder = new DotNetDocsBuilder() + .AddDefaultPipeline() + .AddMintlifyRenderer(options => + { + options.NavigationMode = NavigationMode.ByAssembly; + options.NamespaceMode = NamespaceMode.Folder; + options.GenerateDocsJson = true; + options.IncludeIcons = true; + options.UnifiedGroupName = "API Reference"; + }); + + var result = await builder.BuildAsync(); + ``` + + ```xml With MSBuild Integration (.docsproj) + + + Mintlify + Unified + + My Project + Tabs + My API + maple + + #419AC5 + + + + + ``` + + + + + Build your project to automatically generate Mintlify documentation: + + ```bash + dotnet build --configuration Release + ``` + + Your MDX files and `docs.json` will be generated in the output directory. + + + + Install the Mintlify CLI and preview your docs locally: + + ```bash + npm install -g mintlify + cd docs + mintlify dev + ``` + + Your documentation will be available at `http://localhost:3000`. + + + +## Configuration Reference + + + + Controls how navigation is organized in `docs.json`: + + | Mode | Description | Best For | + |------|-------------|----------| + | `Unified` | Single navigation tree with all namespaces | Single-project solutions | + | `ByAssembly` | Separate groups per assembly | Multi-project solutions | + + ```csharp + options.NavigationMode = NavigationMode.ByAssembly; + ``` + + + + Controls file system organization: + + | Mode | Description | Output Structure | + |------|-------------|------------------| + | `File` | One MDX file per namespace | `MyNamespace.mdx` | + | `Folder` | Folder per namespace with separate type files | `MyNamespace/MyClass.mdx` | + + ```csharp + options.NamespaceMode = NamespaceMode.Folder; + ``` + + + + Additional configuration options: + + ```csharp + public class MintlifyRendererOptions + { + // Whether to generate docs.json navigation file + public bool GenerateDocsJson { get; set; } = true; + + // Whether to include namespace index pages + public bool GenerateNamespaceIndex { get; set; } = true; + + // Whether to include FontAwesome icons + public bool IncludeIcons { get; set; } = true; + + // Order of namespaces in navigation (default: alphabetical) + public List NamespaceOrder { get; set; } + + // Template for docs.json configuration (merged with generated navigation) + public DocsJsonConfig Template { get; set; } + + // Group name for Unified navigation mode + public string UnifiedGroupName { get; set; } = "API Reference"; + } + ``` + + + +## Rich Mintlify Components + +The Mintlify provider generates standard MDX, allowing you to enhance generated docs with Mintlify's rich component library. Below are examples of the most commonly used components. + +### Tabs & CodeGroup + +Display multiple code examples or content variants. The Tabs component works with any content, while CodeGroup is specifically optimized for code blocks. + + + + ```csharp + var result = await processor.ProcessAsync(); + ``` + + + ```fsharp + let! result = processor.ProcessAsync() + ``` + + + +### Callouts + +Highlight important information with colored callout boxes: + +This method is thread-safe and can be called concurrently. + +This operation cannot be undone. + +Use caching to improve performance. + +Available since version 2.0 + +Best practice: Always dispose of resources + +### Cards & CardGroup + +Create visually appealing content grids. Perfect for navigation and feature showcases. + +### Steps + +The Steps component guides users through sequential processes with automatic numbering and visual flow. + +### Accordions + +Accordions organize collapsible content sections for progressive disclosure. They work great for FAQs, detailed explanations, and organizing large amounts of related content. + +## Icon Reference + +The Mintlify provider includes 50+ context-aware FontAwesome icons. Icons are automatically assigned based on type characteristics, but you can override them in XML documentation using custom tags. + + + + Icons assigned based on type classification: + + | Type | Icon | Symbol | + |------|------|--------| + | Class | `cube` | 🧊 | + | Interface | `layer-group` | 📚 | + | Struct | `cube-alt` | 🔷 | + | Enum | `list-ol` | 📋 | + | Delegate | `arrow-right` | ➡️ | + | Namespace | `folder` | 📁 | + + + + Icons for class members: + + | Member | Icon | Symbol | + |--------|------|--------| + | Method | `function` | ƒ | + | Property | `sliders` | 🎚️ | + | Field | `input-text` | 📝 | + | Event | `bolt` | ⚡ | + | Constructor | `hammer` | 🔨 | + | Operator | `calculator` | 🔢 | + + + + Icons assigned based on naming patterns: + + | Pattern | Icon | Example | + |---------|------|---------| + | *Manager | `gears` | DocumentationManager | + | *Service | `server` | PaymentService | + | *Repository | `database` | UserRepository | + | *Controller | `gamepad` | ApiController | + | *Factory | `industry` | ConnectionFactory | + | *Builder | `hammer` | StringBuilder | + | *Provider | `plug` | ConfigurationProvider | + | *Handler | `hand` | EventHandler | + | *Helper | `circle-question` | StringHelper | + | *Validator | `check-circle` | InputValidator | + + + + Additional icons for access modifiers and type characteristics: + + | Modifier | Icon | Symbol | + |----------|------|--------| + | Static | `s` | S | + | Abstract | `shapes` | 🔺 | + | Sealed | `lock` | 🔒 | + | Generic | `brackets-curly` | { } | + | Async | `arrows-spin` | 🔄 | + + + + Icons based on namespace segments: + + | Segment | Icon | Example | + |---------|------|---------| + | Core | `circle-dot` | MyApp.Core | + | Extensions | `puzzle-piece` | MyApp.Extensions | + | Models | `diagram-project` | MyApp.Models | + | Services | `server` | MyApp.Services | + | Data | `database` | MyApp.Data | + | Security | `shield` | MyApp.Security | + | Web | `globe` | MyApp.Web | + | Api | `cloud` | MyApp.Api | + | Testing | `vial` | MyApp.Testing | + + + +## Output Structure + +The Mintlify provider generates the following file structure: + + +```plaintext File Mode (Default) +docs/ +├── docs.json +├── api-reference/ +│ ├── MyProject/ +│ │ ├── Core.mdx +│ │ ├── Core/Services.mdx +│ │ ├── Extensions.mdx +│ │ └── Models.mdx +│ └── ... +└── ... +``` + +```plaintext Folder Mode +docs/ +├── docs.json +├── api-reference/ +│ ├── MyProject/ +│ │ ├── Core/ +│ │ │ ├── index.mdx +│ │ │ ├── DocumentationManager.mdx +│ │ │ ├── Services/ +│ │ │ │ ├── index.mdx +│ │ │ │ └── PaymentService.mdx +│ │ │ └── ... +│ │ └── ... +│ └── ... +└── ... +``` + + +## Best Practices + + + + The quality of your generated documentation depends on your XML comments. Include detailed ``, ``, ``, and `` sections. + + + + Follow .NET naming conventions. The icon system works best with standard patterns like *Manager, *Service, *Repository. + + + + Structure your namespaces hierarchically. Use segments like Core, Extensions, Models, Services for better automatic icon selection. + + + + Use the Template property to provide custom docs.json configuration settings like themes, colors, and integrations. + + + +## See Also + + + + Complete MintlifyRenderer API documentation + + + Official Mintlify documentation and component reference + + + DocsJsonConfig schema and available settings + + + Understand the DotNetDocs documentation pipeline + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/navigation.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/navigation.mdx new file mode 100644 index 0000000..b142163 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/providers/mintlify/navigation.mdx @@ -0,0 +1,772 @@ +--- +title: Navigation Generation +sidebarTitle: Navigation +description: Learn how the MintlifyRenderer builds intelligent navigation structures from .docsproj templates, folder scanning, and generated API documentation +icon: sitemap +--- + +The MintlifyRenderer uses a sophisticated three-phase approach to build navigation structures that combine template-defined navigation, discovered conceptual +documentation, and generated API reference documentation. This system leverages the `DocsJsonManager` from Mintlify.Core to intelligently merge multiple +navigation sources without duplication. + +## Overview + +Navigation generation happens in five distinct phases: + + + + If a `MintlifyTemplate` is defined in the `.docsproj` file, it's loaded first as the foundation for navigation structure. + + + The system scans the documentation root folder for existing `.mdx` files, automatically organizing them into navigation groups while preserving template structure. + + + Generated API documentation is added to the navigation, organized either as a unified structure or by assembly depending on `NavigationMode`. + + + If the template specifies a `NavigationType`, the root project's navigation is moved to Tabs or Products section. + + + If `DocumentationReference` items are defined, external documentation is copied and merged into the navigation structure. + + + +## Phase 1: Template Navigation + +The `.docsproj` file can define a `MintlifyTemplate` that provides the baseline documentation structure. This template becomes the foundation that all other navigation is merged into. + +### Template Structure + +```xml CloudNimble.DotNetDocs.Docs.docsproj + + DotNetDocs + maple + + #419AC5 + + + + + + index;quickstart;installation + + + guides/index;guides/conceptual-docs + + + providers/index + + + + + +``` + +### Template Loading Process + +When the MintlifyRenderer starts, it checks if a template is provided: + +1. **Load or Create Default**: If `_options.Template` exists, load it; otherwise create a default configuration +2. **Initialize DocsJsonManager**: Pass the template config to `DocsJsonManager.Load(DocsJsonConfig)` +3. **Track Known Paths**: All paths in the template are added to `_knownPagePaths` for duplicate detection + +```csharp MintlifyRenderer.cs:82-94 +if (_options.GenerateDocsJson && _docsJsonManager is not null) +{ + if (_docsJsonManager.Configuration is null) + { + docsConfig = _options.Template ?? DocsJsonManager.CreateDefault( + model.AssemblyName ?? "API Documentation", + "mint" + ); + _docsJsonManager.Load(docsConfig); + } +} +``` + + +The template provides the structure and styling (theme, colors, logos) that remains constant, while navigation gets intelligently merged from multiple sources. + + +## Phase 2: Folder Scanning + +After loading the template, the system scans the documentation root directory for existing `.mdx` files using `PopulateNavigationFromPath`. + +### Scanning Behavior + +**Excluded Directories** + +The scanner automatically excludes certain directories: + +- Directories starting with `.` (hidden directories) +- `node_modules` (package dependencies) +- `conceptual` (reserved for overrides) +- `overrides` (reserved for customization) +- `api-reference` (handled separately in Phase 3) + +**File Processing** + +Only `.mdx` files are included in navigation: + +- `.mdx` files: Added to navigation automatically +- `.md` files: Generate warnings and are excluded +- Other files: Ignored completely + +Files named `index.mdx` are prioritized and appear first in their group. + +**Navigation Overrides** + +Any directory can include a `navigation.json` file for complete control: + +```json guides/navigation.json +{ + "group": "User Guides", + "icon": "book-open", + "pages": [ + "guides/getting-started", + "guides/advanced-topics", + { + "group": "Examples", + "pages": ["guides/examples/basic", "guides/examples/advanced"] + } + ] +} +``` + +When `navigation.json` is found, the system: +1. Stops automatic navigation generation for that directory tree +2. Uses the custom `GroupConfig` object as-is +3. Tracks all paths in the custom navigation + +**Smart Merging** + +The `preserveExisting: true` parameter ensures template navigation is preserved: + +- Existing template groups remain in their original position +- Discovered content is merged into matching groups by name +- New groups are appended after template groups +- Duplicate paths are detected and skipped using `_knownPagePaths` + +### Folder Scanning Code + +```csharp MintlifyRenderer.cs:124 +_docsJsonManager.PopulateNavigationFromPath( + Context.DocumentationRootPath, + new[] { ".mdx" }, + includeApiReference: false, + preserveExisting: true +); +``` + + +Set `preserveExisting: false` to replace template navigation entirely with discovered structure. This is useful for fully automated documentation sites. + + +## Phase 3: API Reference Generation + +The final phase adds generated API documentation to the navigation structure. The organization depends on the `NavigationMode` setting. + +### Navigation Modes + + + + Creates a single "API Reference" group with hierarchical namespace organization: + + ```json + { + "group": "API Reference", + "pages": [ + { + "group": "CloudNimble.DotNetDocs", + "pages": [ + { + "group": "Core", + "pages": [ + "api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager", + "api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer" + ] + }, + { + "group": "Mintlify", + "pages": ["api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer"] + } + ] + } + ] + } + ``` + + **Best for:** Single-project solutions where all APIs logically belong together + + + + Creates separate top-level groups for each assembly: + + ```json + [ + { + "group": "CloudNimble.DotNetDocs.Core", + "icon": "cube", + "pages": [ + { + "group": "CloudNimble.DotNetDocs.Core", + "pages": ["api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager"] + } + ] + }, + { + "group": "CloudNimble.DotNetDocs.Mintlify", + "icon": "cube", + "pages": [ + { + "group": "CloudNimble.DotNetDocs.Mintlify", + "pages": ["api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer"] + } + ] + } + ] + ``` + + **Best for:** Multi-project solutions where each assembly should have its own section + + + +### API Reference Code Flow + +```csharp MintlifyRenderer.cs:127 +// Add API reference content to existing navigation +BuildNavigationStructure(_docsJsonManager.Configuration, model); +``` + +The `BuildNavigationStructure` method: +1. Finds or creates the API Reference group using `FindOrCreateApiReferenceGroup` +2. Iterates through all namespaces in the documentation model +3. Creates nested groups for namespace hierarchy (e.g., `CloudNimble` � `DotNetDocs` � `Core`) +4. Adds page paths for each type using `_docsJsonManager.AddPage()` +5. Respects the `_knownPagePaths` hashset to avoid duplicates + +## Phase 4: Documentation References (Collections) + +DotNetDocs supports creating documentation collections by combining multiple `.docsproj` projects into a unified documentation site. This is perfect for multi-library ecosystems or monorepo documentation. + +### DocumentationReference Basics + +Add references to other documentation projects in your `.docsproj` file: + +```xml CloudNimble.EasyAF.Docs.docsproj + + + +``` + +**Parameters:** +- `Include`: Path to the referenced `.docsproj` file +- `DestinationPath`: Subfolder where documentation will be copied (relative to output) +- `IntegrationType`: How the reference appears in navigation (`Tabs` or `Products`) + +### How It Works + +When you build a project with DocumentationReferences: + +1. **Resolution**: The `DocumentationReferenceResolverTask` validates each reference and extracts metadata +2. **File Copying**: Content files (`.mdx`, images, snippets) are copied to `DestinationPath` +3. **Navigation files excluded**: Root navigation files (`docs.json`) are automatically excluded +4. **Navigation Integration**: Referenced navigation is merged into the parent project's `docs.json` + +### Integration Types + + + + Referenced documentation appears as a top-level tab: + + ```json Result in docs.json + { + "navigation": { + "tabs": [ + { + "tab": "Breakdance.Docs", + "href": "breakdance", + "pages": ["breakdance/index", "breakdance/quickstart"] + } + ] + } + } + ``` + + **Best for:** Related libraries or companion tools that deserve their own dedicated section + + + + Referenced documentation appears in the products section: + + ```xml + + ``` + + **Best for:** Product suites or service-oriented documentation structures + + + +### File Copying Behavior + +The system automatically copies documentation-type-specific files while **excluding root navigation files**: + +**Mintlify (excludes `docs.json`):** +- `*.md`, `*.mdx`, `*.mdz` +- `images/**/*` +- `favicon.*` +- `snippets/**/*` + +**DocFX (excludes `toc.yml`, `toc.yaml`, `docfx.json`):** +- `*.md`, `*.yml`, `*.yaml` +- `images/**/*` +- `articles/**/*` +- `api/**/*` + +**MkDocs (excludes `mkdocs.yml`):** +- `*.md` +- `docs/**/*` +- `overrides/**/*` +- `theme/**/*` + + +Root navigation files are excluded automatically to prevent conflicts. The parent project maintains full control over the unified navigation structure. + + +### Complete Example: Multi-Library Collection + +```xml CloudNimble.Platform.Docs.docsproj + + + Mintlify + Unified + + CloudNimble Platform + Tabs + Platform Core + maple + + + + + + + + + + + + +``` + +**Result:** Three-tab documentation site with Platform Core, EasyAF, and Breakdance each in their own tab. + +## Controlling Root Project Navigation Type + +By default, the root project's documentation appears in the main `Pages` navigation. You can change this behavior using the `NavigationType` and `NavigationName` properties in your `MintlifyTemplate`. + +### NavigationType Property + +Add to your `.docsproj` template: + +```xml + + EasyAF + Tabs + EasyAF API + maple + +``` + +**Valid NavigationType values:** +- `Pages` (default) - Appears in main navigation +- `Tabs` - Appears as a top-level tab +- `Products` - Appears in products section + +### When to Use NavigationType + + + + **When:** You're building a single-project documentation site + + The root project should be the primary content in the main navigation. + + + + **When:** You're building a multi-project collection where all projects should have equal prominence + + Perfect for monorepos or related library collections. + + + + **When:** You're documenting a product suite with multiple distinct offerings + + Each product gets its own section in the products navigation. + + + +### Example: Pure Collection Site + +```xml Collection.Docs.docsproj + + CloudNimble Docs + maple + + + + + index;overview + + + + + + + + + + + + +``` + +**Result:** A landing page with Getting Started content, and three library tabs for the actual API documentation. + +### NavigationType Processing Order + +The system applies navigation transformations in this order: + +1. **Load Template** - Base configuration and styling +2. **Discover Files** - Scan for conceptual `.mdx` files +3. **Add API Reference** - Generated API documentation +4. **Apply NavigationType** - Move root content to Tabs/Products if configured +5. **Combine References** - Merge DocumentationReference navigation + +This ensures referenced projects are properly integrated regardless of the root project's navigation type. + +## DocsJsonManager Deep Dive + +The `DocsJsonManager` from Mintlify.Core is the engine that powers intelligent navigation merging. + +### Key Features + + + + The `_knownPagePaths` HashSet tracks every path added to navigation, preventing duplicates across template, discovered, and generated content. + + + + Groups with matching names are automatically merged. Pages from multiple sources combine into a single cohesive group. + + + + The `AddPage(string groupPath, string pagePath)` method supports slash-separated paths like "Getting Started/API Reference" for nested groups. + + + + Automatically removes groups with null names that would cause Mintlify to reject the configuration. + + + +### Core Methods + +**Load(DocsJsonConfig)** + +Loads a configuration object and populates `_knownPagePaths` by recursively scanning all navigation: + +```csharp DocsJsonManager.cs:159-172 +public void Load(DocsJsonConfig config) +{ + Ensure.ArgumentNotNull(config, nameof(config)); + + ConfigurationErrors.Clear(); + Configuration = config; + + if (Configuration.Navigation?.Pages is not null) + { + PopulateKnownPaths(Configuration.Navigation.Pages); + } +} +``` + +**PopulateNavigationFromPath** + +Scans a directory for `.mdx` files and builds navigation structure: + +```csharp DocsJsonManager.cs:444-483 +public void PopulateNavigationFromPath( + string path, + string[]? fileExtensions = null, + bool includeApiReference = false, + bool preserveExisting = true, + bool allowDuplicatePaths = false) +{ + // ... validation ... + + if (preserveExisting) + { + var discoveredNavigation = new NavigationConfig { Pages = [] }; + PopulateNavigationFromDirectory(path, discoveredNavigation.Pages, path, + fileExtensions, includeApiReference, true, allowDuplicatePaths); + + var mergeOptions = new MergeOptions(); + MergeNavigation(Configuration.Navigation, discoveredNavigation, mergeOptions); + } + else + { + Configuration.Navigation.Pages.Clear(); + PopulateNavigationFromDirectory(path, Configuration.Navigation.Pages, path, + fileExtensions, includeApiReference, true, allowDuplicatePaths); + } +} +``` + +**Parameters:** +- `path`: Root directory to scan +- `fileExtensions`: Array of extensions (default: `[".mdx"]`) +- `includeApiReference`: Whether to scan `api-reference` folder (default: `false`) +- `preserveExisting`: Merge with existing navigation vs replace (default: `true`) +- `allowDuplicatePaths`: Whether to allow duplicate page paths (default: `false`) + +**AddPage / AddPageToGroup** + +Safely adds pages to navigation with automatic duplicate detection: + +```csharp DocsJsonManager.cs:493-512 +public bool AddPage(List pages, string pagePath, + bool allowDuplicatePaths = false, bool updateKnownPaths = true) +{ + Ensure.ArgumentNotNull(pages, nameof(pages)); + Ensure.ArgumentNotNullOrWhiteSpace(pagePath, nameof(pagePath)); + + if (!allowDuplicatePaths && _knownPagePaths.Contains(pagePath)) + { + return false; + } + + pages.Add(pagePath); + if (updateKnownPaths) + { + _knownPagePaths.Add(pagePath); + } + return true; +} +``` + +Returns `true` if page was added, `false` if it was a duplicate and skipped. + +**MergeNavigation** + +Intelligently merges two navigation structures: + +```csharp DocsJsonManager.cs:890-943 +internal void MergeNavigation(NavigationConfig target, NavigationConfig source, + MergeOptions? options = null) +{ + if (source is null) return; + + if (source.Pages is not null) + { + if (target.Pages is null) + { + target.Pages = [.. source.Pages]; + } + else + { + MergePagesList(source.Pages, target.Pages, options); + } + } + // ... merge groups, tabs, anchors ... +} +``` + +**Merge Behavior:** +- Pages: Deduplicated using `_knownPagePaths` +- Groups: Merged by name, combining pages recursively +- Tabs: Merged by name or href +- Anchors: Appended to target + +**FindOrCreateGroup** + +Finds an existing group by name or creates a new one: + +```csharp DocsJsonManager.cs:591-611 +public GroupConfig FindOrCreateGroup(List pages, string groupName) +{ + Ensure.ArgumentNotNull(pages, nameof(pages)); + Ensure.ArgumentNotNullOrWhiteSpace(groupName, nameof(groupName)); + + var existingGroup = pages.OfType() + .FirstOrDefault(g => g.Group == groupName); + if (existingGroup is not null) + { + return existingGroup; + } + + var newGroup = new GroupConfig + { + Group = groupName, + Pages = [] + }; + pages.Add(newGroup); + return newGroup; +} +``` + +## Configuration Examples + +### Unified Navigation with Template + +```xml + + Unified + + My Project + + + + + index;quickstart + + + + + + +``` + +**Result:** Single "API Reference" group appears after "Getting Started" + +### ByAssembly Navigation + +```xml + + ByAssembly + +``` + +**Result:** Each assembly gets its own top-level group with hierarchical namespace subgroups + +### Custom Navigation Override + +Create `guides/navigation.json` in your documentation folder: + +```json +{ + "group": "Advanced Guides", + "icon": "rocket", + "pages": [ + "guides/authentication", + "guides/deployment", + { + "group": "Integrations", + "pages": [ + "guides/integrations/github", + "guides/integrations/slack" + ] + } + ] +} +``` + +The system will use this exact structure instead of automatically discovering files in the `guides` directory. + +## Best Practices + + + + Define your site structure (Getting Started, Guides, etc.) in the `.docsproj` template. Let folder scanning fill in the content. + + + + Create directories that match your template groups. Files in `guides/` will merge into the "Guides" group automatically. + + + + Use `navigation.json` for complex sections where automatic discovery doesn't match your desired structure. + + + + File names become URLs. Use `kebab-case.mdx` for clean, readable paths like `/guides/getting-started`. + + + + Never manually create files in `api-reference/`. This folder is fully managed by the generator and will be overwritten. + + + + The duplicate detection system preserves navigation across multiple builds. Test that your structure remains stable. + + + +## Troubleshooting + +**Duplicate Pages in Navigation** + +*Symptom:* Same page appears multiple times in navigation + +*Cause:* `allowDuplicatePaths` is enabled or paths are tracked incorrectly + +*Solution:* +- Ensure `allowDuplicatePaths: false` in your .docsproj +- Check that template paths match discovered paths exactly (case-insensitive) +- Review `navigation.json` files for duplicate references + +**Missing Conceptual Docs** + +*Symptom:* `.mdx` files exist but don't appear in navigation + +*Cause:* Files are in excluded directories or have wrong extension + +*Solution:* +- Check that files are `.mdx` not `.md` +- Verify files aren't in `node_modules`, `conceptual`, `overrides`, or hidden directories +- Set `includeApiReference: true` if you need to scan that folder + +**Template Navigation Overwritten** + +*Symptom:* Navigation from template disappears after generation + +*Cause:* `preserveExisting: false` in folder scanning + +*Solution:* Ensure `PopulateNavigationFromPath` uses `preserveExisting: true` (this is the default) + +**API Reference Not Generated** + +*Symptom:* No API Reference group appears in navigation + +*Cause:* `GenerateDocsJson` is disabled or no types were documented + +*Solution:* +- Set `true` in .docsproj +- Verify XML documentation is enabled: `true` +- Check that assemblies contain public types with XML comments + +## See Also + + + + Learn about all Mintlify provider features + + + Complete DocsJsonManager API reference + + + Configure .docsproj files and build properties + + + Learn how to structure conceptual documentation + + diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/quickstart.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/quickstart.mdx new file mode 100644 index 0000000..0a93739 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/quickstart.mdx @@ -0,0 +1,433 @@ +--- +title: Better Docs in 5 Minutes with DotNetDocs +sidebarTitle: Quickstart +description: Get up and running quickly is as easy as 1-2-3. +icon: play +--- + +import { ValueProposition } from '/snippets/test/ValueProposition.jsx'; + + + + + + + ### Install the DotNetDocs CLI + + + + ```bash Major Releases + dotnet tool install DotNetDocs --global + ``` + + ```bash Previews + dotnet tool install DotNetDocs --global --prerelease + ``` + + + + ### Add DotNetDocs to your Solution + + Navigate to your solution folder and create a new documentation project: + + ```bash + dotnet docs add + ``` + + By default, this creates a Mintlify documentation project using the latest stable SDK version from NuGet. To use a different documentation type or prerelease SDK: + + ```bash + # Use a different documentation type + dotnet docs add --type DocFX + + # Use the latest prerelease SDK version + dotnet docs add --prerelease + ``` + + The CLI automatically queries NuGet.org for the latest SDK version. See more options in the [CLI Reference](/test/guides/cli-reference) docs. + + This automatically: + + - locates the solution + - creates a new `{SolutionName}.Docs\{SolutionName}.Docs.docsproj` file that centralizes your documentation + - adds the new project to your solution + + The new project is pre-configured with sensible defaults. For Mintlify projects, it looks like this: + + + + + + ```xml + + + + Mintlify + true + Folder + true + + false + false + + + {solutionName} + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + + + + + + ``` + + + + ```xml + + + + Mintlify + true + Folder + true + + false + false + + + {solutionName} + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + + + + + + ``` + + + + + + ```xml + + + + DocFX + true + Folder + true + + false + false + + + + ``` + + + + ```xml + + + + DocFX + true + Folder + true + + false + false + + + + ``` + + + + + + ```xml + + + + MkDocs + true + Folder + true + + false + false + + + + ``` + + + + ```xml + + + + MkDocs + true + Folder + true + + false + false + + + + ``` + + + + + + ```xml + + + + Jekyll + true + Folder + true + + false + false + + + + ``` + + + + ```xml + + + + Jekyll + true + Folder + true + + false + false + + + + ``` + + + + + + ```xml + + + + Hugo + true + Folder + true + + false + false + + + + ``` + + + + ```xml + + + + Hugo + true + Folder + true + + false + false + + + + ``` + + + + + + ```xml + + + + Generic + true + Folder + true + + false + false + + + + ``` + + + + ```xml + + + + Generic + true + Folder + true + + false + false + + + + ``` + + + + + + You can see more of how to configure your .docsproj file in the [.docsproj Reference](/test/guides/docsproj) docs. + + Now your documentation lives right next to your code - no more context switching! Edit your doc files in Visual Studio with full IntelliSense support. + + + Your documentation project is now part of your solution and will stay in sync with your codebase. + + + + + + ### Adjust your .docsproj settings + + Change the documentation type, shut off API Reference generation, turn off conceptual docs, and adjust any other settings as necessary. + + ### Enable XML Documentation Comment compilation + + Add this to the projects where you want to extract the XML Documentation comments from your code: + + ```xml + + true + bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml + + ``` + + ### Exclude unnecessary projects + + Test projects are excluded by default. If there are other projects you'd like to exclude, update your `.docsproj` with the following property: + + ```xml + + pattern1;pattern2 + + ``` + + ### Generate API Documentation + + Run the documentation generator: + + ```bash + dotnet build + ``` + + DotNetDocs will: + - Parse your assembly XML documentation + - Extract all public types, methods, properties, and events + - Combine it with any conceptual docs you've written + - Render files in the format of your choice in the folder you specified + + + Your API documentation now stays in sync with every build - no more stale docs! + + + + + + ### Local Development with Mintlify + + Preview your docs locally with Mintlify's dev server: + + ```bash + npm i mint -g + cd {SolutionName}.Docs + mint dev + ``` + + Open [http://localhost:3000](http://localhost:3000) to see your docs with hot-reload. + + ### Deploy to Mintlify + + Connect your GitHub repository to Mintlify for automatic deployments: + + 1. Push your docs to GitHub + 2. Go to [mintlify.com](https://mintlify.com) and connect your repo + 3. Mintlify automatically deploys on every push to main + + ### Deploy to GitHub Pages + + Add a GitHub Actions workflow (`.github/workflows/docs.yml`): + + ```yaml + name: Deploy Docs + on: + push: + branches: [main] + + jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-dotnet@v3 + with: + dotnet-version: '9.0' + - name: Generate Docs + run: | + dotnet tool restore + dotnet docs generate + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./MyProject.Docs + ``` + + ### CI/CD Integration + + DotNetDocs integrates with your existing build pipeline: + + ```bash + # In your CI/CD pipeline + dotnet restore + dotnet build --configuration Release + ``` + + + Your documentation is now deployed and accessible to your users! + + + \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/site.webmanifest b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/site.webmanifest new file mode 100644 index 0000000..ccf313a --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/site.webmanifest @@ -0,0 +1,21 @@ +{ + "name": "MyWebSite", + "short_name": "MySite", + "icons": [ + { + "src": "/web-app-manifest-192x192.png", + "sizes": "192x192", + "type": "image/png", + "purpose": "maskable" + }, + { + "src": "/web-app-manifest-512x512.png", + "sizes": "512x512", + "type": "image/png", + "purpose": "maskable" + } + ], + "theme_color": "#ffffff", + "background_color": "#ffffff", + "display": "standalone" +} \ No newline at end of file diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/web-app-manifest-192x192.png b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/web-app-manifest-192x192.png new file mode 100644 index 0000000..c8d5e87 Binary files /dev/null and b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/web-app-manifest-192x192.png differ diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/web-app-manifest-512x512.png b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/web-app-manifest-512x512.png new file mode 100644 index 0000000..4e1e02c Binary files /dev/null and b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/web-app-manifest-512x512.png differ diff --git a/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/why-dotnetdocs.mdx b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/why-dotnetdocs.mdx new file mode 100644 index 0000000..2760f78 --- /dev/null +++ b/samples/collection-solution/CloudNimble.DotNetDocs.Reference.Collection/test/why-dotnetdocs.mdx @@ -0,0 +1,145 @@ +--- +title: Why DotNetDocs? +sidebarTitle: Why DotNetDocs? +description: by Robert McLaws - Former Microsoft MVP and CEO of CloudNimble +icon: square-question +--- + +## Introduction + +I've been a .NET developer for 25 years now, since the very early previews of the .NET Framework. In that time, I've seen technologies like the Web Forms, +WCF Data Services, and Silverlight come and go. I've also seen the rise of open source, the growth of the cloud, and the pervasiveness of C#. + +A .NET influencer once tweeted "When I ask myself 'What would have the most impact today?' I sit down and write documentation." + +That has always stuck with me. + +.NET has never had a truly fantastic documentation story. For a while, I had hoped DocFX would be the answer, but Microsoft kept all the best plugins for themselves and never +really contributed back to the platform in any meaningful way. I'm honestly not even sure what learn.microsoft.com is built on these days. + +Meanwhile, DocFX has languished in open source, with few contributors and even fewer updates. It's clunky, hard to customize, and frankly, a pain to use. So many hours wasted... +so much unrealized potential. + +### The Rise of AI + +In the last 18 months, documentation has gone from a "nice to have" to a requirement for AI coding tools. If the tool doesn't understand the code, it will generate shit. +Every. Single. Time. + +It happened with my own code. It happened with other libraries. Babysitting the AI so it doesn't take a wrong turn. Explaining concepts to the AI when it crashed out. Over and over +and over again. My ample forehead flatened against my desk and my hair grayer from the experience. + +Which brought me back to that quote again. + +A full decade since that tweet, how are .NET developers to follow that advice? GitHub Copilot can fill in your XML doc comments, but there's been +no place for them to go. + +### It's Time for a Change + +With Claude at my fingertips, it was time to finally build the solution the .NET Ecosystem always deserved, so every .NET developer can be a better Context Engineer. + +Six weekends later, the first release is finally ready. + +Now *every* .NET developer can write better documentation. + +So try it out. Let us know what still needs work. Open up some issues and help us make this ecosystem we love that much better. + +And write some great documentation. + +-Robert, 13 October 2025 + +--- + +## Design Tenets + +- It must be the simplest, most intuitive documenation system ever made +- It must make Documentation a first-class citizen in Visual Studio and VSCode + - This means it should be able to edit content targeting any documentation platform +- It must be built for .NET 10 first and designed for the next 25 years of .NET development +- It must support standard formats but allow for premium experiences +- It MUST support weaving long-lived and dynamically-generated content together + +## What Makes DotNetDocs Special + + + + Generate beautiful Mintlify sites, clean Markdown, structured JSON, or YAML - all from your existing XML documentation + + + Seamlessly integrate into your build process with MSBuild tasks and .NET CLI tools + + + Modular design supports custom renderers, transformers, and extensibility patterns + + + Zero configuration required - works out of the box with sensible defaults and powerful customization + + + +## Supported Output Formats + +### Traditional Formats +- **Markdown** - Clean, readable documentation for GitHub, GitLab, or any markdown processor +- **JSON** - Structured data for custom integrations and tooling +- **YAML** - Configuration-friendly format for documentation pipelines + +### Mintlify Integration +Create stunning documentation sites with Mintlify's modern design system: +- **Interactive Navigation** - Automatically generated from your namespace structure +- **Code Syntax Highlighting** - Beautiful rendering of your C# signatures and examples +- **Search Integration** - Built-in search across all your API documentation +- **Responsive Design** - Perfect on desktop, tablet, and mobile devices + +## Customization Options + +### File Organization Modes + + + ``` + 📁 docs/ + ├── 📁 MyNamespace/ + │ ├── 📄 index.mdx + │ ├── 📄 MyClass.mdx + │ └── 📁 SubNamespace/ + │ └── 📄 AnotherClass.mdx + └── 📄 index.mdx + ``` + Mirrors your namespace structure as folders + + + + ``` + 📁 docs/ + ├── 📄 index.mdx + ├── 📄 MyNamespace.MyClass.mdx + ├── 📄 MyNamespace.SubNamespace.AnotherClass.mdx + └── 📄 MyNamespace.SubNamespace.mdx + ``` + Flat structure with namespace prefixes + + + +### Mintlify Themes & Branding +- **Custom Colors** - Match your brand identity +- **Logo Integration** - Light and dark mode logo support +- **Icon Customization** - Rich icon library for types and members +- **Navigation Control** - Unified or assembly-grouped organization + +## Advanced Features + +### Smart Content Discovery +DotNetDocs automatically discovers and integrates: +- Existing MDX files in your documentation folder +- Custom navigation structures via `navigation.json` +- Conceptual documentation alongside API references +- Asset files and resources + +### Extensible Architecture +```csharp +// Custom renderer example +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline.UseCustomRenderer() + .AddTransformer() + .ConfigureContext(ctx => { /* ... */ }); +}); +``` \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Core/Configuration/RendererType.cs b/src/CloudNimble.DotNetDocs.Core/Configuration/RendererType.cs index 7cfba6a..298a3c9 100644 --- a/src/CloudNimble.DotNetDocs.Core/Configuration/RendererType.cs +++ b/src/CloudNimble.DotNetDocs.Core/Configuration/RendererType.cs @@ -1,5 +1,3 @@ -using System; - namespace CloudNimble.DotNetDocs.Core.Configuration { diff --git a/src/CloudNimble.DotNetDocs.Core/DocReferenceHandlerBase.cs b/src/CloudNimble.DotNetDocs.Core/DocReferenceHandlerBase.cs new file mode 100644 index 0000000..818cc6a --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Core/DocReferenceHandlerBase.cs @@ -0,0 +1,258 @@ +using CloudNimble.DotNetDocs.Core.Configuration; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Threading.Tasks; + +namespace CloudNimble.DotNetDocs.Core +{ + + /// + /// Base class for documentation reference handlers providing common file copying functionality. + /// + /// + /// + /// This abstract class contains shared logic for copying files from referenced documentation projects, + /// including directory recursion, exclusion pattern matching, and glob pattern support. + /// + /// + /// Derived classes should implement to provide format-specific + /// processing such as content rewriting and resource relocation. + /// + /// + public abstract class DocReferenceHandlerBase : IDocReferenceHandler + { + + #region Properties + + /// + public abstract SupportedDocumentationType DocumentationType { get; } + + #endregion + + #region Public Methods + + /// + public abstract Task ProcessAsync(DocumentationReference reference, string documentationRootPath); + + #endregion + + #region Protected Methods + + /// + /// Recursively copies a directory and its contents, excluding files that match exclusion patterns. + /// + /// The source directory to copy from. + /// The destination directory to copy to. + /// List of glob patterns for files to exclude. + /// Whether to skip files that already exist in the destination. + /// A task representing the asynchronous copy operation. + protected Task CopyDirectoryWithExclusionsAsync(string sourceDir, string destDir, List exclusionPatterns, bool skipExisting = true) + { + return CopyDirectoryWithExclusionsInternalAsync(sourceDir, destDir, sourceDir, exclusionPatterns, skipExisting); + } + + /// + /// Gets file exclusion patterns for a given documentation type when copying DocumentationReferences. + /// + /// The documentation type (Mintlify, DocFX, MkDocs, etc.). + /// A list of glob patterns for files that should be excluded from copying. + protected List GetExclusionPatternsForDocumentationType(SupportedDocumentationType documentationType) + { + return documentationType switch + { + SupportedDocumentationType.Mintlify => + [ + "**/*.mdz", // Generated zone files + "conceptual/**/*", // Conceptual docs are project-specific + "**/*.css", // Styles should come from collection project + "docs.json", // Navigation file handled separately + "assembly-list.txt", // Internal documentation generation file + "*.docsproj" // MSBuild project file + ], + SupportedDocumentationType.DocFX => + [ + "toc.yml", + "toc.yaml", + "docfx.json" + ], + SupportedDocumentationType.MkDocs => + [ + "mkdocs.yml" + ], + SupportedDocumentationType.Jekyll => + [ + "_config.yml", + "_config.yaml" + ], + SupportedDocumentationType.Hugo => + [ + "hugo.toml", + "hugo.yaml", + "hugo.json", + "config.*" + ], + _ => [] + }; + } + + /// + /// Determines if a directory should be excluded based on exclusion patterns. + /// + /// The relative path of the directory. + /// List of glob patterns for exclusion. + /// True if the directory should be excluded, false otherwise. + protected bool ShouldExcludeDirectory(string relativePath, List exclusionPatterns) + { + // Normalize path separators to forward slashes + relativePath = relativePath.Replace("\\", "/"); + + foreach (var pattern in exclusionPatterns) + { + var normalizedPattern = pattern.Replace("\\", "/"); + + // Handle directory patterns like "conceptual/**/*" + if (normalizedPattern.EndsWith("/**/*")) + { + var prefix = normalizedPattern.Substring(0, normalizedPattern.Length - 5); + if (relativePath == prefix || relativePath.StartsWith(prefix + "/")) + { + return true; + } + } + } + + return false; + } + + /// + /// Determines if a file should be excluded based on exclusion patterns. + /// + /// The relative path of the file. + /// List of glob patterns for exclusion. + /// True if the file should be excluded, false otherwise. + protected bool ShouldExcludeFile(string relativePath, List exclusionPatterns) + { + foreach (var pattern in exclusionPatterns) + { + if (MatchesGlobPattern(relativePath, pattern)) + { + return true; + } + } + + return false; + } + + /// + /// Matches a file path against a glob pattern. + /// + /// The file path to match. + /// The glob pattern. + /// True if the path matches the pattern, false otherwise. + protected bool MatchesGlobPattern(string path, string pattern) + { + // Normalize path separators to forward slashes + path = path.Replace("\\", "/"); + pattern = pattern.Replace("\\", "/"); + + // Handle **/* patterns (matches files in any subdirectory) + if (pattern.StartsWith("**/")) + { + var suffix = pattern.Substring(3); + // Match if path ends with the suffix or contains it as a path component + if (suffix.Contains("*")) + { + // Convert suffix wildcard pattern to simple check + var extension = suffix.TrimStart('*'); + return path.EndsWith(extension); + } + + return path.EndsWith(suffix) || path.Contains("/" + suffix); + } + + // Handle directory patterns like "conceptual/**/*" + if (pattern.EndsWith("/**/*")) + { + var prefix = pattern.Substring(0, pattern.Length - 5); + return path.StartsWith(prefix + "/") || path == prefix; + } + + // Handle simple wildcards like "*.css" + if (pattern.StartsWith("*.")) + { + var extension = pattern.Substring(1); + return path.EndsWith(extension); + } + + // Exact match + return path == pattern; + } + + #endregion + + #region Private Methods + + /// + /// Recursively copies a directory and its contents, excluding files that match exclusion patterns. + /// + /// The current source directory to copy from. + /// The current destination directory to copy to. + /// The base source directory for calculating relative paths. + /// List of glob patterns for files to exclude. + /// Whether to skip files that already exist in the destination. + /// A task representing the asynchronous copy operation. + private async Task CopyDirectoryWithExclusionsInternalAsync(string sourceDir, string destDir, string baseSourceDir, List exclusionPatterns, bool skipExisting) + { + if (!Directory.Exists(sourceDir)) + { + return; + } + + Directory.CreateDirectory(destDir); + + // Get all files to copy (excluding those that match patterns) + var filesToCopy = Directory.GetFiles(sourceDir) + .Select(sourceFile => new + { + SourceFile = sourceFile, + FileName = Path.GetFileName(sourceFile), + RelativePath = Path.GetRelativePath(baseSourceDir, sourceFile).Replace("\\", "/"), + DestFile = Path.Combine(destDir, Path.GetFileName(sourceFile)) + }) + .Where(f => !ShouldExcludeFile(f.RelativePath, exclusionPatterns)) + .Where(f => !skipExisting || !File.Exists(f.DestFile)) + .ToList(); + + // Copy files in parallel + await Parallel.ForEachAsync(filesToCopy, async (fileInfo, ct) => + { + await Task.Run(() => + { + File.Copy(fileInfo.SourceFile, fileInfo.DestFile, overwrite: !skipExisting); + }, ct); + }); + + // Get all subdirectories (excluding those that match patterns) + var subDirectories = Directory.GetDirectories(sourceDir) + .Select(sourceSubDir => new + { + SourceSubDir = sourceSubDir, + RelativePath = Path.GetRelativePath(baseSourceDir, sourceSubDir).Replace("\\", "/"), + DestSubDir = Path.Combine(destDir, Path.GetFileName(sourceSubDir)) + }) + .Where(d => !ShouldExcludeDirectory(d.RelativePath, exclusionPatterns)) + .ToList(); + + // Recursively copy subdirectories in parallel + await Parallel.ForEachAsync(subDirectories, async (dirInfo, ct) => + { + await CopyDirectoryWithExclusionsInternalAsync(dirInfo.SourceSubDir, dirInfo.DestSubDir, baseSourceDir, exclusionPatterns, skipExisting); + }); + } + + #endregion + + } + +} diff --git a/src/CloudNimble.DotNetDocs.Core/DocumentationManager.cs b/src/CloudNimble.DotNetDocs.Core/DocumentationManager.cs index 6513e5e..34bd939 100644 --- a/src/CloudNimble.DotNetDocs.Core/DocumentationManager.cs +++ b/src/CloudNimble.DotNetDocs.Core/DocumentationManager.cs @@ -1,4 +1,3 @@ -using CloudNimble.DotNetDocs.Core.Configuration; using System; using System.Collections.Concurrent; using System.Collections.Generic; @@ -25,6 +24,7 @@ public partial class DocumentationManager : IDisposable private readonly ConcurrentDictionary assemblyManagerCache = new(); private readonly IEnumerable enrichers; + private readonly IEnumerable referenceHandlers; private readonly IEnumerable renderers; private readonly IEnumerable transformers; private readonly ProjectContext projectContext; @@ -44,6 +44,7 @@ public partial class DocumentationManager : IDisposable /// The enrichers to apply to documentation entities. /// The transformers to apply to the documentation model. /// The renderers to generate output formats. + /// The handlers for processing documentation references. /// /// This constructor is designed to work with dependency injection containers. /// All parameters accept IEnumerable collections that are typically injected by the DI container. @@ -52,12 +53,14 @@ public DocumentationManager( ProjectContext projectContext, IEnumerable? enrichers = null, IEnumerable? transformers = null, - IEnumerable? renderers = null) + IEnumerable? renderers = null, + IEnumerable? referenceHandlers = null) { this.projectContext = projectContext ?? throw new ArgumentNullException(nameof(projectContext)); this.enrichers = enrichers ?? []; this.transformers = transformers ?? []; this.renderers = renderers ?? []; + this.referenceHandlers = referenceHandlers ?? []; } #endregion @@ -109,9 +112,30 @@ public async Task ProcessAsync(string assemblyPath, string xmlPath) /// A task representing the asynchronous processing operation. public async Task ProcessAsync(IEnumerable<(string assemblyPath, string xmlPath)> assemblies) { + var assemblyList = assemblies.ToList(); + var hasReferences = projectContext.DocumentationReferences.Any(); + + // Documentation-only mode: only process references, no assemblies + if (assemblyList.Count == 0) + { + if (hasReferences) + { + // Process referenced documentation with format-specific handlers + await ProcessDocumentationReferencesAsync(); + + // Renderers still need to run for navigation file processing (pass null model) + foreach (var renderer in renderers) + { + await renderer.RenderAsync(null); + } + } + + return; + } + // STEP 1: Collect all DocAssembly models var docAssemblies = new List(); - foreach (var (assemblyPath, xmlPath) in assemblies) + foreach (var (assemblyPath, xmlPath) in assemblyList) { var manager = GetOrCreateAssemblyManager(assemblyPath, xmlPath); var model = await manager.DocumentAsync(projectContext); @@ -123,7 +147,7 @@ public async Task ProcessAsync(IEnumerable<(string assemblyPath, string xmlPath) // when multiple assemblies extend the same external type (e.g., IServiceCollection) var mergedModel = await MergeDocAssembliesAsync(docAssemblies); - if (projectContext.ConceptualDocsEnabled) + if (mergedModel is not null && projectContext.ConceptualDocsEnabled) { // STEP 3: Generate placeholder files for merged model with all renderers // No longer per-assembly, so shadow classes are deduplicated @@ -135,14 +159,17 @@ public async Task ProcessAsync(IEnumerable<(string assemblyPath, string xmlPath) } // STEP 5: Apply enrichers, transformers, and renderers - foreach (var enricher in enrichers) + if (mergedModel is not null) { - await enricher.EnrichAsync(mergedModel); - } + foreach (var enricher in enrichers) + { + await enricher.EnrichAsync(mergedModel); + } - foreach (var transformer in transformers) - { - await transformer.TransformAsync(mergedModel); + foreach (var transformer in transformers) + { + await transformer.TransformAsync(mergedModel); + } } foreach (var renderer in renderers) @@ -150,11 +177,11 @@ public async Task ProcessAsync(IEnumerable<(string assemblyPath, string xmlPath) await renderer.RenderAsync(mergedModel); } - // STEP 6: Copy referenced documentation files if any references exist + // STEP 6: Process referenced documentation files if any references exist // Note: Navigation combining happens inside each renderer's RenderAsync() before saving - if (projectContext.DocumentationReferences.Any()) + if (hasReferences) { - await CopyReferencedDocumentationAsync(); + await ProcessDocumentationReferencesAsync(); } } @@ -167,14 +194,15 @@ public async Task ProcessAsync(IEnumerable<(string assemblyPath, string xmlPath) /// Merges multiple DocAssembly models into a single unified model. /// /// The collection of DocAssembly models to merge. - /// A task representing the asynchronous merge operation. - internal async Task MergeDocAssembliesAsync(List assemblies) + /// A task representing the asynchronous merge operation, or null if no assemblies are provided. + internal async Task MergeDocAssembliesAsync(List assemblies) { ArgumentNullException.ThrowIfNull(assemblies); if (assemblies.Count == 0) { - throw new ArgumentException("At least one assembly must be provided", nameof(assemblies)); + // Return null for documentation-only scenarios (no assemblies to document) + return null; } if (assemblies.Count == 1) @@ -515,439 +543,26 @@ internal static bool IsTodoPlaceholderFile(string content) } /// - /// Copies referenced documentation files to the collection documentation root. + /// Processes referenced documentation using format-specific handlers. /// - /// A task representing the asynchronous copy operation. - internal async Task CopyReferencedDocumentationAsync() + /// A task representing the asynchronous processing operation. + /// + /// Each reference is processed by the appropriate + /// based on its documentation type. Handlers are responsible for copying files, + /// rewriting content paths, and relocating resources. + /// + internal async Task ProcessDocumentationReferencesAsync() { foreach (var reference in projectContext.DocumentationReferences) { - var sourcePath = reference.DocumentationRoot; - var destPath = Path.Combine(projectContext.DocumentationRootPath, reference.DestinationPath); - - // Get exclusion patterns for this documentation type - var exclusionPatterns = GetExclusionPatternsForDocumentationType(reference.DocumentationType); - - // Copy all files except those matching exclusion patterns - // External documentation is authoritative - always overwrite existing files - await CopyDirectoryWithExclusionsAsync(sourcePath, destPath, exclusionPatterns, skipExisting: false); - } - } + var handler = referenceHandlers + .FirstOrDefault(h => h.DocumentationType == reference.DocumentationType); - /// - /// Gets file glob patterns for a given documentation type. - /// - /// The documentation type (Mintlify, DocFX, MkDocs, etc.). - /// When true, excludes root navigation files like docs.json, toc.yml, etc. Set to true when copying DocumentationReferences to prevent navigation file conflicts. - /// A list of glob patterns for files that should be copied. - internal List GetFilePatternsForDocumentationType(SupportedDocumentationType documentationType, bool excludeRootNavigationFiles = false) - { - var patterns = documentationType switch - { - SupportedDocumentationType.Mintlify => - [ - "*.md", - "*.mdx", - "*.mdz", - "docs.json", - "images/**/*", - "favicon.*", - "snippets/**/*" - ], - SupportedDocumentationType.DocFX => - [ - "*.md", - "*.yml", - "*.yaml", - "toc.yml", - "toc.yaml", - "docfx.json", - "images/**/*", - "articles/**/*", - "api/**/*" - ], - SupportedDocumentationType.MkDocs => - [ - "*.md", - "mkdocs.yml", - "docs/**/*", - "overrides/**/*", - "theme/**/*" - ], - SupportedDocumentationType.Jekyll => - [ - "*.md", - "*.html", - "_config.yml", - "_config.yaml", - "_posts/**/*", - "_layouts/**/*", - "_includes/**/*", - "assets/**/*" - ], - SupportedDocumentationType.Hugo => - [ - "*.md", - "hugo.toml", - "hugo.yaml", - "hugo.json", - "content/**/*", - "static/**/*", - "layouts/**/*" - ], - SupportedDocumentationType.Generic => - [ - "*.md", - "*.html", - "images/**/*", - "assets/**/*" - ], - _ => new List + if (handler is not null) { - "*.md", - "*.html", - "images/**/*", - "assets/**/*" - } - }; - - if (excludeRootNavigationFiles) - { - // Remove root navigation files based on documentation type - switch (documentationType) - { - case SupportedDocumentationType.Mintlify: - patterns.Remove("docs.json"); - break; - case SupportedDocumentationType.DocFX: - patterns.Remove("toc.yml"); - patterns.Remove("toc.yaml"); - patterns.Remove("docfx.json"); - break; - case SupportedDocumentationType.MkDocs: - patterns.Remove("mkdocs.yml"); - break; - case SupportedDocumentationType.Jekyll: - patterns.Remove("_config.yml"); - patterns.Remove("_config.yaml"); - break; - case SupportedDocumentationType.Hugo: - patterns.Remove("hugo.toml"); - patterns.Remove("hugo.yaml"); - patterns.Remove("hugo.json"); - break; + await handler.ProcessAsync(reference, projectContext.DocumentationRootPath); } } - - return patterns; - } - - /// - /// Gets file exclusion patterns for a given documentation type when copying DocumentationReferences. - /// - /// The documentation type (Mintlify, DocFX, MkDocs, etc.). - /// A list of glob patterns for files that should be excluded from copying. - internal List GetExclusionPatternsForDocumentationType(SupportedDocumentationType documentationType) - { - return documentationType switch - { - SupportedDocumentationType.Mintlify => - [ - "**/*.mdz", // Generated zone files - "conceptual/**/*", // Conceptual docs are project-specific - "**/*.css", // Styles should come from collection project - "docs.json", // Navigation file handled separately - "assembly-list.txt", // Internal documentation generation file - "*.docsproj" // MSBuild project file - ], - SupportedDocumentationType.DocFX => - [ - "toc.yml", - "toc.yaml", - "docfx.json" - ], - SupportedDocumentationType.MkDocs => - [ - "mkdocs.yml" - ], - SupportedDocumentationType.Jekyll => - [ - "_config.yml", - "_config.yaml" - ], - SupportedDocumentationType.Hugo => - [ - "hugo.toml", - "hugo.yaml", - "hugo.json", - "config.*" - ], - _ => [] - }; - } - - /// - /// Copies files matching a glob pattern from source to destination directory. - /// - /// The source directory to copy from. - /// The destination directory to copy to. - /// The glob pattern for files to copy. - /// Whether to skip files that already exist in the destination. - /// A task representing the asynchronous copy operation. - internal async Task CopyFilesAsync(string sourceDir, string destDir, string pattern, bool skipExisting = true) - { - if (!Directory.Exists(sourceDir)) - { - return; - } - - // Ensure destination directory exists - Directory.CreateDirectory(destDir); - - // Handle recursive patterns (e.g., "images/**/*") - if (pattern.Contains("**")) - { - var parts = pattern.Split(new[] { "/**/" }, StringSplitOptions.None); - if (parts.Length == 2) - { - var subDir = parts[0]; - var filePattern = parts[1]; - - var sourceSubDir = Path.Combine(sourceDir, subDir); - if (Directory.Exists(sourceSubDir)) - { - var destSubDir = Path.Combine(destDir, subDir); - await CopyDirectoryRecursiveAsync(sourceSubDir, destSubDir, filePattern, skipExisting); - } - } - } - else - { - // Simple pattern - copy files matching pattern in root directory - var searchPattern = pattern.Contains('*') ? pattern : pattern; - var files = Directory.GetFiles(sourceDir, searchPattern, SearchOption.TopDirectoryOnly); - - foreach (var sourceFile in files) - { - var fileName = Path.GetFileName(sourceFile); - var destFile = Path.Combine(destDir, fileName); - - if (skipExisting && File.Exists(destFile)) - { - continue; - } - - File.Copy(sourceFile, destFile, overwrite: !skipExisting); - } - - await Task.CompletedTask; - } - } - - /// - /// Recursively copies a directory and its contents. - /// - /// The source directory. - /// The destination directory. - /// The file pattern to match (e.g., "*" for all files). - /// Whether to skip files that already exist. - /// A task representing the asynchronous copy operation. - internal async Task CopyDirectoryRecursiveAsync(string sourceDir, string destDir, string filePattern, bool skipExisting) - { - if (!Directory.Exists(sourceDir)) - { - return; - } - - // Create destination directory - Directory.CreateDirectory(destDir); - - // Copy files - var files = Directory.GetFiles(sourceDir, filePattern, SearchOption.TopDirectoryOnly); - foreach (var sourceFile in files) - { - var fileName = Path.GetFileName(sourceFile); - var destFile = Path.Combine(destDir, fileName); - - if (skipExisting && File.Exists(destFile)) - { - continue; - } - - File.Copy(sourceFile, destFile, overwrite: !skipExisting); - } - - // Recursively copy subdirectories - var subDirs = Directory.GetDirectories(sourceDir); - foreach (var subDir in subDirs) - { - var dirName = Path.GetFileName(subDir); - var destSubDir = Path.Combine(destDir, dirName); - await CopyDirectoryRecursiveAsync(subDir, destSubDir, filePattern, skipExisting); - } - - await Task.CompletedTask; - } - - /// - /// Recursively copies a directory and its contents, excluding files that match exclusion patterns. - /// - /// The source directory to copy from. - /// The destination directory to copy to. - /// List of glob patterns for files to exclude. - /// Whether to skip files that already exist in the destination. - /// A task representing the asynchronous copy operation. - internal Task CopyDirectoryWithExclusionsAsync(string sourceDir, string destDir, List exclusionPatterns, bool skipExisting = true) - { - return CopyDirectoryWithExclusionsAsync(sourceDir, destDir, sourceDir, exclusionPatterns, skipExisting); - } - - /// - /// Recursively copies a directory and its contents, excluding files that match exclusion patterns. - /// - /// The current source directory to copy from. - /// The current destination directory to copy to. - /// The base source directory for calculating relative paths. - /// List of glob patterns for files to exclude. - /// Whether to skip files that already exist in the destination. - /// A task representing the asynchronous copy operation. - private async Task CopyDirectoryWithExclusionsAsync(string sourceDir, string destDir, string baseSourceDir, List exclusionPatterns, bool skipExisting) - { - if (!Directory.Exists(sourceDir)) - { - return; - } - - Directory.CreateDirectory(destDir); - - // Get all files to copy (excluding those that match patterns) - var filesToCopy = Directory.GetFiles(sourceDir) - .Select(sourceFile => new - { - SourceFile = sourceFile, - FileName = Path.GetFileName(sourceFile), - RelativePath = Path.GetRelativePath(baseSourceDir, sourceFile).Replace("\\", "/"), - DestFile = Path.Combine(destDir, Path.GetFileName(sourceFile)) - }) - .Where(f => !ShouldExcludeFile(f.RelativePath, exclusionPatterns)) - .Where(f => !skipExisting || !File.Exists(f.DestFile)) - .ToList(); - - // Copy files in parallel - await Parallel.ForEachAsync(filesToCopy, async (fileInfo, ct) => - { - await Task.Run(() => - { - File.Copy(fileInfo.SourceFile, fileInfo.DestFile, overwrite: !skipExisting); - }, ct); - }); - - // Get all subdirectories (excluding those that match patterns) - var subDirectories = Directory.GetDirectories(sourceDir) - .Select(sourceSubDir => new - { - SourceSubDir = sourceSubDir, - RelativePath = Path.GetRelativePath(baseSourceDir, sourceSubDir).Replace("\\", "/"), - DestSubDir = Path.Combine(destDir, Path.GetFileName(sourceSubDir)) - }) - .Where(d => !ShouldExcludeDirectory(d.RelativePath, exclusionPatterns)) - .ToList(); - - // Recursively copy subdirectories in parallel - await Parallel.ForEachAsync(subDirectories, async (dirInfo, ct) => - { - await CopyDirectoryWithExclusionsAsync(dirInfo.SourceSubDir, dirInfo.DestSubDir, baseSourceDir, exclusionPatterns, skipExisting); - }); - } - - /// - /// Determines if a directory should be excluded based on exclusion patterns. - /// - /// The relative path of the directory. - /// List of glob patterns for exclusion. - /// True if the directory should be excluded, false otherwise. - internal bool ShouldExcludeDirectory(string relativePath, List exclusionPatterns) - { - // Normalize path separators to forward slashes - relativePath = relativePath.Replace("\\", "/"); - - foreach (var pattern in exclusionPatterns) - { - var normalizedPattern = pattern.Replace("\\", "/"); - - // Handle directory patterns like "conceptual/**/*" - if (normalizedPattern.EndsWith("/**/*")) - { - var prefix = normalizedPattern.Substring(0, normalizedPattern.Length - 5); - if (relativePath == prefix || relativePath.StartsWith(prefix + "/")) - { - return true; - } - } - } - return false; - } - - /// - /// Determines if a file should be excluded based on exclusion patterns. - /// - /// The relative path of the file. - /// List of glob patterns for exclusion. - /// True if the file should be excluded, false otherwise. - internal bool ShouldExcludeFile(string relativePath, List exclusionPatterns) - { - foreach (var pattern in exclusionPatterns) - { - if (MatchesGlobPattern(relativePath, pattern)) - { - return true; - } - } - return false; - } - - /// - /// Matches a file path against a glob pattern. - /// - /// The file path to match. - /// The glob pattern. - /// True if the path matches the pattern, false otherwise. - internal bool MatchesGlobPattern(string path, string pattern) - { - // Normalize path separators to forward slashes - path = path.Replace("\\", "/"); - pattern = pattern.Replace("\\", "/"); - - // Handle **/* patterns (matches files in any subdirectory) - if (pattern.StartsWith("**/")) - { - var suffix = pattern.Substring(3); - // Match if path ends with the suffix or contains it as a path component - if (suffix.Contains("*")) - { - // Convert suffix wildcard pattern to simple check - var extension = suffix.TrimStart('*'); - return path.EndsWith(extension); - } - return path.EndsWith(suffix) || path.Contains("/" + suffix); - } - - // Handle directory patterns like "conceptual/**/*" - if (pattern.EndsWith("/**/*")) - { - var prefix = pattern.Substring(0, pattern.Length - 5); - return path.StartsWith(prefix + "/") || path == prefix; - } - - // Handle simple wildcards like "*.css" - if (pattern.StartsWith("*.")) - { - var extension = pattern.Substring(1); - return path.EndsWith(extension); - } - - // Exact match - return path == pattern; } #endregion diff --git a/src/CloudNimble.DotNetDocs.Core/Extensions/DotNetDocsCore_IServiceCollectionExtensions.cs b/src/CloudNimble.DotNetDocs.Core/Extensions/DotNetDocsCore_IServiceCollectionExtensions.cs index 878272a..b5a9569 100644 --- a/src/CloudNimble.DotNetDocs.Core/Extensions/DotNetDocsCore_IServiceCollectionExtensions.cs +++ b/src/CloudNimble.DotNetDocs.Core/Extensions/DotNetDocsCore_IServiceCollectionExtensions.cs @@ -51,6 +51,9 @@ public static IServiceCollection AddDotNetDocs(this IServiceCollection services, // Register the MarkdownXmlTransformer for processing XML documentation tags services.TryAddEnumerable(ServiceDescriptor.Scoped()); + // Register the MarkdownDocReferenceHandler for processing DocumentationReferences + services.TryAddEnumerable(ServiceDescriptor.Scoped()); + return services; } @@ -126,13 +129,19 @@ public static IServiceCollection AddDotNetDocsPipeline(this IServiceCollection s /// The service collection. /// The service collection for chaining. /// - /// Registers MarkdownRenderer as Scoped implementation of IDocRenderer. - /// Also registers MarkdownXmlTransformer to process XML documentation tags. + /// Registers the following services: + /// + /// MarkdownRenderer as Scoped implementation of IDocRenderer + /// MarkdownXmlTransformer for processing XML documentation tags + /// MarkdownDocReferenceHandler for processing DocumentationReferences + /// /// public static IServiceCollection AddMarkdownRenderer(this IServiceCollection services) { services.TryAddEnumerable(ServiceDescriptor.Scoped()); services.TryAddEnumerable(ServiceDescriptor.Scoped()); + services.TryAddEnumerable(ServiceDescriptor.Scoped()); + return services; } diff --git a/src/CloudNimble.DotNetDocs.Core/IDocReferenceHandler.cs b/src/CloudNimble.DotNetDocs.Core/IDocReferenceHandler.cs new file mode 100644 index 0000000..1224d5b --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Core/IDocReferenceHandler.cs @@ -0,0 +1,61 @@ +using CloudNimble.DotNetDocs.Core.Configuration; +using System.Threading.Tasks; + +namespace CloudNimble.DotNetDocs.Core +{ + + /// + /// Defines a handler for processing documentation references from other projects. + /// + /// + /// + /// Implementations of this interface are responsible for copying files from referenced documentation + /// projects, rewriting internal paths in content files, and relocating resources to appropriate + /// locations in the collection project. + /// + /// + /// This interface follows the same pattern as , , + /// and for format-specific documentation processing. + /// + /// + public interface IDocReferenceHandler + { + + #region Properties + + /// + /// Gets the documentation type this handler supports. + /// + /// + /// The that this handler can process. + /// + SupportedDocumentationType DocumentationType { get; } + + #endregion + + #region Public Methods + + /// + /// Processes a documentation reference by copying files, rewriting content paths, + /// and relocating resources as appropriate for this documentation format. + /// + /// The documentation reference to process. + /// The root path of the collection documentation output. + /// A task representing the asynchronous processing operation. + /// + /// + /// Implementations should handle the following responsibilities: + /// + /// + /// Copy content files from the source documentation root to the destination path. + /// Rewrite internal absolute paths in content files to use the destination path prefix. + /// Relocate resources (images, snippets, etc.) to central locations with proper namespacing. + /// + /// + Task ProcessAsync(DocumentationReference reference, string documentationRootPath); + + #endregion + + } + +} diff --git a/src/CloudNimble.DotNetDocs.Core/IDocRenderer.cs b/src/CloudNimble.DotNetDocs.Core/IDocRenderer.cs index cd93cd4..2d45920 100644 --- a/src/CloudNimble.DotNetDocs.Core/IDocRenderer.cs +++ b/src/CloudNimble.DotNetDocs.Core/IDocRenderer.cs @@ -18,13 +18,19 @@ public interface IDocRenderer /// /// Renders the documentation assembly to the output path specified in the project context. /// - /// The documentation assembly to render. + /// The documentation assembly to render, or null for documentation-only mode. /// A task representing the asynchronous rendering operation. /// + /// + /// When model is null, the renderer should skip API reference generation but still process + /// any other operations like navigation file merging (e.g., combining DocumentationReferences). + /// + /// /// Renderers that support navigation combining (e.g., Mintlify) should access /// Context.DocumentationReferences and combine navigation before saving their configuration. + /// /// - Task RenderAsync(DocAssembly model); + Task RenderAsync(DocAssembly? model); /// /// Renders placeholder conceptual content files for the documentation assembly. diff --git a/src/CloudNimble.DotNetDocs.Core/MarkdownDocReferenceHandler.cs b/src/CloudNimble.DotNetDocs.Core/MarkdownDocReferenceHandler.cs new file mode 100644 index 0000000..4ed34cf --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Core/MarkdownDocReferenceHandler.cs @@ -0,0 +1,461 @@ +using CloudNimble.DotNetDocs.Core.Configuration; +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Text.RegularExpressions; +using System.Threading.Tasks; + +namespace CloudNimble.DotNetDocs.Core +{ + + /// + /// Handler for Markdown-based documentation references providing content path rewriting. + /// + /// + /// + /// This class extends to add Markdown-specific + /// content rewriting functionality. It handles standard Markdown image and link syntax, + /// rewriting absolute paths to include the destination path prefix. + /// + /// + /// Derived classes can extend this behavior to handle format-specific patterns such as + /// JSX imports, component props, or other content-specific path references. + /// + /// + public partial class MarkdownDocReferenceHandler : DocReferenceHandlerBase + { + + #region Private Fields + + /// + /// Matches Markdown image syntax: ![alt text](/path/to/image.png) + /// + [GeneratedRegex(@"!\[[^\]]*\]\((?/[^)\s#?]+)(?[^)]*)\)", + RegexOptions.Compiled, matchTimeoutMilliseconds: 1000)] + private static partial Regex MarkdownImageRegex(); + + /// + /// Matches Markdown link syntax: [text](/path/to/page) + /// + [GeneratedRegex(@"(?[^\]]*)\]\((?/[^)\s#?]+)(?[^)]*)\)", + RegexOptions.Compiled, matchTimeoutMilliseconds: 1000)] + private static partial Regex MarkdownLinkRegex(); + + /// + /// Matches fenced code blocks (``` or ~~~) for detection. + /// + [GeneratedRegex(@"^(?`{3,}|~{3,})", + RegexOptions.Multiline | RegexOptions.Compiled, matchTimeoutMilliseconds: 1000)] + private static partial Regex CodeFenceRegex(); + + /// + /// Resource directories that get their own namespaced subdirectories. + /// + private static readonly HashSet ResourceDirectories = new(StringComparer.OrdinalIgnoreCase) + { + "images", + "snippets" + }; + + /// + /// File extensions that should have content rewritten. + /// + private static readonly HashSet RewriteExtensions = new(StringComparer.OrdinalIgnoreCase) + { + ".md" + }; + + #endregion + + #region Properties + + /// + public override SupportedDocumentationType DocumentationType => SupportedDocumentationType.Generic; + + #endregion + + #region Public Methods + + /// + public override async Task ProcessAsync(DocumentationReference reference, string documentationRootPath) + { + ArgumentNullException.ThrowIfNull(reference); + ArgumentException.ThrowIfNullOrWhiteSpace(documentationRootPath); + + var sourcePath = reference.DocumentationRoot; + var destPath = Path.Combine(documentationRootPath, reference.DestinationPath); + + // Step 1: Copy and rewrite content files (excluding resource directories) + await CopyAndRewriteFilesAsync(sourcePath, destPath, reference.DestinationPath, reference.DocumentationType); + + // Step 2: Relocate resource directories to central locations + await RelocateResourcesAsync(sourcePath, documentationRootPath, reference.DestinationPath); + } + + #endregion + + #region Protected Methods + + /// + /// Copies files from source to destination with content path rewriting. + /// + /// The source directory. + /// The destination directory. + /// The destination path prefix for rewriting. + /// The documentation type for exclusion patterns. + /// A task representing the asynchronous operation. + protected virtual async Task CopyAndRewriteFilesAsync(string sourceDir, string destDir, string destinationPath, SupportedDocumentationType documentationType) + { + if (!Directory.Exists(sourceDir)) + { + return; + } + + // Get exclusion patterns and add resource directories to exclude + var exclusionPatterns = GetExclusionPatternsForDocumentationType(documentationType); + + // Add resource directories to exclusion (they get relocated separately) + foreach (var resourceDir in ResourceDirectories) + { + exclusionPatterns.Add($"{resourceDir}/**/*"); + } + + // Ensure destination directory exists + Directory.CreateDirectory(destDir); + + await CopyDirectoryWithRewritingAsync(sourceDir, destDir, sourceDir, destinationPath, exclusionPatterns); + } + + /// + /// Relocates resource directories to central locations with namespacing. + /// + /// The source documentation root. + /// The collection documentation root. + /// The destination path for namespacing. + /// A task representing the asynchronous operation. + protected virtual async Task RelocateResourcesAsync(string sourceDir, string documentationRootPath, string destinationPath) + { + foreach (var resourceDir in ResourceDirectories) + { + var sourceResourceDir = Path.Combine(sourceDir, resourceDir); + if (!Directory.Exists(sourceResourceDir)) + { + continue; + } + + // Relocate to central location: /images/{destPath}/ or /snippets/{destPath}/ + var destResourceDir = Path.Combine(documentationRootPath, resourceDir, destinationPath); + + await CopyDirectoryWithExclusionsAsync(sourceResourceDir, destResourceDir, [], skipExisting: false); + } + } + + /// + /// Rewrites Markdown content to update absolute paths with the destination path prefix. + /// + /// The Markdown content to rewrite. + /// The destination path prefix to apply. + /// The content with rewritten paths. + /// + /// + /// This method handles standard Markdown image and link syntax: + /// + /// + /// ![alt](/images/x.png) → ![alt](/images/{dest}/x.png) + /// [text](/guides/x) → [text]/{dest}/guides/x) + /// + /// + /// Content inside fenced code blocks is preserved and not rewritten. + /// + /// + protected virtual string RewriteMarkdownContent(string content, string destinationPath) + { + if (string.IsNullOrWhiteSpace(content) || string.IsNullOrWhiteSpace(destinationPath)) + { + return content; + } + + // Find all code block regions to skip + var codeBlockRanges = FindCodeBlockRanges(content); + + // Rewrite Markdown images + content = MarkdownImageRegex().Replace(content, match => + { + if (IsInCodeBlock(match.Index, codeBlockRanges)) + { + return match.Value; + } + + var path = match.Groups["path"].Value; + var suffix = match.Groups["suffix"].Value; + var rewrittenPath = RewritePath(path, destinationPath); + + return $"![{GetImageAltText(match.Value)}]({rewrittenPath}{suffix})"; + }); + + // Rewrite Markdown links + content = MarkdownLinkRegex().Replace(content, match => + { + if (IsInCodeBlock(match.Index, codeBlockRanges)) + { + return match.Value; + } + + var text = match.Groups["text"].Value; + var path = match.Groups["path"].Value; + var suffix = match.Groups["suffix"].Value; + var rewrittenPath = RewritePath(path, destinationPath); + + return $"[{text}]({rewrittenPath}{suffix})"; + }); + + return content; + } + + /// + /// Rewrites an absolute path to include the destination path prefix. + /// + /// The original absolute path (starting with /). + /// The destination path prefix to apply. + /// The rewritten path with the appropriate prefix. + /// + /// + /// Resource paths (images, snippets) get the prefix inserted after the resource directory: + /// /images/logo.png → /images/{dest}/logo.png + /// + /// + /// Page paths get the prefix at the root: + /// /guides/overview → /{dest}/guides/overview + /// + /// + protected virtual string RewritePath(string originalPath, string destinationPath) + { + if (string.IsNullOrWhiteSpace(originalPath) || !originalPath.StartsWith("/")) + { + return originalPath; + } + + // Skip if already prefixed with destination path + if (originalPath.StartsWith($"/{destinationPath}/", StringComparison.OrdinalIgnoreCase)) + { + return originalPath; + } + + // Skip external URLs (shouldn't have / prefix but check anyway) + if (originalPath.StartsWith("//")) + { + return originalPath; + } + + // Extract the first path segment + var pathWithoutLeadingSlash = originalPath.TrimStart('/'); + var firstSlashIndex = pathWithoutLeadingSlash.IndexOf('/'); + var firstSegment = firstSlashIndex >= 0 + ? pathWithoutLeadingSlash.Substring(0, firstSlashIndex) + : pathWithoutLeadingSlash; + + // Check if this is a resource directory + if (ResourceDirectories.Contains(firstSegment)) + { + // Resource paths: /images/logo.png → /images/{dest}/logo.png + var remainingPath = firstSlashIndex >= 0 + ? pathWithoutLeadingSlash.Substring(firstSlashIndex) + : ""; + + return $"/{firstSegment}/{destinationPath}{remainingPath}"; + } + + // Page paths: /guides/overview → /{dest}/guides/overview + return $"/{destinationPath}{originalPath}"; + } + + /// + /// Determines if a position in the content is inside a fenced code block. + /// + /// The character position to check. + /// The list of code block ranges in the content. + /// True if the position is inside a code block, false otherwise. + protected bool IsInCodeBlock(int position, List<(int Start, int End)> codeBlockRanges) + { + foreach (var (start, end) in codeBlockRanges) + { + if (position >= start && position <= end) + { + return true; + } + } + + return false; + } + + /// + /// Determines if a position in the content is inside a fenced code block. + /// + /// The full content to analyze. + /// The character position to check. + /// True if the position is inside a code block, false otherwise. + protected bool IsInsideCodeBlock(string content, int position) + { + var ranges = FindCodeBlockRanges(content); + return IsInCodeBlock(position, ranges); + } + + #endregion + + #region Private Methods + + /// + /// Finds all fenced code block ranges in the content. + /// + /// The content to analyze. + /// A list of tuples representing (start, end) positions of code blocks. + private List<(int Start, int End)> FindCodeBlockRanges(string content) + { + var ranges = new List<(int Start, int End)>(); + var lines = content.Split('\n'); + var currentPosition = 0; + var inCodeBlock = false; + var codeBlockStart = 0; + var currentFence = ""; + + foreach (var line in lines) + { + var match = CodeFenceRegex().Match(line); + if (match.Success) + { + var fence = match.Groups["fence"].Value; + if (!inCodeBlock) + { + // Starting a code block + inCodeBlock = true; + codeBlockStart = currentPosition; + currentFence = fence.Substring(0, 1); // Get just ` or ~ + } + else if (line.TrimStart().StartsWith(currentFence)) + { + // Ending a code block (must use same fence character) + var fenceInLine = CodeFenceRegex().Match(line.TrimStart()); + if (fenceInLine.Success) + { + inCodeBlock = false; + ranges.Add((codeBlockStart, currentPosition + line.Length)); + currentFence = ""; + } + } + } + + currentPosition += line.Length + 1; // +1 for the newline + } + + // Handle unclosed code block at end of content + if (inCodeBlock) + { + ranges.Add((codeBlockStart, content.Length)); + } + + return ranges; + } + + /// + /// Extracts the alt text from a Markdown image match. + /// + /// The full match value. + /// The alt text, or empty string if not found. + private string GetImageAltText(string matchValue) + { + var startIndex = matchValue.IndexOf('[') + 1; + var endIndex = matchValue.IndexOf(']'); + if (startIndex >= 0 && endIndex > startIndex) + { + return matchValue.Substring(startIndex, endIndex - startIndex); + } + + return ""; + } + + /// + /// Recursively copies a directory with content rewriting. + /// + /// The current source directory. + /// The current destination directory. + /// The base source directory for relative paths. + /// The destination path prefix for rewriting. + /// Patterns for files to exclude. + /// A task representing the asynchronous operation. + private async Task CopyDirectoryWithRewritingAsync( + string sourceDir, + string destDir, + string baseSourceDir, + string destinationPath, + List exclusionPatterns) + { + if (!Directory.Exists(sourceDir)) + { + return; + } + + Directory.CreateDirectory(destDir); + + // Get all files to copy + var files = Directory.GetFiles(sourceDir); + var filesToProcess = files + .Select(sourceFile => new + { + SourceFile = sourceFile, + RelativePath = Path.GetRelativePath(baseSourceDir, sourceFile).Replace("\\", "/"), + DestFile = Path.Combine(destDir, Path.GetFileName(sourceFile)), + Extension = Path.GetExtension(sourceFile) + }) + .Where(f => !ShouldExcludeFile(f.RelativePath, exclusionPatterns)) + .ToList(); + + // Process files + await Parallel.ForEachAsync(filesToProcess, async (fileInfo, ct) => + { + await Task.Run(() => + { + if (RewriteExtensions.Contains(fileInfo.Extension)) + { + // Read, rewrite, and write content + var content = File.ReadAllText(fileInfo.SourceFile); + var rewrittenContent = RewriteMarkdownContent(content, destinationPath); + File.WriteAllText(fileInfo.DestFile, rewrittenContent); + } + else + { + // Just copy the file + File.Copy(fileInfo.SourceFile, fileInfo.DestFile, overwrite: true); + } + }, ct); + }); + + // Get subdirectories to process + var subDirectories = Directory.GetDirectories(sourceDir) + .Select(subDir => new + { + SourceSubDir = subDir, + RelativePath = Path.GetRelativePath(baseSourceDir, subDir).Replace("\\", "/"), + DestSubDir = Path.Combine(destDir, Path.GetFileName(subDir)) + }) + .Where(d => !ShouldExcludeDirectory(d.RelativePath, exclusionPatterns)) + .Where(d => !ResourceDirectories.Contains(Path.GetFileName(d.SourceSubDir))) + .ToList(); + + // Recursively process subdirectories + await Parallel.ForEachAsync(subDirectories, async (dirInfo, ct) => + { + await CopyDirectoryWithRewritingAsync( + dirInfo.SourceSubDir, + dirInfo.DestSubDir, + baseSourceDir, + destinationPath, + exclusionPatterns); + }); + } + + #endregion + + } + +} diff --git a/src/CloudNimble.DotNetDocs.Core/ProjectContext.cs b/src/CloudNimble.DotNetDocs.Core/ProjectContext.cs index d2b7cad..f6077a9 100644 --- a/src/CloudNimble.DotNetDocs.Core/ProjectContext.cs +++ b/src/CloudNimble.DotNetDocs.Core/ProjectContext.cs @@ -211,11 +211,11 @@ public ProjectContext(List? includedMembers, params string[]? ref } // Default exclusions for common test framework injected types - ExcludedTypes = new HashSet - { + ExcludedTypes = + [ "*.MicrosoftTestingPlatformEntryPoint", "*.SelfRegisteredExtensions" - }; + ]; } #endregion diff --git a/src/CloudNimble.DotNetDocs.Core/Renderers/JsonRenderer.cs b/src/CloudNimble.DotNetDocs.Core/Renderers/JsonRenderer.cs index 051a54e..bfdf1c2 100644 --- a/src/CloudNimble.DotNetDocs.Core/Renderers/JsonRenderer.cs +++ b/src/CloudNimble.DotNetDocs.Core/Renderers/JsonRenderer.cs @@ -50,11 +50,15 @@ public JsonRenderer(ProjectContext? context = null, JsonRendererOptions? options /// /// Renders the documentation assembly to JSON files. /// - /// The documentation assembly to render. + /// The documentation assembly to render, or null for documentation-only mode. /// A task representing the asynchronous rendering operation. - public async Task RenderAsync(DocAssembly model) + public async Task RenderAsync(DocAssembly? model) { - ArgumentNullException.ThrowIfNull(model); + // Nothing to render without a model - just return + if (model is null) + { + return; + } var outputPath = Path.Combine(Context.DocumentationRootPath, Context.ApiReferencePath); diff --git a/src/CloudNimble.DotNetDocs.Core/Renderers/MarkdownRenderer.cs b/src/CloudNimble.DotNetDocs.Core/Renderers/MarkdownRenderer.cs index 5be4bf8..575410e 100644 --- a/src/CloudNimble.DotNetDocs.Core/Renderers/MarkdownRenderer.cs +++ b/src/CloudNimble.DotNetDocs.Core/Renderers/MarkdownRenderer.cs @@ -34,11 +34,15 @@ public MarkdownRenderer(ProjectContext? context = null) : base(context) /// /// Renders the documentation assembly to Markdown files. /// - /// The documentation assembly to render. + /// The documentation assembly to render, or null for documentation-only mode. /// A task representing the asynchronous rendering operation. - public async Task RenderAsync(DocAssembly model) + public async Task RenderAsync(DocAssembly? model) { - ArgumentNullException.ThrowIfNull(model); + // Nothing to render without a model - just return + if (model is null) + { + return; + } var outputPath = Path.Combine(Context.DocumentationRootPath, Context.ApiReferencePath); diff --git a/src/CloudNimble.DotNetDocs.Core/Renderers/YamlRenderer.cs b/src/CloudNimble.DotNetDocs.Core/Renderers/YamlRenderer.cs index fedcfe1..aa784c0 100644 --- a/src/CloudNimble.DotNetDocs.Core/Renderers/YamlRenderer.cs +++ b/src/CloudNimble.DotNetDocs.Core/Renderers/YamlRenderer.cs @@ -56,11 +56,15 @@ public YamlRenderer(ProjectContext? context = null) : base(context) /// /// Renders the documentation assembly to YAML files. /// - /// The documentation assembly to render. + /// The documentation assembly to render, or null for documentation-only mode. /// A task representing the asynchronous rendering operation. - public async Task RenderAsync(DocAssembly model) + public async Task RenderAsync(DocAssembly? model) { - ArgumentNullException.ThrowIfNull(model); + // Nothing to render without a model - just return + if (model is null) + { + return; + } var outputPath = Path.Combine(Context.DocumentationRootPath, Context.ApiReferencePath); diff --git a/src/CloudNimble.DotNetDocs.Core/Transformers/MarkdownXmlTransformer.cs b/src/CloudNimble.DotNetDocs.Core/Transformers/MarkdownXmlTransformer.cs index f5daa89..c55cff0 100644 --- a/src/CloudNimble.DotNetDocs.Core/Transformers/MarkdownXmlTransformer.cs +++ b/src/CloudNimble.DotNetDocs.Core/Transformers/MarkdownXmlTransformer.cs @@ -228,41 +228,17 @@ protected virtual async Task TransformEntityRecursive(DocEntity entity, Dictiona } } - // Handle specific entity types - if (entity is DocAssembly assembly) - { - foreach (var ns in assembly.Namespaces) - { - await TransformEntityRecursive(ns, references); - } - } - else if (entity is DocNamespace ns) - { - foreach (var type in ns.Types) - { - await TransformEntityRecursive(type, references); - } - } - else if (entity is DocType type) - { - foreach (var member in type.Members) - { - await TransformEntityRecursive(member, references); - } - } - else if (entity is DocMember member) - { - foreach (var parameter in member.Parameters) - { - await TransformEntityRecursive(parameter, references); - } - } - else if (entity is DocParameter parameter) + // Handle DocParameter special case (no children, but has Usage to transform) + if (entity is DocParameter parameter) { parameter.Usage = ConvertXmlToMarkdown(parameter.Usage, references); } - await Task.CompletedTask; + // Recursively transform child entities + foreach (var child in GetChildren(entity)) + { + await TransformEntityRecursive(child, references); + } } /// @@ -691,22 +667,35 @@ protected virtual bool IsFrameworkType(string typeRef) /// protected virtual string GetSimpleTypeName(string typeRef) { - // Remove type prefix if present - if (typeRef.Contains(':')) - { - typeRef = typeRef.Substring(typeRef.IndexOf(':') + 1); - } - - // Get last part of qualified name - var lastDot = typeRef.LastIndexOf('.'); - if (lastDot >= 0) - { - return typeRef.Substring(lastDot + 1); - } + var colonIndex = typeRef.IndexOf(':'); + var workingRef = colonIndex >= 0 ? typeRef[(colonIndex + 1)..] : typeRef; + var lastDot = workingRef.LastIndexOf('.'); - return typeRef; + return lastDot >= 0 ? workingRef[(lastDot + 1)..] : workingRef; } + /// + /// Gets the child entities for recursive transformation. + /// + /// The parent entity. + /// An enumerable of child entities to process. + private static IEnumerable GetChildren(DocEntity entity) => entity switch + { + DocAssembly assembly => assembly.Namespaces, + DocNamespace ns => ns.Types, + DocType type => type.Members, + DocMember member => member.Parameters, + _ => [] + }; + + /// + /// Escapes XML special characters for display outside of code blocks. + /// + /// The text to escape. + /// The text with < and > escaped as HTML entities. + private static string EscapeXmlTags(string text) + => text.Replace("<", "<").Replace(">", ">"); + /// /// Escapes any remaining XML tags that weren't processed. /// @@ -728,15 +717,14 @@ protected virtual string EscapeRemainingXmlTags(string text) if (nextBacktick == -1) { // No more backticks, escape remaining text - result.Append(text.Substring(position).Replace("<", "<").Replace(">", ">")); + result.Append(EscapeXmlTags(text[position..])); break; } // Escape content before backtick if (nextBacktick > position) { - var beforeBacktick = text.Substring(position, nextBacktick - position); - result.Append(beforeBacktick.Replace("<", "<").Replace(">", ">")); + result.Append(EscapeXmlTags(text[position..nextBacktick])); } // Check if it's a triple backtick @@ -756,7 +744,7 @@ protected virtual string EscapeRemainingXmlTags(string text) if (closingPos == -1) { // No closing fence, escape the rest - result.Append(text.Substring(nextBacktick).Replace("<", "<").Replace(">", ">")); + result.Append(EscapeXmlTags(text[nextBacktick..])); break; } @@ -768,13 +756,12 @@ protected virtual string EscapeRemainingXmlTags(string text) if (contentStart < text.Length && text[contentStart] == '\r') contentStart++; if (contentStart < text.Length && text[contentStart] == '\n') contentStart++; - var content = text.Substring(contentStart, closingPos - contentStart); - result.Append(content); + result.Append(text[contentStart..closingPos]); } else { // Preserve entire code fence including delimiters - result.Append(text.Substring(nextBacktick, closingPos + 3 - nextBacktick)); + result.Append(text[nextBacktick..(closingPos + 3)]); } position = closingPos + 3; @@ -787,12 +774,12 @@ protected virtual string EscapeRemainingXmlTags(string text) if (closingPos == -1) { // No closing backtick, escape the rest - result.Append(text.Substring(nextBacktick).Replace("<", "<").Replace(">", ">")); + result.Append(EscapeXmlTags(text[nextBacktick..])); break; } // Preserve inline code with backticks - result.Append(text.Substring(nextBacktick, closingPos + 1 - nextBacktick)); + result.Append(text[nextBacktick..(closingPos + 1)]); position = closingPos + 1; } } diff --git a/src/CloudNimble.DotNetDocs.Docs/CloudNimble.DotNetDocs.Docs.docsproj b/src/CloudNimble.DotNetDocs.Docs/CloudNimble.DotNetDocs.Docs.docsproj index 7b9da58..4103879 100644 --- a/src/CloudNimble.DotNetDocs.Docs/CloudNimble.DotNetDocs.Docs.docsproj +++ b/src/CloudNimble.DotNetDocs.Docs/CloudNimble.DotNetDocs.Docs.docsproj @@ -1,4 +1,4 @@ - + Mintlify @@ -48,8 +48,18 @@ guides/index; guides/pipeline; guides/conceptual-docs; + guides/collections; guides/deployment + + + + guides/reference/index; + guides/reference/docsproj; + guides/reference/cli; + + + providers/index @@ -58,6 +68,7 @@ providers/mintlify/index; providers/mintlify/navigation; + providers/mintlify/collections; providers/mintlify/dotnet-library @@ -69,7 +80,8 @@ learnings/bridge-assemblies; - learnings/sdk-packaging + learnings/sdk-packaging; + learnings/converter-infinite-recursion; diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager.mdx index 35fc029..9fa3652 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['AssemblyManager', 'CloudNimble.DotNetDocs.Core.AssemblyManager', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object', 'System.IDisposable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -43,7 +41,7 @@ var model = await manager.DocumentAsync(context); ## Constructors -### .ctor +### .ctor Initializes a new instance of [AssemblyManager](/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager) for a specific assembly. @@ -73,7 +71,7 @@ public AssemblyManager(string assemblyPath, string xmlPath) If the XML documentation file does not exist, processing will continue without XML documentation. A warning will be added to the Errors collection. -### .ctor +### .ctor Inherited Inherited from `object` @@ -85,7 +83,7 @@ public Object() ## Properties -### AssemblyName +### AssemblyName Gets the name of the assembly (without extension). @@ -99,7 +97,7 @@ public string AssemblyName { get; init; } Type: `string` -### AssemblyPath +### AssemblyPath Gets the path to the assembly DLL file. @@ -113,7 +111,7 @@ public string AssemblyPath { get; init; } Type: `string` -### Document +### Document Gets the current documentation model for the processed assembly. @@ -127,7 +125,7 @@ public CloudNimble.DotNetDocs.Core.DocAssembly Document { get; private set; } Type: `CloudNimble.DotNetDocs.Core.DocAssembly?` -### Errors +### Errors Gets the collection of errors that occurred during Since processing. @@ -145,7 +143,7 @@ Type: `System.Collections.Generic.List` Includes warnings about inaccessible internal members when requested but not available. -### LastModified +### LastModified Gets the last modified timestamp of the assembly file for incremental builds. @@ -159,7 +157,7 @@ public System.DateTime LastModified { get; private set; } Type: `System.DateTime` -### XmlPath +### XmlPath Gets the path to the XML documentation file. @@ -179,7 +177,7 @@ May be null if no XML documentation file is available. ## Methods -### Dispose +### Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. @@ -189,7 +187,7 @@ Performs application-defined tasks associated with freeing, releasing, or resett public void Dispose() ``` -### DocumentAsync +### DocumentAsync Documents the assembly asynchronously, building or rebuilding an in-memory model with metadata and documentation if necessary. @@ -210,7 +208,7 @@ public System.Threading.Tasks.Task Docu Type: `System.Threading.Tasks.Task` A task representing the asynchronous operation, containing the [DocAssembly](/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly) model. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -230,7 +228,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -251,7 +249,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -265,7 +263,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -279,7 +277,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -293,7 +291,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -314,7 +312,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder.mdx index 9a01991..a9f493f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DotNetDocsBuilder', 'CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Provides a fluent API for registering renderers, enrichers, transformers, ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DotNetDocsBuilder](/api-reference/CloudNimble/DotNetDocs/Core/Configuration/DotNetDocsBuilder) class. @@ -54,7 +52,7 @@ public DotNetDocsBuilder(Microsoft.Extensions.DependencyInjection.IServiceCollec |-----------|-------------| | `ArgumentNullException` | Thrown when services is null. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -66,7 +64,7 @@ public Object() ## Methods -### AddEnricher +### AddEnricher Adds a custom enricher to the pipeline. @@ -95,7 +93,7 @@ pipeline.AddEnricher<ConceptualContentEnricher>(); Enrichers add conceptual content to documentation entities. -### AddRenderer +### AddRenderer Adds a custom renderer to the pipeline. @@ -124,7 +122,7 @@ pipeline.AddRenderer<MyCustomRenderer>(); Renderers generate output in specific formats (e.g., Markdown, JSON, YAML). -### AddTransformer +### AddTransformer Adds a custom transformer to the pipeline. @@ -153,7 +151,7 @@ pipeline.AddTransformer<InheritDocTransformer>(); Transformers modify the documentation model before rendering. -### ConfigureContext +### ConfigureContext Configures the ProjectContext for the pipeline. @@ -184,7 +182,7 @@ pipeline.ConfigureContext(ctx => }); ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -204,7 +202,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -225,7 +223,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -239,7 +237,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -253,7 +251,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -267,7 +265,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -288,7 +286,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -302,7 +300,7 @@ public virtual string ToString() Type: `string?` -### UseJsonRenderer +### UseJsonRenderer Adds the JSON renderer to the pipeline. @@ -333,7 +331,7 @@ pipeline.UseJsonRenderer(options => }); ``` -### UseMarkdownRenderer +### UseMarkdownRenderer Adds the Markdown renderer to the pipeline. @@ -358,7 +356,204 @@ pipeline.UseMarkdownRenderer(); Also registers MarkdownXmlTransformer to process XML documentation tags. -### UseYamlRenderer +### UseMintlifyRenderer Extension + +Extension method from `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions` + +Adds the Mintlify renderer to the documentation pipeline. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer() + .ConfigureContext(ctx => ctx.OutputPath = "docs/api"); +}); +``` + +#### Remarks + + + +This method registers: + + + + +### UseMintlifyRenderer Extension + +Extension method from `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions` + +Adds the Mintlify renderer to the documentation pipeline with configuration options. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder, System.Action configureMintlify) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer(options => + { + options.GenerateDocsJson = true; + options.IncludeIcons = true; + }) + .ConfigureContext(ctx => ctx.OutputPath = "docs/api"); +}); +``` + +#### Remarks + + + +This method registers: + + + + +### UseMintlifyRenderer Extension + +Extension method from `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions` + +Adds a custom Mintlify renderer implementation to the documentation pipeline. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer<CustomMintlifyRenderer>() + .ConfigureContext(ctx => ctx.OutputPath = "docs"); +}); +``` + +#### Remarks + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + +### UseMintlifyRenderer Extension + +Extension method from `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions` + +Adds a custom Mintlify renderer implementation to the documentation pipeline with configuration options. + +#### Syntax + +```csharp +public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder, System.Action configureMintlify) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `builder` | `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` | The DotNetDocs pipeline builder. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder` +The builder for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddDotNetDocsPipeline(pipeline => +{ + pipeline + .UseMintlifyRenderer<CustomMintlifyRenderer>(options => + { + options.GenerateDocsJson = true; + }) + .ConfigureContext(ctx => ctx.OutputPath = "docs"); +}); +``` + +#### Remarks + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + +### UseYamlRenderer Adds the YAML renderer to the pipeline. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions.mdx index 5d87803..435215e 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FileNamingOptions', 'CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -33,7 +31,7 @@ This class controls the file naming strategy for rendered documentation, includi ## Constructors -### .ctor +### .ctor Initializes a new instance of the [FileNamingOptions](/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions) class with default settings. @@ -43,7 +41,7 @@ Initializes a new instance of the [FileNamingOptions](/api-reference/CloudNimble public FileNamingOptions() ``` -### .ctor +### .ctor Initializes a new instance of the [FileNamingOptions](/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions) class with the specified settings. @@ -60,7 +58,7 @@ public FileNamingOptions(CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode | `namespaceMode` | `CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode` | The namespace organization mode. | | `namespaceSeparator` | `char` | The character to use as a namespace separator in file names. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -72,7 +70,7 @@ public Object() ## Properties -### NamespaceMode +### NamespaceMode Gets or sets the mode for organizing namespace documentation. @@ -92,7 +90,7 @@ The namespace organization mode. Default is [NamespaceMode.File](/api-reference/ This property determines whether namespaces are rendered as individual files or organized into a folder hierarchy. -### NamespaceSeparator +### NamespaceSeparator Gets or sets the character used to separate namespace parts in file names. @@ -116,7 +114,7 @@ This setting is only used when [FileNamingOptions.NamespaceMode](/api-reference/ ## Methods -### Clone +### Clone Creates a copy of the current [FileNamingOptions](/api-reference/CloudNimble/DotNetDocs/Core/Configuration/FileNamingOptions) instance. @@ -131,7 +129,7 @@ public CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions Clone() Type: `CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions` A new instance with the same settings. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -151,7 +149,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -172,7 +170,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -186,7 +184,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -200,7 +198,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -214,7 +212,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -235,7 +233,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode.mdx index dbe0656..ee1234b 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['NamespaceMode', 'CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType.mdx index 5cce4cd..b3fa3b1 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/RendererType.mdx @@ -6,8 +6,6 @@ tag: "STATIC" keywords: ['RendererType', 'CloudNimble.DotNetDocs.Core.Configuration.RendererType', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -35,7 +33,7 @@ This class provides a centralized way to manage renderer type strings used throu ## Methods -### GetRendererType +### GetRendererType Maps a [SupportedDocumentationType](/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType) to its corresponding renderer type constant. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType.mdx index 582b354..529f252 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['SupportedDocumentationType', 'CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType', 'CloudNimble.DotNetDocs.Core.Configuration', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver.mdx index 8e69f06..25b878f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['CrossReferenceResolver', 'CloudNimble.DotNetDocs.Core.CrossReferenceResolver', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -33,7 +31,7 @@ This class builds a comprehensive map of all documentation entities and their id ## Constructors -### .ctor +### .ctor Initializes a new instance of the [CrossReferenceResolver](/api-reference/CloudNimble/DotNetDocs/Core/CrossReferenceResolver) class. @@ -49,7 +47,7 @@ public CrossReferenceResolver(CloudNimble.DotNetDocs.Core.ProjectContext context |------|------|-------------| | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext` | The project context containing configuration and file naming options. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -61,7 +59,7 @@ public Object() ## Methods -### BuildReferenceMap +### BuildReferenceMap Builds the reference map from a documentation assembly. @@ -77,7 +75,7 @@ public void BuildReferenceMap(CloudNimble.DotNetDocs.Core.DocAssembly assembly) |------|------|-------------| | `assembly` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to index. | -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ResolveReference +### ResolveReference Resolves a documentation reference to a DocReference object with full path and anchor information. @@ -203,7 +201,7 @@ public CloudNimble.DotNetDocs.Core.DocReference ResolveReference(string rawRefer Type: `CloudNimble.DotNetDocs.Core.DocReference` A resolved DocReference object. -### ResolveReferences +### ResolveReferences Resolves all references in a collection of raw reference strings. @@ -225,7 +223,7 @@ public System.Collections.Generic.ICollection` A collection of resolved DocReference objects. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly.mdx index e589b6d..22adebd 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocAssembly', 'CloudNimble.DotNetDocs.Core.DocAssembly', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Contains metadata about an assembly and its namespaces, extracted from Roslyn sy ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocAssembly](/api-reference/CloudNimble/DotNetDocs/Core/DocAssembly) class. @@ -54,7 +52,7 @@ public DocAssembly(Microsoft.CodeAnalysis.IAssemblySymbol symbol) |-----------|-------------| | `ArgumentNullException` | Thrown when *symbol* is null. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -66,7 +64,7 @@ Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetD protected DocEntity() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -84,7 +82,7 @@ protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) |------|------|-------------| | `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -96,7 +94,7 @@ public Object() ## Properties -### AssemblyName +### AssemblyName Gets or sets the name of the assembly. @@ -111,7 +109,7 @@ public string AssemblyName { get; set; } Type: `string` The assembly name. -### BestPractices +### BestPractices Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -128,7 +126,7 @@ public string BestPractices { get; set; } Type: `string?` Markdown content with best practices, recommendations, and guidelines from conceptual documentation. -### Considerations +### Considerations Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -145,7 +143,7 @@ public string Considerations { get; set; } Type: `string?` Markdown content with gotchas, performance, or security notes from conceptual documentation. -### DisplayName +### DisplayName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -162,7 +160,7 @@ public string DisplayName { get; set; } Type: `string?` The fully qualified display name extracted from the Symbol. -### Examples +### Examples Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -179,7 +177,7 @@ public string Examples { get; set; } Type: `string?` Markdown content containing code examples from XML <example> tags. -### Exceptions +### Exceptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -196,7 +194,7 @@ public System.Collections.Generic.ICollection?` Collection of exception documentation from XML <exception> tags. -### IncludedMembers +### IncludedMembers Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -213,7 +211,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include when processing child members. -### Namespaces +### Namespaces Gets the collection of namespaces in the assembly. @@ -228,7 +226,7 @@ public System.Collections.Generic.List Type: `System.Collections.Generic.List` List of documented namespaces within this assembly. -### OriginalSymbol +### OriginalSymbol Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -245,7 +243,7 @@ public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } Type: `Microsoft.CodeAnalysis.ISymbol?` The Roslyn ISymbol that was used to create this entity, preserved for reference. -### Patterns +### Patterns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -262,7 +260,7 @@ public string Patterns { get; set; } Type: `string?` Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. -### RelatedApis +### RelatedApis Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -279,7 +277,7 @@ public System.Collections.Generic.ICollection RelatedApis { get; set; } Type: `System.Collections.Generic.ICollection?` List of fully qualified names or URLs for related APIs from conceptual documentation. -### Remarks +### Remarks Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -296,7 +294,7 @@ public string Remarks { get; set; } Type: `string?` Content from the XML documentation's <remarks> element. -### Returns +### Returns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -313,7 +311,7 @@ public string Returns { get; set; } Type: `string?` Description of the return value from XML <returns> tag. -### SeeAlso +### SeeAlso Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -330,7 +328,7 @@ public System.Collections.Generic.ICollection?` Collection of related items from XML <seealso> tags. -### Summary +### Summary Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -347,7 +345,7 @@ public string Summary { get; set; } Type: `string?` Brief description of what the API element IS, from XML <summary> tag. -### Symbol +### Symbol Gets the Roslyn symbol for the assembly. @@ -362,7 +360,7 @@ public Microsoft.CodeAnalysis.IAssemblySymbol Symbol { get; } Type: `Microsoft.CodeAnalysis.IAssemblySymbol` The underlying Roslyn assembly symbol containing metadata. -### TypeParameters +### TypeParameters Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -379,7 +377,7 @@ public System.Collections.Generic.ICollection?` Collection of type parameter documentation from XML <typeparam> tags. -### Usage +### Usage Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -396,7 +394,7 @@ public string Usage { get; set; } Type: `string?` Markdown content explaining HOW to use the API element, from conceptual documentation. -### Value +### Value Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -413,7 +411,7 @@ public string Value { get; set; } Type: `string?` Description of what the property represents from XML <value> tag. -### Version +### Version Gets or sets the version of the assembly. @@ -430,7 +428,7 @@ The assembly version string. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -450,7 +448,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -471,7 +469,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -485,7 +483,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -499,7 +497,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -513,7 +511,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -534,7 +532,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToJson +### ToJson Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -551,7 +549,7 @@ public string ToJson() Type: `string` The JSON string representation of this entity. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocConstants.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocConstants.mdx index 8a679ff..d975dff 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocConstants.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocConstants.mdx @@ -6,8 +6,6 @@ tag: "STATIC" keywords: ['DocConstants', 'CloudNimble.DotNetDocs.Core.DocConstants', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEntity.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEntity.mdx index 80be789..8d239c9 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEntity.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEntity.mdx @@ -6,8 +6,6 @@ tag: "ABSTRACT" keywords: ['DocEntity', 'CloudNimble.DotNetDocs.Core.DocEntity', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -44,7 +42,7 @@ var docType = new DocType(symbol) ## Constructors -### .ctor +### .ctor Inherited Inherited from `object` @@ -56,7 +54,7 @@ public Object() ## Properties -### BestPractices +### BestPractices Gets or sets the best practices documentation content. @@ -71,7 +69,7 @@ public string BestPractices { get; set; } Type: `string?` Markdown content with best practices, recommendations, and guidelines from conceptual documentation. -### Considerations +### Considerations Gets or sets the considerations or notes related to the current context. @@ -86,7 +84,7 @@ public string Considerations { get; set; } Type: `string?` Markdown content with gotchas, performance, or security notes from conceptual documentation. -### DisplayName +### DisplayName Gets or sets the display name of the entity. @@ -101,7 +99,7 @@ public string DisplayName { get; set; } Type: `string?` The fully qualified display name extracted from the Symbol. -### Examples +### Examples Gets or sets the examples documentation content. @@ -116,7 +114,7 @@ public string Examples { get; set; } Type: `string?` Markdown content containing code examples from XML <example> tags. -### Exceptions +### Exceptions Gets or sets the collection of exceptions that can be thrown. @@ -131,7 +129,7 @@ public System.Collections.Generic.ICollection?` Collection of exception documentation from XML <exception> tags. -### IncludedMembers +### IncludedMembers Gets or sets the list of member accessibilities to include (default: Public). @@ -146,7 +144,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include when processing child members. -### OriginalSymbol +### OriginalSymbol Gets the original symbol this documentation entity was created from. @@ -161,7 +159,7 @@ public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } Type: `Microsoft.CodeAnalysis.ISymbol?` The Roslyn ISymbol that was used to create this entity, preserved for reference. -### Patterns +### Patterns Gets or sets the patterns documentation content. @@ -176,7 +174,7 @@ public string Patterns { get; set; } Type: `string?` Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. -### RelatedApis +### RelatedApis Gets or sets a list of related API names. @@ -191,7 +189,7 @@ public System.Collections.Generic.ICollection RelatedApis { get; set; } Type: `System.Collections.Generic.ICollection?` List of fully qualified names or URLs for related APIs from conceptual documentation. -### Remarks +### Remarks Gets or sets the remarks from XML documentation. @@ -206,7 +204,7 @@ public string Remarks { get; set; } Type: `string?` Content from the XML documentation's <remarks> element. -### Returns +### Returns Gets or sets the return value documentation. @@ -221,7 +219,7 @@ public string Returns { get; set; } Type: `string?` Description of the return value from XML <returns> tag. -### SeeAlso +### SeeAlso Gets or sets the collection of see-also references. @@ -236,7 +234,7 @@ public System.Collections.Generic.ICollection?` Collection of related items from XML <seealso> tags. -### Summary +### Summary Gets or sets the summary from XML documentation. @@ -251,7 +249,7 @@ public string Summary { get; set; } Type: `string?` Brief description of what the API element IS, from XML <summary> tag. -### TypeParameters +### TypeParameters Gets or sets the collection of type parameters. @@ -266,7 +264,7 @@ public System.Collections.Generic.ICollection?` Collection of type parameter documentation from XML <typeparam> tags. -### Usage +### Usage Gets or sets the usage documentation content. @@ -281,7 +279,7 @@ public string Usage { get; set; } Type: `string?` Markdown content explaining HOW to use the API element, from conceptual documentation. -### Value +### Value Gets or sets the value description for properties. @@ -298,7 +296,7 @@ Description of what the property represents from XML <value> tag. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -318,7 +316,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -339,7 +337,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -353,7 +351,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -367,7 +365,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -381,7 +379,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -402,7 +400,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToJson +### ToJson Serializes this entity to JSON using consistent options. @@ -417,7 +415,7 @@ public string ToJson() Type: `string` The JSON string representation of this entity. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEnum.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEnum.mdx index 8f07e0f..ae0e8e9 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEnum.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocEnum', 'CloudNimble.DotNetDocs.Core.DocEnum', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocType'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -33,7 +31,7 @@ Contains metadata about an enum type and its values, extracted from Roslyn symbo ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocEnum](/api-reference/CloudNimble/DotNetDocs/Core/DocEnum) class. @@ -55,7 +53,7 @@ public DocEnum(Microsoft.CodeAnalysis.ITypeSymbol symbol) |-----------|-------------| | `ArgumentNullException` | Thrown when *symbol* is null. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -72,7 +70,7 @@ protected DocType() This parameterless constructor is provided for deserialization purposes only. Use `ITypeSymbol)` for normal instantiation. -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -96,7 +94,7 @@ public DocType(Microsoft.CodeAnalysis.ITypeSymbol symbol) |-----------|-------------| | `ArgumentNullException` | Thrown when *symbol* is null. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -108,7 +106,7 @@ Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetD protected DocEntity() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -126,7 +124,7 @@ protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) |------|------|-------------| | `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -138,7 +136,7 @@ public Object() ## Properties -### AssemblyName +### AssemblyName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -155,7 +153,7 @@ public string AssemblyName { get; set; } Type: `string?` The name of the assembly containing this type. -### BaseType +### BaseType Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -172,7 +170,7 @@ public string BaseType { get; set; } Type: `string?` The name of the base type, or null if none exists. -### BestPractices +### BestPractices Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -189,7 +187,7 @@ public string BestPractices { get; set; } Type: `string?` Markdown content with best practices, recommendations, and guidelines from conceptual documentation. -### Considerations +### Considerations Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -206,7 +204,7 @@ public string Considerations { get; set; } Type: `string?` Markdown content with gotchas, performance, or security notes from conceptual documentation. -### DisplayName +### DisplayName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -223,7 +221,7 @@ public string DisplayName { get; set; } Type: `string?` The fully qualified display name extracted from the Symbol. -### Examples +### Examples Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -240,7 +238,7 @@ public string Examples { get; set; } Type: `string?` Markdown content containing code examples from XML <example> tags. -### Exceptions +### Exceptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -257,7 +255,7 @@ public System.Collections.Generic.ICollection?` Collection of exception documentation from XML <exception> tags. -### FullName +### FullName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -274,7 +272,7 @@ public string FullName { get; set; } Type: `string?` The fully qualified type name including namespace. -### IncludedMembers +### IncludedMembers Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -291,7 +289,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include when processing child members. -### IsExternalReference +### IsExternalReference Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -315,7 +313,7 @@ External references are minimal [DocType](/api-reference/CloudNimble/DotNetDocs/ extension methods target types outside the current assembly. These types link to official documentation rather than duplicating external API documentation. -### IsFlags +### IsFlags Gets whether this enum has the Flags attribute. @@ -330,7 +328,7 @@ public bool IsFlags { get; set; } Type: `bool` True if the enum is decorated with [Flags]; otherwise, false. -### Members +### Members Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -347,7 +345,7 @@ public System.Collections.Generic.List Me Type: `System.Collections.Generic.List` List of documented members within this type. -### Name +### Name Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -364,7 +362,7 @@ public string Name { get; set; } Type: `string` The type name. -### OriginalSymbol +### OriginalSymbol Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -381,7 +379,7 @@ public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } Type: `Microsoft.CodeAnalysis.ISymbol?` The Roslyn ISymbol that was used to create this entity, preserved for reference. -### Patterns +### Patterns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -398,7 +396,7 @@ public string Patterns { get; set; } Type: `string?` Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. -### RelatedApis +### RelatedApis Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -415,7 +413,7 @@ public System.Collections.Generic.ICollection RelatedApis { get; set; } Type: `System.Collections.Generic.ICollection?` List of fully qualified names or URLs for related APIs from conceptual documentation. -### Remarks +### Remarks Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -432,7 +430,7 @@ public string Remarks { get; set; } Type: `string?` Content from the XML documentation's <remarks> element. -### Returns +### Returns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -449,7 +447,7 @@ public string Returns { get; set; } Type: `string?` Description of the return value from XML <returns> tag. -### SeeAlso +### SeeAlso Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -466,7 +464,7 @@ public System.Collections.Generic.ICollection?` Collection of related items from XML <seealso> tags. -### Signature +### Signature Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -483,7 +481,7 @@ public string Signature { get; set; } Type: `string?` The type signature including modifiers, inheritance, etc. -### Summary +### Summary Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -500,7 +498,7 @@ public string Summary { get; set; } Type: `string?` Brief description of what the API element IS, from XML <summary> tag. -### Symbol +### Symbol Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -517,7 +515,7 @@ public Microsoft.CodeAnalysis.ITypeSymbol Symbol { get; } Type: `Microsoft.CodeAnalysis.ITypeSymbol` The underlying Roslyn type symbol containing metadata. -### TypeKind +### TypeKind Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocType` @@ -534,7 +532,7 @@ public Microsoft.CodeAnalysis.TypeKind TypeKind { get; set; } Type: `Microsoft.CodeAnalysis.TypeKind?` The kind of type (Class, Interface, Struct, Enum, Delegate, etc.). -### TypeParameters +### TypeParameters Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -551,7 +549,7 @@ public System.Collections.Generic.ICollection?` Collection of type parameter documentation from XML <typeparam> tags. -### UnderlyingType +### UnderlyingType Gets or sets the underlying type of the enum as a [DocReference](/api-reference/CloudNimble/DotNetDocs/Core/DocReference). @@ -567,7 +565,7 @@ Type: `CloudNimble.DotNetDocs.Core.DocReference` A reference to the underlying type (e.g., System.Int32, System.Byte) that can be resolved and linked in documentation. -### Usage +### Usage Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -584,7 +582,7 @@ public string Usage { get; set; } Type: `string?` Markdown content explaining HOW to use the API element, from conceptual documentation. -### Value +### Value Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -601,7 +599,7 @@ public string Value { get; set; } Type: `string?` Description of what the property represents from XML <value> tag. -### Values +### Values Gets the collection of enum values with their documentation. @@ -619,7 +617,7 @@ A list of documented enum values, each containing the name, numeric value, ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -639,7 +637,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -660,7 +658,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -674,7 +672,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -688,7 +686,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -702,7 +700,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -723,7 +721,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToJson +### ToJson Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -740,7 +738,7 @@ public string ToJson() Type: `string` The JSON string representation of this entity. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue.mdx index 88b90c0..a1d058b 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocEnumValue', 'CloudNimble.DotNetDocs.Core.DocEnumValue', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Inherits from [DocEntity](/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocEnumValue](/api-reference/CloudNimble/DotNetDocs/Core/DocEnumValue) class. @@ -48,7 +46,7 @@ public DocEnumValue(Microsoft.CodeAnalysis.IFieldSymbol symbol) |------|------|-------------| | `symbol` | `Microsoft.CodeAnalysis.IFieldSymbol` | The Roslyn field symbol representing the enum value. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -60,7 +58,7 @@ Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetD protected DocEntity() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -78,7 +76,7 @@ protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) |------|------|-------------| | `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -90,7 +88,7 @@ public Object() ## Properties -### BestPractices +### BestPractices Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -107,7 +105,7 @@ public string BestPractices { get; set; } Type: `string?` Markdown content with best practices, recommendations, and guidelines from conceptual documentation. -### Considerations +### Considerations Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -124,7 +122,7 @@ public string Considerations { get; set; } Type: `string?` Markdown content with gotchas, performance, or security notes from conceptual documentation. -### DisplayName +### DisplayName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -141,7 +139,7 @@ public string DisplayName { get; set; } Type: `string?` The fully qualified display name extracted from the Symbol. -### Examples +### Examples Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -158,7 +156,7 @@ public string Examples { get; set; } Type: `string?` Markdown content containing code examples from XML <example> tags. -### Exceptions +### Exceptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -175,7 +173,7 @@ public System.Collections.Generic.ICollection?` Collection of exception documentation from XML <exception> tags. -### IncludedMembers +### IncludedMembers Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -192,7 +190,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include when processing child members. -### Name +### Name Gets or sets the name of the enum value. @@ -207,7 +205,7 @@ public string Name { get; set; } Type: `string` The identifier name of the enum member. -### NumericValue +### NumericValue Gets or sets the numeric value of the enum member. @@ -223,7 +221,7 @@ Type: `string?` The numeric value as a string to preserve formatting (e.g., "0x10" for hex values). May be null if the value is implicitly assigned. -### OriginalSymbol +### OriginalSymbol Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -240,7 +238,7 @@ public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } Type: `Microsoft.CodeAnalysis.ISymbol?` The Roslyn ISymbol that was used to create this entity, preserved for reference. -### Patterns +### Patterns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -257,7 +255,7 @@ public string Patterns { get; set; } Type: `string?` Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. -### RelatedApis +### RelatedApis Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -274,7 +272,7 @@ public System.Collections.Generic.ICollection RelatedApis { get; set; } Type: `System.Collections.Generic.ICollection?` List of fully qualified names or URLs for related APIs from conceptual documentation. -### Remarks +### Remarks Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -291,7 +289,7 @@ public string Remarks { get; set; } Type: `string?` Content from the XML documentation's <remarks> element. -### Returns +### Returns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -308,7 +306,7 @@ public string Returns { get; set; } Type: `string?` Description of the return value from XML <returns> tag. -### SeeAlso +### SeeAlso Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -325,7 +323,7 @@ public System.Collections.Generic.ICollection?` Collection of related items from XML <seealso> tags. -### Summary +### Summary Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -342,7 +340,7 @@ public string Summary { get; set; } Type: `string?` Brief description of what the API element IS, from XML <summary> tag. -### Symbol +### Symbol Gets the Roslyn symbol for the enum field. @@ -357,7 +355,7 @@ public Microsoft.CodeAnalysis.IFieldSymbol Symbol { get; } Type: `Microsoft.CodeAnalysis.IFieldSymbol?` The underlying Roslyn field symbol containing metadata. -### TypeParameters +### TypeParameters Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -374,7 +372,7 @@ public System.Collections.Generic.ICollection?` Collection of type parameter documentation from XML <typeparam> tags. -### Usage +### Usage Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -391,7 +389,7 @@ public string Usage { get; set; } Type: `string?` Markdown content explaining HOW to use the API element, from conceptual documentation. -### Value +### Value Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -410,7 +408,7 @@ Description of what the property represents from XML <value> tag. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -430,7 +428,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -451,7 +449,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -465,7 +463,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -479,7 +477,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -493,7 +491,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -514,7 +512,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToJson +### ToJson Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -531,7 +529,7 @@ public string ToJson() Type: `string` The JSON string representation of this entity. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocException.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocException.mdx index 54caec6..81bed41 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocException.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocException.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocException', 'CloudNimble.DotNetDocs.Core.DocException', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -27,7 +25,7 @@ Represents exception documentation extracted from XML documentation comments. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Represents exception documentation extracted from XML documentation comments. public DocException() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Description +### Description Gets or sets the description of when the exception is thrown. @@ -62,7 +60,7 @@ public string Description { get; set; } Type: `string?` The description text from the exception XML documentation. -### Type +### Type Gets or sets the exception type name. @@ -79,7 +77,7 @@ The fully qualified or simple name of the exception type (e.g., "ArgumentNullExc ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -99,7 +97,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -120,7 +118,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -134,7 +132,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -148,7 +146,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -162,7 +160,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -183,7 +181,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocMember.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocMember.mdx index a35bd96..30e62db 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocMember.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocMember.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocMember', 'CloudNimble.DotNetDocs.Core.DocMember', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Contains metadata about a type member, extracted from Roslyn symbols and enhance ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocMember](/api-reference/CloudNimble/DotNetDocs/Core/DocMember) class. @@ -54,7 +52,7 @@ public DocMember(Microsoft.CodeAnalysis.ISymbol symbol) |-----------|-------------| | `ArgumentNullException` | Thrown when *symbol* is null. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -66,7 +64,7 @@ Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetD protected DocEntity() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -84,7 +82,7 @@ protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) |------|------|-------------| | `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -96,7 +94,7 @@ public Object() ## Properties -### Accessibility +### Accessibility Gets or sets the accessibility level of the member. @@ -111,7 +109,7 @@ public Microsoft.CodeAnalysis.Accessibility Accessibility { get; set; } Type: `Microsoft.CodeAnalysis.Accessibility?` The accessibility level (public, private, protected, etc.). -### BestPractices +### BestPractices Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -128,7 +126,7 @@ public string BestPractices { get; set; } Type: `string?` Markdown content with best practices, recommendations, and guidelines from conceptual documentation. -### Considerations +### Considerations Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -145,7 +143,7 @@ public string Considerations { get; set; } Type: `string?` Markdown content with gotchas, performance, or security notes from conceptual documentation. -### DeclaringTypeName +### DeclaringTypeName Gets or sets the fully qualified name of the type that declares this member. @@ -162,7 +160,7 @@ For inherited members, this is the base type or interface name. For extension methods, this is the static class containing the method. For declared members, this matches the containing type. -### DisplayName +### DisplayName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -179,7 +177,7 @@ public string DisplayName { get; set; } Type: `string?` The fully qualified display name extracted from the Symbol. -### Examples +### Examples Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -196,7 +194,7 @@ public string Examples { get; set; } Type: `string?` Markdown content containing code examples from XML <example> tags. -### Exceptions +### Exceptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -213,7 +211,7 @@ public System.Collections.Generic.ICollection?` Collection of exception documentation from XML <exception> tags. -### ExtendedTypeName +### ExtendedTypeName Gets or sets the fully qualified name of the type this extension method extends. @@ -228,7 +226,7 @@ public string ExtendedTypeName { get; set; } Type: `string?` The type of the first parameter (with `this` modifier), or `null` if not an extension method. -### IncludedMembers +### IncludedMembers Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -245,7 +243,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include when processing child members. -### IsAbstract +### IsAbstract Gets or sets whether this member is abstract. @@ -260,7 +258,7 @@ public bool IsAbstract { get; set; } Type: `bool` `true` if the member uses the `abstract` keyword; otherwise `false`. -### IsExtensionMethod +### IsExtensionMethod Gets or sets whether this member is an extension method. @@ -276,7 +274,7 @@ Type: `bool` `true` if this is a static method with the `this` modifier on its first parameter; otherwise `false`. -### IsInherited +### IsInherited Gets or sets whether this member is inherited from a base type or interface. @@ -292,7 +290,7 @@ Type: `bool` `true` if the member is declared in a base type or interface; `false` if declared in the containing type. -### IsOverride +### IsOverride Gets or sets whether this member overrides a base implementation. @@ -307,7 +305,7 @@ public bool IsOverride { get; set; } Type: `bool` `true` if the member uses the `override` keyword; otherwise `false`. -### IsVirtual +### IsVirtual Gets or sets whether this member is virtual. @@ -322,7 +320,7 @@ public bool IsVirtual { get; set; } Type: `bool` `true` if the member uses the `virtual` keyword; otherwise `false`. -### MemberKind +### MemberKind Gets or sets the member kind (method, property, field, event, etc.). @@ -337,7 +335,7 @@ public Microsoft.CodeAnalysis.SymbolKind MemberKind { get; set; } Type: `Microsoft.CodeAnalysis.SymbolKind?` The kind of member as defined by Roslyn. -### MethodKind +### MethodKind Gets or sets the method kind for method members. @@ -352,7 +350,7 @@ public System.Nullable MethodKind { get; set; Type: `System.Nullable?` The kind of method (Constructor, Ordinary, etc.), or null for non-method members. -### Name +### Name Gets or sets the name of the member. @@ -367,7 +365,7 @@ public string Name { get; set; } Type: `string` The member name. -### OriginalSymbol +### OriginalSymbol Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -384,7 +382,7 @@ public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } Type: `Microsoft.CodeAnalysis.ISymbol?` The Roslyn ISymbol that was used to create this entity, preserved for reference. -### OverriddenMember +### OverriddenMember Gets or sets the signature of the member being overridden, if applicable. @@ -399,7 +397,7 @@ public string OverriddenMember { get; set; } Type: `string?` The fully qualified signature of the base member, or `null` if not an override. -### Parameters +### Parameters Gets the collection of parameters for this member. @@ -418,7 +416,7 @@ List of documented parameters. Empty for members without parameters. This collection is populated for methods, constructors, delegates, and indexers. -### Patterns +### Patterns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -435,7 +433,7 @@ public string Patterns { get; set; } Type: `string?` Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. -### RelatedApis +### RelatedApis Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -452,7 +450,7 @@ public System.Collections.Generic.ICollection RelatedApis { get; set; } Type: `System.Collections.Generic.ICollection?` List of fully qualified names or URLs for related APIs from conceptual documentation. -### Remarks +### Remarks Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -469,7 +467,7 @@ public string Remarks { get; set; } Type: `string?` Content from the XML documentation's <remarks> element. -### Returns +### Returns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -486,7 +484,7 @@ public string Returns { get; set; } Type: `string?` Description of the return value from XML <returns> tag. -### ReturnType +### ReturnType Gets the return type documentation, if applicable. @@ -501,7 +499,7 @@ public CloudNimble.DotNetDocs.Core.DocType ReturnType { get; set; } Type: `CloudNimble.DotNetDocs.Core.DocType?` Documentation for the return type, or null for void methods and non-method members. -### ReturnTypeName +### ReturnTypeName Gets or sets the name of the return type. @@ -516,7 +514,7 @@ public string ReturnTypeName { get; set; } Type: `string?` The return type name for methods and properties, or null for other members. -### SeeAlso +### SeeAlso Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -533,7 +531,7 @@ public System.Collections.Generic.ICollection?` Collection of related items from XML <seealso> tags. -### Signature +### Signature Gets or sets the signature of the member. @@ -548,7 +546,7 @@ public string Signature { get; set; } Type: `string?` The member signature including modifiers, return type, parameters, etc. -### Summary +### Summary Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -565,7 +563,7 @@ public string Summary { get; set; } Type: `string?` Brief description of what the API element IS, from XML <summary> tag. -### Symbol +### Symbol Gets the Roslyn symbol for the member. @@ -580,7 +578,7 @@ public Microsoft.CodeAnalysis.ISymbol Symbol { get; } Type: `Microsoft.CodeAnalysis.ISymbol` The underlying Roslyn symbol containing metadata. -### TypeParameters +### TypeParameters Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -597,7 +595,7 @@ public System.Collections.Generic.ICollection?` Collection of type parameter documentation from XML <typeparam> tags. -### Usage +### Usage Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -614,7 +612,7 @@ public string Usage { get; set; } Type: `string?` Markdown content explaining HOW to use the API element, from conceptual documentation. -### Value +### Value Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -633,7 +631,7 @@ Description of what the property represents from XML <value> tag. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -653,7 +651,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -674,7 +672,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -688,7 +686,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -702,7 +700,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -716,7 +714,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -737,7 +735,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToJson +### ToJson Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -754,7 +752,7 @@ public string ToJson() Type: `string` The JSON string representation of this entity. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace.mdx index 94648b4..d70aeda 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocNamespace', 'CloudNimble.DotNetDocs.Core.DocNamespace', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Contains metadata about a namespace and its types, extracted from Roslyn symbols ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocNamespace](/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace) class. @@ -54,7 +52,7 @@ public DocNamespace(Microsoft.CodeAnalysis.INamespaceSymbol symbol) |-----------|-------------| | `ArgumentNullException` | Thrown when *symbol* is null. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -66,7 +64,7 @@ Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetD protected DocEntity() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -84,7 +82,7 @@ protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) |------|------|-------------| | `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -96,7 +94,7 @@ public Object() ## Properties -### BestPractices +### BestPractices Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -113,7 +111,7 @@ public string BestPractices { get; set; } Type: `string?` Markdown content with best practices, recommendations, and guidelines from conceptual documentation. -### Considerations +### Considerations Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -130,7 +128,7 @@ public string Considerations { get; set; } Type: `string?` Markdown content with gotchas, performance, or security notes from conceptual documentation. -### DisplayName +### DisplayName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -147,7 +145,7 @@ public string DisplayName { get; set; } Type: `string?` The fully qualified display name extracted from the Symbol. -### Examples +### Examples Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -164,7 +162,7 @@ public string Examples { get; set; } Type: `string?` Markdown content containing code examples from XML <example> tags. -### Exceptions +### Exceptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -181,7 +179,7 @@ public System.Collections.Generic.ICollection?` Collection of exception documentation from XML <exception> tags. -### IncludedMembers +### IncludedMembers Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -198,7 +196,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include when processing child members. -### Name +### Name Gets or sets the name of the namespace. @@ -213,7 +211,7 @@ public string Name { get; set; } Type: `string` The namespace name. -### OriginalSymbol +### OriginalSymbol Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -230,7 +228,7 @@ public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } Type: `Microsoft.CodeAnalysis.ISymbol?` The Roslyn ISymbol that was used to create this entity, preserved for reference. -### Patterns +### Patterns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -247,7 +245,7 @@ public string Patterns { get; set; } Type: `string?` Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. -### RelatedApis +### RelatedApis Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -264,7 +262,7 @@ public System.Collections.Generic.ICollection RelatedApis { get; set; } Type: `System.Collections.Generic.ICollection?` List of fully qualified names or URLs for related APIs from conceptual documentation. -### Remarks +### Remarks Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -281,7 +279,7 @@ public string Remarks { get; set; } Type: `string?` Content from the XML documentation's <remarks> element. -### Returns +### Returns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -298,7 +296,7 @@ public string Returns { get; set; } Type: `string?` Description of the return value from XML <returns> tag. -### SeeAlso +### SeeAlso Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -315,7 +313,7 @@ public System.Collections.Generic.ICollection?` Collection of related items from XML <seealso> tags. -### Summary +### Summary Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -332,7 +330,7 @@ public string Summary { get; set; } Type: `string?` Brief description of what the API element IS, from XML <summary> tag. -### Symbol +### Symbol Gets the Roslyn symbol for the namespace. @@ -347,7 +345,7 @@ public Microsoft.CodeAnalysis.INamespaceSymbol Symbol { get; } Type: `Microsoft.CodeAnalysis.INamespaceSymbol` The underlying Roslyn namespace symbol containing metadata. -### TypeParameters +### TypeParameters Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -364,7 +362,7 @@ public System.Collections.Generic.ICollection?` Collection of type parameter documentation from XML <typeparam> tags. -### Types +### Types Gets the collection of types in the namespace. @@ -379,7 +377,7 @@ public System.Collections.Generic.List Type Type: `System.Collections.Generic.List` List of documented types within this namespace. -### Usage +### Usage Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -396,7 +394,7 @@ public string Usage { get; set; } Type: `string?` Markdown content explaining HOW to use the API element, from conceptual documentation. -### Value +### Value Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -415,7 +413,7 @@ Description of what the property represents from XML <value> tag. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -435,7 +433,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -456,7 +454,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -470,7 +468,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -484,7 +482,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -498,7 +496,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -519,7 +517,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToJson +### ToJson Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -536,7 +534,7 @@ public string ToJson() Type: `string` The JSON string representation of this entity. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocParameter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocParameter.mdx index 99f504b..0d91a4f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocParameter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocParameter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocParameter', 'CloudNimble.DotNetDocs.Core.DocParameter', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Contains metadata about a parameter, extracted from Roslyn symbols and enhanced ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocParameter](/api-reference/CloudNimble/DotNetDocs/Core/DocParameter) class. @@ -54,7 +52,7 @@ public DocParameter(Microsoft.CodeAnalysis.IParameterSymbol symbol) |-----------|-------------| | `ArgumentNullException` | Thrown when *symbol* is null. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -66,7 +64,7 @@ Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetD protected DocEntity() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -84,7 +82,7 @@ protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) |------|------|-------------| | `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -96,7 +94,7 @@ public Object() ## Properties -### BestPractices +### BestPractices Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -113,7 +111,7 @@ public string BestPractices { get; set; } Type: `string?` Markdown content with best practices, recommendations, and guidelines from conceptual documentation. -### Considerations +### Considerations Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -130,7 +128,7 @@ public string Considerations { get; set; } Type: `string?` Markdown content with gotchas, performance, or security notes from conceptual documentation. -### DefaultValue +### DefaultValue Gets the default value of the parameter, if any. @@ -145,7 +143,7 @@ public string DefaultValue { get; set; } Type: `string?` The default value as a string, or null if no default value exists. -### DisplayName +### DisplayName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -162,7 +160,7 @@ public string DisplayName { get; set; } Type: `string?` The fully qualified display name extracted from the Symbol. -### Examples +### Examples Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -179,7 +177,7 @@ public string Examples { get; set; } Type: `string?` Markdown content containing code examples from XML <example> tags. -### Exceptions +### Exceptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -196,7 +194,7 @@ public System.Collections.Generic.ICollection?` Collection of exception documentation from XML <exception> tags. -### HasDefaultValue +### HasDefaultValue Gets or sets a value indicating whether this parameter has a default value. @@ -211,7 +209,7 @@ public bool HasDefaultValue { get; set; } Type: `bool` True if the parameter has a default value; otherwise, false. -### IncludedMembers +### IncludedMembers Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -228,7 +226,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include when processing child members. -### IsOptional +### IsOptional Gets or sets a value indicating whether this parameter is optional. @@ -243,7 +241,7 @@ public bool IsOptional { get; set; } Type: `bool` True if the parameter is optional; otherwise, false. -### IsParams +### IsParams Gets or sets a value indicating whether this parameter uses the params keyword. @@ -258,7 +256,7 @@ public bool IsParams { get; set; } Type: `bool` True if the parameter is a params array; otherwise, false. -### Name +### Name Gets or sets the name of the parameter. @@ -273,7 +271,7 @@ public string Name { get; set; } Type: `string` The parameter name. -### OriginalSymbol +### OriginalSymbol Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -290,7 +288,7 @@ public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } Type: `Microsoft.CodeAnalysis.ISymbol?` The Roslyn ISymbol that was used to create this entity, preserved for reference. -### ParameterType +### ParameterType Gets the parameter type documentation. @@ -305,7 +303,7 @@ public CloudNimble.DotNetDocs.Core.DocType ParameterType { get; set; } Type: `CloudNimble.DotNetDocs.Core.DocType?` Documentation for the parameter's type. -### Patterns +### Patterns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -322,7 +320,7 @@ public string Patterns { get; set; } Type: `string?` Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. -### RelatedApis +### RelatedApis Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -339,7 +337,7 @@ public System.Collections.Generic.ICollection RelatedApis { get; set; } Type: `System.Collections.Generic.ICollection?` List of fully qualified names or URLs for related APIs from conceptual documentation. -### Remarks +### Remarks Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -356,7 +354,7 @@ public string Remarks { get; set; } Type: `string?` Content from the XML documentation's <remarks> element. -### Returns +### Returns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -373,7 +371,7 @@ public string Returns { get; set; } Type: `string?` Description of the return value from XML <returns> tag. -### SeeAlso +### SeeAlso Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -390,7 +388,7 @@ public System.Collections.Generic.ICollection?` Collection of related items from XML <seealso> tags. -### Summary +### Summary Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -407,7 +405,7 @@ public string Summary { get; set; } Type: `string?` Brief description of what the API element IS, from XML <summary> tag. -### Symbol +### Symbol Gets the Roslyn symbol for the parameter. @@ -422,7 +420,7 @@ public Microsoft.CodeAnalysis.IParameterSymbol Symbol { get; } Type: `Microsoft.CodeAnalysis.IParameterSymbol` The underlying Roslyn parameter symbol containing metadata. -### TypeName +### TypeName Gets or sets the type name of the parameter. @@ -437,7 +435,7 @@ public string TypeName { get; set; } Type: `string?` The fully qualified type name of the parameter. -### TypeParameters +### TypeParameters Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -454,7 +452,7 @@ public System.Collections.Generic.ICollection?` Collection of type parameter documentation from XML <typeparam> tags. -### Usage +### Usage Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -471,7 +469,7 @@ public string Usage { get; set; } Type: `string?` Markdown content explaining HOW to use the API element, from conceptual documentation. -### Value +### Value Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -490,7 +488,7 @@ Description of what the property represents from XML <value> tag. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -510,7 +508,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -531,7 +529,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -545,7 +543,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -559,7 +557,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -573,7 +571,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -594,7 +592,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToJson +### ToJson Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -611,7 +609,7 @@ public string ToJson() Type: `string` The JSON string representation of this entity. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocReference.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocReference.mdx index a7c7b0d..4eebe8d 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocReference.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocReference.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocReference', 'CloudNimble.DotNetDocs.Core.DocReference', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -33,7 +31,7 @@ This class encapsulates all information needed to resolve and render a documenta ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocReference](/api-reference/CloudNimble/DotNetDocs/Core/DocReference) class. @@ -43,7 +41,7 @@ Initializes a new instance of the [DocReference](/api-reference/CloudNimble/DotN public DocReference() ``` -### .ctor +### .ctor Initializes a new instance of the [DocReference](/api-reference/CloudNimble/DotNetDocs/Core/DocReference) class with a raw reference. @@ -59,7 +57,7 @@ public DocReference(string rawReference) |------|------|-------------| | `rawReference` | `string` | The raw reference string from XML documentation. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -71,7 +69,7 @@ public Object() ## Properties -### Anchor +### Anchor Gets or sets the anchor for member-level references. @@ -90,7 +88,7 @@ The anchor name for linking to specific members within a type, or null for type- For a reference to an enum value, this would be "file" for NamespaceMode.File. -### DisplayName +### DisplayName Gets or sets the display name for the reference. @@ -109,7 +107,7 @@ The human-readable name to display for this reference. For a member reference, this might be "NamespaceMode.File" or just "File" depending on context. -### IsResolved +### IsResolved Gets or sets a value indicating whether this reference has been successfully resolved. @@ -124,7 +122,7 @@ public bool IsResolved { get; set; } Type: `bool` True if the reference was found and resolved; otherwise, false. -### RawReference +### RawReference Gets or sets the original reference string from the XML documentation. @@ -143,7 +141,7 @@ The raw cref value including any prefix (T:, F:, P:, M:, E:). F:CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode.File -### ReferenceType +### ReferenceType Gets or sets the type of reference. @@ -158,7 +156,7 @@ public CloudNimble.DotNetDocs.Core.ReferenceType ReferenceType { get; set; } Type: `CloudNimble.DotNetDocs.Core.ReferenceType?` The classification of this reference. -### RelativePath +### RelativePath Gets or sets the resolved root-relative path to the target documentation. @@ -177,7 +175,7 @@ The root-relative path to the target document (starting with /), or null if unre /Configuration/NamespaceMode.md -### TargetEntity +### TargetEntity Gets or sets the target entity that this reference points to. @@ -194,7 +192,7 @@ The resolved DocEntity, or null if the reference couldn't be resolved. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -214,7 +212,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -235,7 +233,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -249,7 +247,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -263,7 +261,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -277,7 +275,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -298,7 +296,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToMarkdownLink +### ToMarkdownLink Generates a Markdown link for this reference. @@ -313,7 +311,7 @@ public string ToMarkdownLink() Type: `string` A Markdown-formatted link, or inline code if the reference is unresolved. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase.mdx new file mode 100644 index 0000000..7a71cba --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase.mdx @@ -0,0 +1,213 @@ +--- +title: DocReferenceHandlerBase +description: "Base class for documentation reference handlers providing common file copying functionality." +icon: shapes +tag: "ABSTRACT" +keywords: ['DocReferenceHandlerBase', 'CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Core.IDocReferenceHandler'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** System.Object + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase +``` + +## Summary + +Base class for documentation reference handlers providing common file copying functionality. + +## Remarks + + + + + This abstract class contains shared logic for copying files from referenced documentation projects, + including directory recursion, exclusion pattern matching, and glob pattern support. + + + + + + Derived classes should implement `String)` to provide format-specific + processing such as content rewriting and resource relocation. + + + + +## Constructors + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### DocumentationType Abstract + +#### Syntax + +```csharp +public abstract CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` + +## Methods + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ProcessAsync Abstract + +#### Syntax + +```csharp +public abstract System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | - | +| `documentationRootPath` | `string` | - | + +#### Returns + +Type: `System.Threading.Tasks.Task` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocReferenceHandler + diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocType.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocType.mdx index 1726561..85b446b 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocType.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocType.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocType', 'CloudNimble.DotNetDocs.Core.DocType', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocEntity'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Contains metadata about a type (class, interface, struct, enum, delegate) and it ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocType](/api-reference/CloudNimble/DotNetDocs/Core/DocType) class. @@ -54,7 +52,7 @@ public DocType(Microsoft.CodeAnalysis.ITypeSymbol symbol) |-----------|-------------| | `ArgumentNullException` | Thrown when *symbol* is null. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -66,7 +64,7 @@ Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetD protected DocEntity() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -84,7 +82,7 @@ protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol) |------|------|-------------| | `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -96,7 +94,7 @@ public Object() ## Properties -### AssemblyName +### AssemblyName Gets or sets the containing assembly name. @@ -111,7 +109,7 @@ public string AssemblyName { get; set; } Type: `string?` The name of the assembly containing this type. -### BaseType +### BaseType Gets the base type name, if any. @@ -126,7 +124,7 @@ public string BaseType { get; set; } Type: `string?` The name of the base type, or null if none exists. -### BestPractices +### BestPractices Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -143,7 +141,7 @@ public string BestPractices { get; set; } Type: `string?` Markdown content with best practices, recommendations, and guidelines from conceptual documentation. -### Considerations +### Considerations Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -160,7 +158,7 @@ public string Considerations { get; set; } Type: `string?` Markdown content with gotchas, performance, or security notes from conceptual documentation. -### DisplayName +### DisplayName Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -177,7 +175,7 @@ public string DisplayName { get; set; } Type: `string?` The fully qualified display name extracted from the Symbol. -### Examples +### Examples Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -194,7 +192,7 @@ public string Examples { get; set; } Type: `string?` Markdown content containing code examples from XML <example> tags. -### Exceptions +### Exceptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -211,7 +209,7 @@ public System.Collections.Generic.ICollection?` Collection of exception documentation from XML <exception> tags. -### FullName +### FullName Gets or sets the fully qualified name of the type. @@ -226,7 +224,7 @@ public string FullName { get; set; } Type: `string?` The fully qualified type name including namespace. -### IncludedMembers +### IncludedMembers Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -243,7 +241,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include when processing child members. -### IsExternalReference +### IsExternalReference Gets or sets whether this type is an external reference created to host extension methods. @@ -265,7 +263,7 @@ External references are minimal [DocType](/api-reference/CloudNimble/DotNetDocs/ extension methods target types outside the current assembly. These types link to official documentation rather than duplicating external API documentation. -### Members +### Members Gets the collection of members (methods, properties, fields, events, etc.). @@ -280,7 +278,7 @@ public System.Collections.Generic.List Me Type: `System.Collections.Generic.List` List of documented members within this type. -### Name +### Name Gets or sets the name of the type. @@ -295,7 +293,7 @@ public string Name { get; set; } Type: `string` The type name. -### OriginalSymbol +### OriginalSymbol Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -312,7 +310,7 @@ public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; } Type: `Microsoft.CodeAnalysis.ISymbol?` The Roslyn ISymbol that was used to create this entity, preserved for reference. -### Patterns +### Patterns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -329,7 +327,7 @@ public string Patterns { get; set; } Type: `string?` Markdown content explaining common usage patterns and architectural guidance from conceptual documentation. -### RelatedApis +### RelatedApis Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -346,7 +344,7 @@ public System.Collections.Generic.ICollection RelatedApis { get; set; } Type: `System.Collections.Generic.ICollection?` List of fully qualified names or URLs for related APIs from conceptual documentation. -### Remarks +### Remarks Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -363,7 +361,7 @@ public string Remarks { get; set; } Type: `string?` Content from the XML documentation's <remarks> element. -### Returns +### Returns Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -380,7 +378,7 @@ public string Returns { get; set; } Type: `string?` Description of the return value from XML <returns> tag. -### SeeAlso +### SeeAlso Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -397,7 +395,7 @@ public System.Collections.Generic.ICollection?` Collection of related items from XML <seealso> tags. -### Signature +### Signature Gets or sets the signature of the type. @@ -412,7 +410,7 @@ public string Signature { get; set; } Type: `string?` The type signature including modifiers, inheritance, etc. -### Summary +### Summary Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -429,7 +427,7 @@ public string Summary { get; set; } Type: `string?` Brief description of what the API element IS, from XML <summary> tag. -### Symbol +### Symbol Gets the Roslyn symbol for the type. @@ -444,7 +442,7 @@ public Microsoft.CodeAnalysis.ITypeSymbol Symbol { get; } Type: `Microsoft.CodeAnalysis.ITypeSymbol` The underlying Roslyn type symbol containing metadata. -### TypeKind +### TypeKind Gets or sets the type kind. @@ -459,7 +457,7 @@ public Microsoft.CodeAnalysis.TypeKind TypeKind { get; set; } Type: `Microsoft.CodeAnalysis.TypeKind?` The kind of type (Class, Interface, Struct, Enum, Delegate, etc.). -### TypeParameters +### TypeParameters Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -476,7 +474,7 @@ public System.Collections.Generic.ICollection?` Collection of type parameter documentation from XML <typeparam> tags. -### Usage +### Usage Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -493,7 +491,7 @@ public string Usage { get; set; } Type: `string?` Markdown content explaining HOW to use the API element, from conceptual documentation. -### Value +### Value Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -512,7 +510,7 @@ Description of what the property represents from XML <value> tag. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -532,7 +530,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -553,7 +551,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -567,7 +565,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -581,7 +579,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -595,7 +593,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -616,7 +614,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToJson +### ToJson Inherited Inherited from `CloudNimble.DotNetDocs.Core.DocEntity` @@ -633,7 +631,7 @@ public string ToJson() Type: `string` The JSON string representation of this entity. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter.mdx index 4840014..c3f209b 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocTypeParameter', 'CloudNimble.DotNetDocs.Core.DocTypeParameter', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -27,7 +25,7 @@ Represents type parameter documentation extracted from XML documentation comment ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Represents type parameter documentation extracted from XML documentation comment public DocTypeParameter() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Description +### Description Gets or sets the description of the type parameter. @@ -62,7 +60,7 @@ public string Description { get; set; } Type: `string?` The description text from the typeparam XML documentation. -### Name +### Name Gets or sets the type parameter name. @@ -79,7 +77,7 @@ The name of the type parameter (e.g., "T", "TKey", "TValue"). ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -99,7 +97,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -120,7 +118,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -134,7 +132,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -148,7 +146,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -162,7 +160,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -183,7 +181,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager.mdx index 3176831..5c7c2e6 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocumentationManager', 'CloudNimble.DotNetDocs.Core.DocumentationManager', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object', 'System.IDisposable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -33,14 +31,14 @@ This class manages the complete documentation lifecycle including enrichment, ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocumentationManager](/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager) class. #### Syntax ```csharp -public DocumentationManager(CloudNimble.DotNetDocs.Core.ProjectContext projectContext, System.Collections.Generic.IEnumerable enrichers = null, System.Collections.Generic.IEnumerable transformers = null, System.Collections.Generic.IEnumerable renderers = null) +public DocumentationManager(CloudNimble.DotNetDocs.Core.ProjectContext projectContext, System.Collections.Generic.IEnumerable enrichers = null, System.Collections.Generic.IEnumerable transformers = null, System.Collections.Generic.IEnumerable renderers = null, System.Collections.Generic.IEnumerable referenceHandlers = null) ``` #### Parameters @@ -51,13 +49,14 @@ public DocumentationManager(CloudNimble.DotNetDocs.Core.ProjectContext projectCo | `enrichers` | `System.Collections.Generic.IEnumerable?` | The enrichers to apply to documentation entities. | | `transformers` | `System.Collections.Generic.IEnumerable?` | The transformers to apply to the documentation model. | | `renderers` | `System.Collections.Generic.IEnumerable?` | The renderers to generate output formats. | +| `referenceHandlers` | `System.Collections.Generic.IEnumerable?` | The handlers for processing documentation references. | #### Remarks This constructor is designed to work with dependency injection containers. All parameters accept IEnumerable collections that are typically injected by the DI container. -### .ctor +### .ctor Inherited Inherited from `object` @@ -69,7 +68,7 @@ public Object() ## Methods -### CreateConceptualFilesAsync +### CreateConceptualFilesAsync Creates placeholder conceptual documentation files for a single assembly. @@ -91,7 +90,7 @@ public System.Threading.Tasks.Task CreateConceptualFilesAsync(string assemblyPat Type: `System.Threading.Tasks.Task` A task representing the asynchronous operation. -### CreateConceptualFilesAsync +### CreateConceptualFilesAsync Creates placeholder conceptual documentation files for multiple assemblies. @@ -112,7 +111,7 @@ public System.Threading.Tasks.Task CreateConceptualFilesAsync(System.Collections Type: `System.Threading.Tasks.Task` A task representing the asynchronous operation. -### Dispose +### Dispose Disposes of all cached [AssemblyManager](/api-reference/CloudNimble/DotNetDocs/Core/AssemblyManager) instances. @@ -122,7 +121,7 @@ Disposes of all cached [AssemblyManager](/api-reference/CloudNimble/DotNetDocs/C public void Dispose() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -142,7 +141,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -163,7 +162,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -177,7 +176,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -191,7 +190,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -205,7 +204,7 @@ protected internal object MemberwiseClone() Type: `object` -### ProcessAsync +### ProcessAsync Processes a single assembly through the documentation pipeline. @@ -227,7 +226,7 @@ public System.Threading.Tasks.Task ProcessAsync(string assemblyPath, string xmlP Type: `System.Threading.Tasks.Task` A task representing the asynchronous processing operation. -### ProcessAsync +### ProcessAsync Processes multiple assemblies through the documentation pipeline. @@ -248,7 +247,7 @@ public System.Threading.Tasks.Task ProcessAsync(System.Collections.Generic.IEnum Type: `System.Threading.Tasks.Task` A task representing the asynchronous processing operation. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -269,7 +268,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference.mdx index c8ea3ea..bae1c61 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocumentationReference', 'CloudNimble.DotNetDocs.Core.DocumentationReference', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -33,7 +31,7 @@ This class encapsulates information needed to copy documentation files from a re ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocumentationReference](/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference) class. @@ -43,7 +41,7 @@ Initializes a new instance of the [DocumentationReference](/api-reference/CloudN public DocumentationReference() ``` -### .ctor +### .ctor Initializes a new instance of the [DocumentationReference](/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference) class with a project path. @@ -59,7 +57,7 @@ public DocumentationReference(string projectPath) |------|------|-------------| | `projectPath` | `string` | The path to the .docsproj file being referenced. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -71,7 +69,7 @@ public Object() ## Properties -### DestinationPath +### DestinationPath Gets or sets the path to the destination folder within the collection's documentation root. @@ -90,7 +88,7 @@ The relative path where referenced documentation will be copied. For a microservice named "auth-service", this might be "services/auth". -### DocumentationRoot +### DocumentationRoot Gets or sets the root directory containing the referenced documentation outputs. @@ -109,7 +107,7 @@ The absolute path to the documentation root of the referenced project. C:\repos\auth-service\docs -### DocumentationType +### DocumentationType Gets or sets the documentation type of the referenced project. @@ -128,7 +126,7 @@ The documentation format (Mintlify, DocFX, MkDocs, Jekyll, Hugo, or Generic). This determines which file patterns to copy and whether navigation combining is supported. -### IntegrationType +### IntegrationType Gets or sets the integration type for Mintlify navigation. @@ -148,7 +146,7 @@ Either "Tabs" or "Products" for Mintlify navigation structure. Only applicable when DocumentationType is "Mintlify". Determines whether the referenced documentation appears in the top-level tabs or in the products section. -### Name +### Name Gets or sets the display name for this documentation reference in navigation. @@ -168,7 +166,7 @@ The name to display for this documentation in tabs, products, or other navigatio When specified, this name is used instead of deriving the name from the project or other metadata. Useful for providing user-friendly names in navigation elements. -### NavigationFilePath +### NavigationFilePath Gets or sets the path to the navigation configuration file for the referenced documentation. @@ -187,7 +185,7 @@ The absolute path to the navigation file (e.g., docs.json for Mintlify). C:\repos\auth-service\docs\docs.json -### ProjectPath +### ProjectPath Gets or sets the path to the .docsproj file being referenced. @@ -208,7 +206,7 @@ C:\repos\auth-service\docs\AuthService.docsproj ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -228,7 +226,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -249,7 +247,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -263,7 +261,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -277,7 +275,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -291,7 +289,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -312,7 +310,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher.mdx index 73ed9c2..32a43e4 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['IDocEnricher', 'CloudNimble.DotNetDocs.Core.IDocEnricher', 'CloudNimble.DotNetDocs.Core', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -30,7 +28,7 @@ Implementations of this interface can enhance documentation entities with additi ## Methods -### EnrichAsync +### EnrichAsync Abstract Enriches a documentation entity with additional conceptual content. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler.mdx new file mode 100644 index 0000000..c4a48dc --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler.mdx @@ -0,0 +1,95 @@ +--- +title: IDocReferenceHandler +description: "Defines a handler for processing documentation references from other projects." +icon: plug +keywords: ['IDocReferenceHandler', 'CloudNimble.DotNetDocs.Core.IDocReferenceHandler', 'CloudNimble.DotNetDocs.Core', 'interface'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.IDocReferenceHandler +``` + +## Summary + +Defines a handler for processing documentation references from other projects. + +## Remarks + + + + + Implementations of this interface are responsible for copying files from referenced documentation + projects, rewriting internal paths in content files, and relocating resources to appropriate + locations in the collection project. + + + + + + This interface follows the same pattern as [IDocEnricher](/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher), [IDocTransformer](/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer), + and [IDocRenderer](/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer) for format-specific documentation processing. + + + + +## Properties + +### DocumentationType Abstract + +Gets the documentation type this handler supports. + +#### Syntax + +```csharp +CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` +The [SupportedDocumentationType](/api-reference/CloudNimble/DotNetDocs/Core/Configuration/SupportedDocumentationType) that this handler can process. + +## Methods + +### ProcessAsync Abstract + +Processes a documentation reference by copying files, rewriting content paths, + and relocating resources as appropriate for this documentation format. + +#### Syntax + +```csharp +System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | The documentation reference to process. | +| `documentationRootPath` | `string` | The root path of the collection documentation output. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous processing operation. + +#### Remarks + + + + + Implementations should handle the following responsibilities: + + + + + diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer.mdx index 2111f4e..b635e3a 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['IDocRenderer', 'CloudNimble.DotNetDocs.Core.IDocRenderer', 'CloudNimble.DotNetDocs.Core', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -30,7 +28,7 @@ Implementations of this interface generate specific output formats (Markdown, JS ## Methods -### RenderAsync +### RenderAsync Abstract Renders the documentation assembly to the output path specified in the project context. @@ -44,7 +42,7 @@ System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly | Name | Type | Description | |------|------|-------------| -| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to render. | +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | #### Returns @@ -53,10 +51,23 @@ A task representing the asynchronous rendering operation. #### Remarks -Renderers that support navigation combining (e.g., Mintlify) should access + + + + When model is null, the renderer should skip API reference generation but still process + any other operations like navigation file merging (e.g., combining DocumentationReferences). + + + + + + Renderers that support navigation combining (e.g., Mintlify) should access Context.DocumentationReferences and combine navigation before saving their configuration. + + + -### RenderPlaceholdersAsync +### RenderPlaceholdersAsync Abstract Renders placeholder conceptual content files for the documentation assembly. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer.mdx index abc0b1d..4a0e320 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['IDocTransformer', 'CloudNimble.DotNetDocs.Core.IDocTransformer', 'CloudNimble.DotNetDocs.Core', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -30,7 +28,7 @@ Implementations of this interface modify the documentation model before renderin ## Methods -### TransformAsync +### TransformAsync Abstract Transforms a documentation entity. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler.mdx new file mode 100644 index 0000000..02586c6 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler.mdx @@ -0,0 +1,387 @@ +--- +title: MarkdownDocReferenceHandler +description: "Handler for Markdown-based documentation references providing content path rewriting." +icon: file-brackets-curly +keywords: ['MarkdownDocReferenceHandler', 'CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler', 'CloudNimble.DotNetDocs.Core', 'class', 'CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase', 'CloudNimble.DotNetDocs.Core.IDocReferenceHandler'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Core.dll + +**Namespace:** CloudNimble.DotNetDocs.Core + +**Inheritance:** CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler +``` + +## Summary + +Handler for Markdown-based documentation references providing content path rewriting. + +## Remarks + + + + + This class extends [DocReferenceHandlerBase](/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase) to add Markdown-specific + content rewriting functionality. It handles standard Markdown image and link syntax, + rewriting absolute paths to include the destination path prefix. + + + + + + Derived classes can extend this behavior to handle format-specific patterns such as + JSX imports, component props, or other content-specific path references. + + + + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MarkdownDocReferenceHandler() +``` + +### .ctor Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +#### Syntax + +```csharp +protected DocReferenceHandlerBase() +``` + +### .ctor Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public Object() +``` + +## Properties + +### DocumentationType Override + +#### Syntax + +```csharp +public override CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` + +### DocumentationType Inherited Abstract + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +#### Syntax + +```csharp +public abstract CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` + +## Methods + +### CopyDirectoryWithExclusionsAsync Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Recursively copies a directory and its contents, excluding files that match exclusion patterns. + +#### Syntax + +```csharp +protected System.Threading.Tasks.Task CopyDirectoryWithExclusionsAsync(string sourceDir, string destDir, System.Collections.Generic.List exclusionPatterns, bool skipExisting = true) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `sourceDir` | `string` | The source directory to copy from. | +| `destDir` | `string` | The destination directory to copy to. | +| `exclusionPatterns` | `System.Collections.Generic.List` | List of glob patterns for files to exclude. | +| `skipExisting` | `bool` | Whether to skip files that already exist in the destination. | + +#### Returns + +Type: `System.Threading.Tasks.Task` +A task representing the asynchronous copy operation. + +### Equals Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual bool Equals(object obj) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `obj` | `object?` | - | + +#### Returns + +Type: `bool` + +### Equals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool Equals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### GetExclusionPatternsForDocumentationType Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Gets file exclusion patterns for a given documentation type when copying DocumentationReferences. + +#### Syntax + +```csharp +protected System.Collections.Generic.List GetExclusionPatternsForDocumentationType(CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType documentationType) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `documentationType` | `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` | The documentation type (Mintlify, DocFX, MkDocs, etc.). | + +#### Returns + +Type: `System.Collections.Generic.List` +A list of glob patterns for files that should be excluded from copying. + +### GetHashCode Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual int GetHashCode() +``` + +#### Returns + +Type: `int` + +### GetType Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public System.Type GetType() +``` + +#### Returns + +Type: `System.Type` + +### MatchesGlobPattern Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Matches a file path against a glob pattern. + +#### Syntax + +```csharp +protected bool MatchesGlobPattern(string path, string pattern) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `path` | `string` | The file path to match. | +| `pattern` | `string` | The glob pattern. | + +#### Returns + +Type: `bool` +True if the path matches the pattern, false otherwise. + +### MemberwiseClone Inherited + +Inherited from `object` + +#### Syntax + +```csharp +protected internal object MemberwiseClone() +``` + +#### Returns + +Type: `object` + +### ProcessAsync Override + +#### Syntax + +```csharp +public override System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | - | +| `documentationRootPath` | `string` | - | + +#### Returns + +Type: `System.Threading.Tasks.Task` + +### ProcessAsync Inherited Abstract + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +#### Syntax + +```csharp +public abstract System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | - | +| `documentationRootPath` | `string` | - | + +#### Returns + +Type: `System.Threading.Tasks.Task` + +### ReferenceEquals Inherited + +Inherited from `object` + +#### Syntax + +```csharp +public static bool ReferenceEquals(object objA, object objB) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `objA` | `object?` | - | +| `objB` | `object?` | - | + +#### Returns + +Type: `bool` + +### ShouldExcludeDirectory Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Determines if a directory should be excluded based on exclusion patterns. + +#### Syntax + +```csharp +protected bool ShouldExcludeDirectory(string relativePath, System.Collections.Generic.List exclusionPatterns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `relativePath` | `string` | The relative path of the directory. | +| `exclusionPatterns` | `System.Collections.Generic.List` | List of glob patterns for exclusion. | + +#### Returns + +Type: `bool` +True if the directory should be excluded, false otherwise. + +### ShouldExcludeFile Inherited + +Inherited from `CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase` + +Determines if a file should be excluded based on exclusion patterns. + +#### Syntax + +```csharp +protected bool ShouldExcludeFile(string relativePath, System.Collections.Generic.List exclusionPatterns) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `relativePath` | `string` | The relative path of the file. | +| `exclusionPatterns` | `System.Collections.Generic.List` | List of glob patterns for exclusion. | + +#### Returns + +Type: `bool` +True if the file should be excluded, false otherwise. + +### ToString Inherited Virtual + +Inherited from `object` + +#### Syntax + +```csharp +public virtual string ToString() +``` + +#### Returns + +Type: `string?` + +## Related APIs + +- CloudNimble.DotNetDocs.Core.IDocReferenceHandler + diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext.mdx index 082a8f5..ca0e009 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ProjectContext', 'CloudNimble.DotNetDocs.Core.ProjectContext', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -44,7 +42,7 @@ var model = await manager.DocumentAsync("MyLib.dll", "MyLib.xml", context); ## Constructors -### .ctor +### .ctor Initializes a new instance of [ProjectContext](/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext) with default settings. @@ -54,7 +52,7 @@ Initializes a new instance of [ProjectContext](/api-reference/CloudNimble/DotNet public ProjectContext() ``` -### .ctor +### .ctor Initializes a new instance of [ProjectContext](/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext) with optional included members and referenced assemblies. @@ -71,7 +69,7 @@ public ProjectContext(System.Collections.Generic.List?` | List of member accessibilities to include. Defaults to Public if null. | | `references` | `string[]?` | Paths to referenced assemblies. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -83,7 +81,7 @@ public Object() ## Properties -### ApiReferencePath +### ApiReferencePath Gets or sets the path to the API reference documentation. @@ -97,7 +95,7 @@ public string ApiReferencePath { get; set; } Type: `string` -### ConceptualDocsEnabled +### ConceptualDocsEnabled Gets or sets whether conceptual documentation features are enabled. @@ -114,7 +112,7 @@ When true (default), conceptual documentation files are generated for new types and existing conceptual content is loaded. When false, only API documentation from XML comments is processed. -### ConceptualPath +### ConceptualPath Gets or sets the path to the conceptual documentation folder. @@ -129,7 +127,7 @@ public string ConceptualPath { get; set; } Type: `string` The file system path to the folder containing conceptual documentation files. -### CreateExternalTypeReferences +### CreateExternalTypeReferences Gets or sets whether to create documentation for external types that have extension methods. @@ -152,7 +150,7 @@ When enabled, extending `IServiceCollection` creates a documentation page showin only your extension methods, with a link to Microsoft's official documentation for the complete type definition. -### DocumentationReferences +### DocumentationReferences Gets or sets the collection of external documentation references to combine into this documentation collection. @@ -192,7 +190,7 @@ Similar to MSBuild's ProjectReference, this allows creating unified documentatio multiple separate .docsproj outputs. Each reference specifies where to copy files from and how to integrate navigation. -### DocumentationRootPath +### DocumentationRootPath Gets or sets the output path for generated documentation. @@ -207,7 +205,7 @@ public string DocumentationRootPath { get; set; } Type: `string` The file system path where documentation output will be generated. -### ExcludedTypes +### ExcludedTypes Gets or sets the list of type patterns to exclude from documentation. @@ -239,7 +237,7 @@ Patterns can use wildcards: - "Namespace.*.TypeName" matches TypeName in any sub-namespace of Namespace - "Full.Namespace.TypeName" matches exact fully qualified type name -### FileNamingOptions +### FileNamingOptions Gets or sets the file naming options for documentation generation. @@ -254,7 +252,7 @@ public CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions FileNamingOpt Type: `CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions` Configuration for how documentation files are named and organized. -### IncludedMembers +### IncludedMembers Gets or sets the list of member accessibilities to include in documentation. @@ -269,7 +267,7 @@ public System.Collections.Generic.List Inc Type: `System.Collections.Generic.List` List of accessibility levels to include. Defaults to Public only. -### IncludeFields +### IncludeFields Gets or sets whether to include fields in the documentation. @@ -285,7 +283,7 @@ Type: `bool` When true, public fields (including constants) are included in the documentation. Defaults to false since fields are generally discouraged in favor of properties. -### IncludeSystemObjectInheritance +### IncludeSystemObjectInheritance Gets or sets whether to include members inherited from [Object](https://learn.microsoft.com/dotnet/api/system.object). @@ -307,7 +305,7 @@ Setting this to `false` reduces documentation noise while still including members inherited from other base types and interfaces. This matches the behavior of Microsoft's official .NET documentation. -### References +### References Gets or sets the collection of paths to referenced assemblies. @@ -322,7 +320,7 @@ public System.Collections.Generic.List References { get; set; } Type: `System.Collections.Generic.List` A collection of file system paths to assemblies referenced by the project being documented. -### ShowPlaceholders +### ShowPlaceholders Gets or sets whether to show placeholder content in the documentation. @@ -340,7 +338,7 @@ When true (default), placeholder content is included. When false, files containi ## Methods -### EnsureOutputDirectoryStructure +### EnsureOutputDirectoryStructure Ensures that the output directory structure exists for all namespaces in the assembly model. @@ -363,7 +361,7 @@ This method creates the necessary folder structure when using Folder mode. In File mode, it simply ensures the base output directory exists. This centralizes folder creation logic so renderers can assume directories exist. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -383,7 +381,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -404,7 +402,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetFullConceptualPath +### GetFullConceptualPath Gets the full path to the conceptual documentation folder. @@ -439,7 +437,7 @@ This method ensures that conceptual paths are always resolved to absolute paths, making it easier to work with conceptual documentation files regardless of whether the path is configured as relative or absolute. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -453,7 +451,7 @@ public virtual int GetHashCode() Type: `int` -### GetNamespaceFolderPath +### GetNamespaceFolderPath Converts a namespace string to a folder path based on the configured file naming options. @@ -481,7 +479,7 @@ When [FileNamingOptions.NamespaceMode](/api-reference/CloudNimble/DotNetDocs/Cor When using [NamespaceMode.File](/api-reference/CloudNimble/DotNetDocs/Core/Configuration/NamespaceMode#file), this returns an empty string as no folder structure is created. -### GetSafeNamespaceName +### GetSafeNamespaceName Gets the safe namespace name for a given namespace symbol. @@ -502,7 +500,7 @@ public string GetSafeNamespaceName(Microsoft.CodeAnalysis.INamespaceSymbol names Type: `string` A safe namespace name, using "global" for the global namespace. -### GetType +### GetType Inherited Inherited from `object` @@ -516,7 +514,7 @@ public System.Type GetType() Type: `System.Type` -### GetTypeFilePath +### GetTypeFilePath Gets the full file path for a type, including namespace folder structure if in Folder mode. @@ -543,7 +541,7 @@ The file path for the type. In Folder mode: "System.Text.Json.JsonSerializer" becomes "System/Text/Json/JsonSerializer.md" In File mode: "System.Text.Json.JsonSerializer" becomes "System_Text_Json_JsonSerializer.md" (using configured separator) -### IsTypeExcluded +### IsTypeExcluded Checks if a type should be excluded from documentation based on exclusion patterns. @@ -564,7 +562,7 @@ public bool IsTypeExcluded(string fullyQualifiedTypeName) Type: `bool` True if the type should be excluded; otherwise, false. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -578,7 +576,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -599,7 +597,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType.mdx index 60b2d01..a53ec94 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['ReferenceType', 'CloudNimble.DotNetDocs.Core.ReferenceType', 'CloudNimble.DotNetDocs.Core', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer.mdx index ae56f97..b5af63f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['JsonRenderer', 'CloudNimble.DotNetDocs.Core.Renderers.JsonRenderer', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.RendererBase', 'CloudNimble.DotNetDocs.Core.IDocRenderer'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Generates structured JSON documentation suitable for API consumption and integra ## Constructors -### .ctor +### .ctor Initializes a new instance of the [JsonRenderer](/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRenderer) class. @@ -49,7 +47,7 @@ public JsonRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = null, C | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | | `options` | `CloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions?` | The rendering options. If null, default options are used. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -68,7 +66,7 @@ protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | | `enabled` | `bool` | - | -### .ctor +### .ctor Inherited Inherited from `object` @@ -80,7 +78,7 @@ public Object() ## Properties -### Context +### Context Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -97,7 +95,7 @@ protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; } Type: `CloudNimble.DotNetDocs.Core.ProjectContext` The project context containing configuration and settings. -### Enabled +### Enabled Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -113,7 +111,7 @@ public bool Enabled { get; set; } Type: `bool` -### FileNamingOptions +### FileNamingOptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -132,7 +130,7 @@ The file naming configuration. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -152,7 +150,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -173,7 +171,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### EscapeXmlTagsInString +### EscapeXmlTagsInString Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -203,7 +201,7 @@ Converts angle brackets to HTML entities to prevent MDX parser interpretation as (e.g., <see cref="...">) by converting them to JsonConverter&lt;object&gt; and &lt;see cref="..."&gt; respectively. -### GetAccessModifier +### GetAccessModifier Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -226,7 +224,7 @@ protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessib Type: `string` The access modifier string. -### GetEventSignature +### GetEventSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -249,7 +247,7 @@ protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt) Type: `string` The event signature. -### GetFieldSignature +### GetFieldSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -272,7 +270,7 @@ protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field) Type: `string` The field signature. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -286,7 +284,7 @@ public virtual int GetHashCode() Type: `int` -### GetMemberSignature +### GetMemberSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -309,7 +307,7 @@ protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member Type: `string` The member signature string. -### GetMethodSignature +### GetMethodSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -332,7 +330,7 @@ protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method) Type: `string` The method signature. -### GetNamespaceFileName +### GetNamespaceFileName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -360,7 +358,7 @@ A safe file name for the namespace. This method is deprecated. Use GetNamespaceFilePath instead. -### GetNamespaceFilePath +### GetNamespaceFilePath Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -385,7 +383,7 @@ protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace n Type: `string` The full file path for the namespace documentation. -### GetPropertySignature +### GetPropertySignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -408,7 +406,7 @@ protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol pro Type: `string` The property signature. -### GetSafeNamespaceName +### GetSafeNamespaceName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -431,7 +429,7 @@ public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) Type: `string` A safe namespace name, using "global" for the global namespace. -### GetSafeTypeName +### GetSafeTypeName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -454,7 +452,7 @@ protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type) Type: `string` A safe type name with invalid characters replaced. -### GetType +### GetType Inherited Inherited from `object` @@ -468,7 +466,7 @@ public System.Type GetType() Type: `System.Type` -### GetTypeFileName +### GetTypeFileName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -497,7 +495,7 @@ A safe file name for the type. This method is deprecated. Use GetTypeFilePath instead. -### GetTypeFilePath +### GetTypeFilePath Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -523,7 +521,7 @@ protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, Cloud Type: `string` The full file path for the type documentation. -### GetTypeSignature +### GetTypeSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -546,7 +544,7 @@ protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type) Type: `string` The type signature. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -560,7 +558,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -581,7 +579,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### RemoveIndentation +### RemoveIndentation Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -604,7 +602,7 @@ internal static string RemoveIndentation(string text) Type: `string` The text with common indentation removed. -### RenderAsync +### RenderAsync Renders the documentation assembly to JSON files. @@ -618,14 +616,14 @@ public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAs | Name | Type | Description | |------|------|-------------| -| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to render. | +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | #### Returns Type: `System.Threading.Tasks.Task` A task representing the asynchronous rendering operation. -### RenderPlaceholdersAsync +### RenderPlaceholdersAsync Renders placeholder conceptual content files for the documentation assembly. @@ -646,7 +644,7 @@ public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDoc Type: `System.Threading.Tasks.Task` A task representing the asynchronous placeholder rendering operation. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions.mdx index 5d3418d..efb68e2 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/JsonRendererOptions.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['JsonRendererOptions', 'CloudNimble.DotNetDocs.Core.Renderers.JsonRendererOptions', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -27,7 +25,7 @@ Configuration options for the JsonRenderer. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Configuration options for the JsonRenderer. public JsonRendererOptions() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### SerializerOptions +### SerializerOptions Gets or sets the JsonSerializerOptions to use for serialization. @@ -68,7 +66,7 @@ If not specified, uses default options with camelCase naming, indented output, ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -88,7 +86,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -109,7 +107,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -123,7 +121,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -137,7 +135,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -151,7 +149,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -172,7 +170,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer.mdx index bad6a17..4c14c4e 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MarkdownRenderer', 'CloudNimble.DotNetDocs.Core.Renderers.MarkdownRenderer', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase', 'CloudNimble.DotNetDocs.Core.IDocRenderer'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Generates structured Markdown documentation with support for customizations incl ## Constructors -### .ctor +### .ctor Initializes a new instance of the [MarkdownRenderer](/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRenderer) class. @@ -48,7 +46,7 @@ public MarkdownRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = nul |------|------|-------------| | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -66,7 +64,7 @@ public MarkdownRendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = |------|------|-------------| | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -85,7 +83,7 @@ protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | | `enabled` | `bool` | - | -### .ctor +### .ctor Inherited Inherited from `object` @@ -97,7 +95,7 @@ public Object() ## Properties -### Context +### Context Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -114,7 +112,7 @@ protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; } Type: `CloudNimble.DotNetDocs.Core.ProjectContext` The project context containing configuration and settings. -### Enabled +### Enabled Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -130,7 +128,7 @@ public bool Enabled { get; set; } Type: `bool` -### FileNamingOptions +### FileNamingOptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -149,7 +147,7 @@ The file naming configuration. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -169,7 +167,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -190,7 +188,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### EscapeXmlTagsInString +### EscapeXmlTagsInString Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -220,7 +218,7 @@ Converts angle brackets to HTML entities to prevent MDX parser interpretation as (e.g., <see cref="...">) by converting them to JsonConverter&lt;object&gt; and &lt;see cref="..."&gt; respectively. -### GetAccessModifier +### GetAccessModifier Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -243,7 +241,7 @@ protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessib Type: `string` The access modifier string. -### GetBestPracticesTemplate +### GetBestPracticesTemplate Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -266,7 +264,7 @@ protected static string GetBestPracticesTemplate(string entityName) Type: `string` A markdown template string for best practices documentation. -### GetConsiderationsTemplate +### GetConsiderationsTemplate Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -289,7 +287,7 @@ protected static string GetConsiderationsTemplate(string entityName) Type: `string` A markdown template string for considerations documentation. -### GetEventSignature +### GetEventSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -312,7 +310,7 @@ protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt) Type: `string` The event signature. -### GetExamplesTemplate +### GetExamplesTemplate Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -335,7 +333,7 @@ protected static string GetExamplesTemplate(string entityName) Type: `string` A markdown template string for examples documentation. -### GetFieldSignature +### GetFieldSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -358,7 +356,7 @@ protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field) Type: `string` The field signature. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -372,7 +370,7 @@ public virtual int GetHashCode() Type: `int` -### GetHeaderText +### GetHeaderText Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -397,7 +395,7 @@ protected static string GetHeaderText(string content, string headerText) Type: `string?` The header text to add, or null if no header should be added. -### GetMemberSignature +### GetMemberSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -420,7 +418,7 @@ protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member Type: `string` The member signature string. -### GetMethodSignature +### GetMethodSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -443,7 +441,7 @@ protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method) Type: `string` The method signature. -### GetNamespaceFileName +### GetNamespaceFileName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -471,7 +469,7 @@ A safe file name for the namespace. This method is deprecated. Use GetNamespaceFilePath instead. -### GetNamespaceFilePath +### GetNamespaceFilePath Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -496,7 +494,7 @@ protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace n Type: `string` The full file path for the namespace documentation. -### GetPatternsTemplate +### GetPatternsTemplate Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -519,7 +517,7 @@ protected static string GetPatternsTemplate(string entityName) Type: `string` A markdown template string for patterns documentation. -### GetPropertySignature +### GetPropertySignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -542,7 +540,7 @@ protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol pro Type: `string` The property signature. -### GetRelatedApisTemplate +### GetRelatedApisTemplate Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -565,7 +563,7 @@ protected static string GetRelatedApisTemplate(string entityName) Type: `string` A markdown template string for related APIs documentation. -### GetSafeNamespaceName +### GetSafeNamespaceName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -588,7 +586,7 @@ public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) Type: `string` A safe namespace name, using "global" for the global namespace. -### GetSafeTypeName +### GetSafeTypeName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -611,7 +609,7 @@ protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type) Type: `string` A safe type name with invalid characters replaced. -### GetSummaryTemplate +### GetSummaryTemplate Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -634,7 +632,7 @@ protected static string GetSummaryTemplate(string entityName) Type: `string` A markdown template string for summary documentation. -### GetType +### GetType Inherited Inherited from `object` @@ -648,7 +646,7 @@ public System.Type GetType() Type: `System.Type` -### GetTypeFileName +### GetTypeFileName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -677,7 +675,7 @@ A safe file name for the type. This method is deprecated. Use GetTypeFilePath instead. -### GetTypeFilePath +### GetTypeFilePath Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -703,7 +701,7 @@ protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, Cloud Type: `string` The full file path for the type documentation. -### GetTypeSignature +### GetTypeSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -726,7 +724,7 @@ protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type) Type: `string` The type signature. -### GetUsageTemplate +### GetUsageTemplate Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase` @@ -749,7 +747,7 @@ protected static string GetUsageTemplate(string entityName) Type: `string` A markdown template string for usage documentation. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -763,7 +761,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -784,7 +782,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### RemoveIndentation +### RemoveIndentation Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -807,7 +805,7 @@ internal static string RemoveIndentation(string text) Type: `string` The text with common indentation removed. -### RenderAsync +### RenderAsync Renders the documentation assembly to Markdown files. @@ -821,14 +819,14 @@ public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAs | Name | Type | Description | |------|------|-------------| -| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to render. | +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | #### Returns Type: `System.Threading.Tasks.Task` A task representing the asynchronous rendering operation. -### RenderPlaceholdersAsync +### RenderPlaceholdersAsync Renders placeholder conceptual content files for the documentation assembly. @@ -849,7 +847,7 @@ public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDoc Type: `System.Threading.Tasks.Task` A task representing the asynchronous placeholder rendering operation. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase.mdx index cdc2142..b010052 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase.mdx @@ -6,8 +6,6 @@ tag: "ABSTRACT" keywords: ['MarkdownRendererBase', 'CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.RendererBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -28,7 +26,7 @@ Base class for Markdown-based renderers providing common formatting utilities. ## Constructors -### .ctor +### .ctor Initializes a new instance of the [MarkdownRendererBase](/api-reference/CloudNimble/DotNetDocs/Core/Renderers/MarkdownRendererBase) class. @@ -44,7 +42,7 @@ public MarkdownRendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = |------|------|-------------| | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -63,7 +61,7 @@ protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | | `enabled` | `bool` | - | -### .ctor +### .ctor Inherited Inherited from `object` @@ -75,7 +73,7 @@ public Object() ## Properties -### Context +### Context Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -92,7 +90,7 @@ protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; } Type: `CloudNimble.DotNetDocs.Core.ProjectContext` The project context containing configuration and settings. -### Enabled +### Enabled Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -108,7 +106,7 @@ public bool Enabled { get; set; } Type: `bool` -### FileNamingOptions +### FileNamingOptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -127,7 +125,7 @@ The file naming configuration. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -147,7 +145,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -168,7 +166,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### EscapeXmlTagsInString +### EscapeXmlTagsInString Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -198,7 +196,7 @@ Converts angle brackets to HTML entities to prevent MDX parser interpretation as (e.g., <see cref="...">) by converting them to JsonConverter&lt;object&gt; and &lt;see cref="..."&gt; respectively. -### GetAccessModifier +### GetAccessModifier Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -221,7 +219,7 @@ protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessib Type: `string` The access modifier string. -### GetEventSignature +### GetEventSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -244,7 +242,7 @@ protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt) Type: `string` The event signature. -### GetFieldSignature +### GetFieldSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -267,7 +265,7 @@ protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field) Type: `string` The field signature. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -281,7 +279,7 @@ public virtual int GetHashCode() Type: `int` -### GetMemberSignature +### GetMemberSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -304,7 +302,7 @@ protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member Type: `string` The member signature string. -### GetMethodSignature +### GetMethodSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -327,7 +325,7 @@ protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method) Type: `string` The method signature. -### GetNamespaceFileName +### GetNamespaceFileName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -355,7 +353,7 @@ A safe file name for the namespace. This method is deprecated. Use GetNamespaceFilePath instead. -### GetNamespaceFilePath +### GetNamespaceFilePath Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -380,7 +378,7 @@ protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace n Type: `string` The full file path for the namespace documentation. -### GetPropertySignature +### GetPropertySignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -403,7 +401,7 @@ protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol pro Type: `string` The property signature. -### GetSafeNamespaceName +### GetSafeNamespaceName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -426,7 +424,7 @@ public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) Type: `string` A safe namespace name, using "global" for the global namespace. -### GetSafeTypeName +### GetSafeTypeName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -449,7 +447,7 @@ protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type) Type: `string` A safe type name with invalid characters replaced. -### GetType +### GetType Inherited Inherited from `object` @@ -463,7 +461,7 @@ public System.Type GetType() Type: `System.Type` -### GetTypeFileName +### GetTypeFileName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -492,7 +490,7 @@ A safe file name for the type. This method is deprecated. Use GetTypeFilePath instead. -### GetTypeFilePath +### GetTypeFilePath Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -518,7 +516,7 @@ protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, Cloud Type: `string` The full file path for the type documentation. -### GetTypeSignature +### GetTypeSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -541,7 +539,7 @@ protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type) Type: `string` The type signature. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -555,7 +553,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -576,7 +574,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### RemoveIndentation +### RemoveIndentation Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -599,7 +597,7 @@ internal static string RemoveIndentation(string text) Type: `string` The text with common indentation removed. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase.mdx index 0c67119..b47b8c6 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/RendererBase.mdx @@ -6,8 +6,6 @@ tag: "ABSTRACT" keywords: ['RendererBase', 'CloudNimble.DotNetDocs.Core.Renderers.RendererBase', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -28,7 +26,7 @@ Base class for documentation renderers providing common functionality. ## Constructors -### .ctor +### .ctor Inherited Inherited from `object` @@ -40,7 +38,7 @@ public Object() ## Properties -### Enabled +### Enabled When more than one Renderer is registered, allows a renderer to be turned off. @@ -56,7 +54,7 @@ Type: `bool` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -76,7 +74,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -97,7 +95,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -111,7 +109,7 @@ public virtual int GetHashCode() Type: `int` -### GetNamespaceFileName +### GetNamespaceFileName Gets a safe file name for a namespace, suitable for use in file systems. @@ -137,7 +135,7 @@ A safe file name for the namespace. This method is deprecated. Use GetNamespaceFilePath instead. -### GetSafeNamespaceName +### GetSafeNamespaceName Gets a safe namespace name for use in file names and display. @@ -158,7 +156,7 @@ public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) Type: `string` A safe namespace name, using "global" for the global namespace. -### GetType +### GetType Inherited Inherited from `object` @@ -172,7 +170,7 @@ public System.Type GetType() Type: `System.Type` -### GetTypeFileName +### GetTypeFileName Gets a safe file name for a type, suitable for use in file systems. @@ -199,7 +197,7 @@ A safe file name for the type. This method is deprecated. Use GetTypeFilePath instead. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -213,7 +211,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -234,7 +232,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter.mdx index e95b3de..df9d1aa 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/AccessibilityTypeConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['AccessibilityTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.AccessibilityTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -27,7 +25,7 @@ Custom type converter for Accessibility enum. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Custom type converter for Accessibility enum. public AccessibilityTypeConverter() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Methods -### Accepts +### Accepts Determines whether this converter can handle the specified type. @@ -68,7 +66,7 @@ public bool Accepts(System.Type type) Type: `bool` true if this converter can handle the type; otherwise, false. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -88,7 +86,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -109,7 +107,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -123,7 +121,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -137,7 +135,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -151,7 +149,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReadYaml +### ReadYaml Reads the YAML representation of the object. @@ -180,7 +178,7 @@ The deserialized object. |-----------|-------------| | `NotImplementedException` | Reading is not supported. | -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -201,7 +199,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -215,7 +213,7 @@ public virtual string ToString() Type: `string?` -### WriteYaml +### WriteYaml Writes the YAML representation of the object. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter.mdx index 826351c..bb5c8c3 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/RefKindTypeConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['RefKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.RefKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -27,7 +25,7 @@ Custom type converter for RefKind enum. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Custom type converter for RefKind enum. public RefKindTypeConverter() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Methods -### Accepts +### Accepts Determines whether this converter can handle the specified type. @@ -68,7 +66,7 @@ public bool Accepts(System.Type type) Type: `bool` true if this converter can handle the type; otherwise, false. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -88,7 +86,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -109,7 +107,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -123,7 +121,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -137,7 +135,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -151,7 +149,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReadYaml +### ReadYaml Reads the YAML representation of the object. @@ -180,7 +178,7 @@ The deserialized object. |-----------|-------------| | `NotImplementedException` | Reading is not supported. | -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -201,7 +199,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -215,7 +213,7 @@ public virtual string ToString() Type: `string?` -### WriteYaml +### WriteYaml Writes the YAML representation of the object. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter.mdx index 6b65a62..68a190a 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolKindTypeConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SymbolKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.SymbolKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -27,7 +25,7 @@ Custom type converter for SymbolKind enum. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Custom type converter for SymbolKind enum. public SymbolKindTypeConverter() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Methods -### Accepts +### Accepts Determines whether this converter can handle the specified type. @@ -68,7 +66,7 @@ public bool Accepts(System.Type type) Type: `bool` true if this converter can handle the type; otherwise, false. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -88,7 +86,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -109,7 +107,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -123,7 +121,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -137,7 +135,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -151,7 +149,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReadYaml +### ReadYaml Reads the YAML representation of the object. @@ -180,7 +178,7 @@ The deserialized object. |-----------|-------------| | `NotImplementedException` | Reading is not supported. | -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -201,7 +199,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -215,7 +213,7 @@ public virtual string ToString() Type: `string?` -### WriteYaml +### WriteYaml Writes the YAML representation of the object. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter.mdx index 837015a..642ae89 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/SymbolTypeConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SymbolTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.SymbolTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -27,7 +25,7 @@ Custom type converter for ISymbol interface to prevent serialization. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Custom type converter for ISymbol interface to prevent serialization. public SymbolTypeConverter() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Methods -### Accepts +### Accepts Determines whether this converter can handle the specified type. @@ -68,7 +66,7 @@ public bool Accepts(System.Type type) Type: `bool` true if this converter can handle the type; otherwise, false. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -88,7 +86,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -109,7 +107,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -123,7 +121,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -137,7 +135,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -151,7 +149,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReadYaml +### ReadYaml Reads the YAML representation of the object. @@ -180,7 +178,7 @@ The deserialized object. |-----------|-------------| | `NotImplementedException` | Reading is not supported. | -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -201,7 +199,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -215,7 +213,7 @@ public virtual string ToString() Type: `string?` -### WriteYaml +### WriteYaml Writes the YAML representation of the object. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter.mdx index 57936c2..6573ef0 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlConverters/TypeKindTypeConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['TypeKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters.TypeKindTypeConverter', 'CloudNimble.DotNetDocs.Core.Renderers.YamlConverters', 'class', 'System.Object', 'YamlDotNet.Serialization.IYamlTypeConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -27,7 +25,7 @@ Custom type converter for TypeKind enum. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Custom type converter for TypeKind enum. public TypeKindTypeConverter() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Methods -### Accepts +### Accepts Determines whether this converter can handle the specified type. @@ -68,7 +66,7 @@ public bool Accepts(System.Type type) Type: `bool` true if this converter can handle the type; otherwise, false. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -88,7 +86,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -109,7 +107,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -123,7 +121,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -137,7 +135,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -151,7 +149,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReadYaml +### ReadYaml Reads the YAML representation of the object. @@ -180,7 +178,7 @@ The deserialized object. |-----------|-------------| | `NotImplementedException` | Reading is not supported. | -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -201,7 +199,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -215,7 +213,7 @@ public virtual string ToString() Type: `string?` -### WriteYaml +### WriteYaml Writes the YAML representation of the object. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer.mdx index a297dc9..597f26c 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['YamlRenderer', 'CloudNimble.DotNetDocs.Core.Renderers.YamlRenderer', 'CloudNimble.DotNetDocs.Core.Renderers', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.RendererBase', 'CloudNimble.DotNetDocs.Core.IDocRenderer'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -32,7 +30,7 @@ Generates structured YAML documentation suitable for configuration files and ## Constructors -### .ctor +### .ctor Initializes a new instance of the [YamlRenderer](/api-reference/CloudNimble/DotNetDocs/Core/Renderers/YamlRenderer) class. @@ -48,7 +46,7 @@ public YamlRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = null) |------|------|-------------| | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -67,7 +65,7 @@ protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null | `context` | `CloudNimble.DotNetDocs.Core.ProjectContext?` | The project context. If null, a default context is created. | | `enabled` | `bool` | - | -### .ctor +### .ctor Inherited Inherited from `object` @@ -79,7 +77,7 @@ public Object() ## Properties -### Context +### Context Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -96,7 +94,7 @@ protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; } Type: `CloudNimble.DotNetDocs.Core.ProjectContext` The project context containing configuration and settings. -### Enabled +### Enabled Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -112,7 +110,7 @@ public bool Enabled { get; set; } Type: `bool` -### FileNamingOptions +### FileNamingOptions Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -131,7 +129,7 @@ The file naming configuration. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -151,7 +149,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -172,7 +170,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### EscapeXmlTagsInString +### EscapeXmlTagsInString Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -202,7 +200,7 @@ Converts angle brackets to HTML entities to prevent MDX parser interpretation as (e.g., <see cref="...">) by converting them to JsonConverter&lt;object&gt; and &lt;see cref="..."&gt; respectively. -### GetAccessModifier +### GetAccessModifier Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -225,7 +223,7 @@ protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessib Type: `string` The access modifier string. -### GetEventSignature +### GetEventSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -248,7 +246,7 @@ protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt) Type: `string` The event signature. -### GetFieldSignature +### GetFieldSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -271,7 +269,7 @@ protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field) Type: `string` The field signature. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -285,7 +283,7 @@ public virtual int GetHashCode() Type: `int` -### GetMemberSignature +### GetMemberSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -308,7 +306,7 @@ protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member Type: `string` The member signature string. -### GetMethodSignature +### GetMethodSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -331,7 +329,7 @@ protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method) Type: `string` The method signature. -### GetNamespaceFileName +### GetNamespaceFileName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -359,7 +357,7 @@ A safe file name for the namespace. This method is deprecated. Use GetNamespaceFilePath instead. -### GetNamespaceFilePath +### GetNamespaceFilePath Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -384,7 +382,7 @@ protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace n Type: `string` The full file path for the namespace documentation. -### GetPropertySignature +### GetPropertySignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -407,7 +405,7 @@ protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol pro Type: `string` The property signature. -### GetSafeNamespaceName +### GetSafeNamespaceName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -430,7 +428,7 @@ public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns) Type: `string` A safe namespace name, using "global" for the global namespace. -### GetSafeTypeName +### GetSafeTypeName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -453,7 +451,7 @@ protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type) Type: `string` A safe type name with invalid characters replaced. -### GetType +### GetType Inherited Inherited from `object` @@ -467,7 +465,7 @@ public System.Type GetType() Type: `System.Type` -### GetTypeFileName +### GetTypeFileName Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -496,7 +494,7 @@ A safe file name for the type. This method is deprecated. Use GetTypeFilePath instead. -### GetTypeFilePath +### GetTypeFilePath Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -522,7 +520,7 @@ protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, Cloud Type: `string` The full file path for the type documentation. -### GetTypeSignature +### GetTypeSignature Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -545,7 +543,7 @@ protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type) Type: `string` The type signature. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -559,7 +557,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -580,7 +578,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### RemoveIndentation +### RemoveIndentation Inherited Inherited from `CloudNimble.DotNetDocs.Core.Renderers.RendererBase` @@ -603,7 +601,7 @@ internal static string RemoveIndentation(string text) Type: `string` The text with common indentation removed. -### RenderAsync +### RenderAsync Renders the documentation assembly to YAML files. @@ -617,14 +615,14 @@ public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAs | Name | Type | Description | |------|------|-------------| -| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to render. | +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | #### Returns Type: `System.Threading.Tasks.Task` A task representing the asynchronous rendering operation. -### RenderPlaceholdersAsync +### RenderPlaceholdersAsync Renders placeholder conceptual content files for the documentation assembly. @@ -645,7 +643,7 @@ public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDoc Type: `System.Threading.Tasks.Task` A task representing the asynchronous placeholder rendering operation. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.mdx index 7b42f1d..06bae95 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MarkdownXmlTransformer', 'CloudNimble.DotNetDocs.Core.Transformers.MarkdownXmlTransformer', 'CloudNimble.DotNetDocs.Core.Transformers', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Core.IDocTransformer'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Core.dll @@ -33,7 +31,7 @@ This transformer processes all string properties in the DocEntity object graph, ## Constructors -### .ctor +### .ctor Initializes a new instance of the [MarkdownXmlTransformer](/api-reference/CloudNimble/DotNetDocs/Core/Transformers/MarkdownXmlTransformer) class. @@ -49,7 +47,7 @@ public MarkdownXmlTransformer(CloudNimble.DotNetDocs.Core.ProjectContext project |------|------|-------------| | `projectContext` | `CloudNimble.DotNetDocs.Core.ProjectContext` | The project context for configuration and file naming. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -61,7 +59,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -81,7 +79,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -102,7 +100,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -116,7 +114,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -130,7 +128,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -144,7 +142,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -165,7 +163,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -179,7 +177,7 @@ public virtual string ToString() Type: `string?` -### TransformAsync +### TransformAsync Transforms a documentation entity by converting XML tags to Markdown. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/index.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/index.mdx index 94d989f..89b6fe2 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/index.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Core/index.mdx @@ -24,10 +24,12 @@ keywords: ['CloudNimble.DotNetDocs.Core', 'namespace', 'AssemblyManager', 'Cross | [DocNamespace](/api-reference/CloudNimble/DotNetDocs/Core/DocNamespace) | Represents documentation for a .NET namespace. | | [DocParameter](/api-reference/CloudNimble/DotNetDocs/Core/DocParameter) | Represents documentation for a method or constructor parameter. | | [DocReference](/api-reference/CloudNimble/DotNetDocs/Core/DocReference) | Represents a cross-reference in documentation, such as a see or seealso tag. | +| [DocReferenceHandlerBase](/api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase) | Base class for documentation reference handlers providing common file copying functionality. | | [DocType](/api-reference/CloudNimble/DotNetDocs/Core/DocType) | Represents documentation for a .NET type. | | [DocTypeParameter](/api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter) | Represents type parameter documentation extracted from XML documentation comments. | | [DocumentationManager](/api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager) | Orchestrates the documentation pipeline for one or more assemblies. | | [DocumentationReference](/api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference) | Represents a reference to external documentation to be combined into a documentation collection. | +| [MarkdownDocReferenceHandler](/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler) | Handler for Markdown-based documentation references providing content path rewriting. | | [ProjectContext](/api-reference/CloudNimble/DotNetDocs/Core/ProjectContext) | Represents MSBuild project context for source intent in documentation generation. | | [ReferenceType](/api-reference/CloudNimble/DotNetDocs/Core/ReferenceType) | Specifies the type of documentation reference. | @@ -36,6 +38,7 @@ keywords: ['CloudNimble.DotNetDocs.Core', 'namespace', 'AssemblyManager', 'Cross | Name | Summary | | ---- | ------- | | [IDocEnricher](/api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher) | Defines an enricher for conceptual documentation augmentation. | +| [IDocReferenceHandler](/api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler) | Defines a handler for processing documentation references from other projects. | | [IDocRenderer](/api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer) | Defines a renderer for documentation output generation. | | [IDocTransformer](/api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer) | Defines a transformation step in the documentation processing pipeline. | diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig.mdx index 8d9fc81..56a0392 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocsNavigationConfig', 'CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Mintlify.dll @@ -34,7 +32,7 @@ This class holds metadata that bridges .docsproj XML templates to Mintlify.Core, ## Constructors -### .ctor +### .ctor #### Syntax @@ -42,7 +40,7 @@ This class holds metadata that bridges .docsproj XML templates to Mintlify.Core, public DocsNavigationConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -54,7 +52,7 @@ public Object() ## Properties -### Mode +### Mode Gets or sets the navigation mode for multi-assembly documentation. @@ -69,7 +67,7 @@ public CloudNimble.DotNetDocs.Mintlify.NavigationMode Mode { get; set; } Type: `CloudNimble.DotNetDocs.Mintlify.NavigationMode?` The navigation organization mode. Default is NavigationMode.Unified. -### Name +### Name Gets or sets the navigation name/title for this documentation project when Type is Tabs or Products. @@ -84,7 +82,7 @@ public string Name { get; set; } Type: `string?` The display name for the tab or product. If not specified, the project name will be used. -### Type +### Type Gets or sets the navigation type for this documentation project. @@ -101,7 +99,7 @@ The navigation type. Default is NavigationType.Pages. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -121,7 +119,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -142,7 +140,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -156,7 +154,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -170,7 +168,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -184,7 +182,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -205,7 +203,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler.mdx new file mode 100644 index 0000000..649dc3d --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler.mdx @@ -0,0 +1,88 @@ +--- +title: MintlifyDocReferenceHandler +description: "Handles documentation references for Mintlify documentation format." +icon: file-brackets-curly +keywords: ['MintlifyDocReferenceHandler', 'CloudNimble.DotNetDocs.Mintlify.MintlifyDocReferenceHandler', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler'] +--- + +## Definition + +**Assembly:** CloudNimble.DotNetDocs.Mintlify.dll + +**Namespace:** CloudNimble.DotNetDocs.Mintlify + +**Inheritance:** CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler + +## Syntax + +```csharp +CloudNimble.DotNetDocs.Mintlify.MintlifyDocReferenceHandler +``` + +## Summary + +Handles documentation references for Mintlify documentation format. + +## Remarks + + + + + This handler extends [MarkdownDocReferenceHandler](/api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler) to add Mintlify-specific + content rewriting patterns including ES imports, JSX attributes, and CSS url() references. + + + + + + It processes referenced documentation by: + + + + + +## Constructors + +### .ctor + +#### Syntax + +```csharp +public MintlifyDocReferenceHandler() +``` + +## Properties + +### DocumentationType Override + +#### Syntax + +```csharp +public override CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; } +``` + +#### Property Value + +Type: `CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType` + +## Methods + +### ProcessAsync Override + +#### Syntax + +```csharp +public override System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `reference` | `CloudNimble.DotNetDocs.Core.DocumentationReference` | - | +| `documentationRootPath` | `string` | - | + +#### Returns + +Type: `System.Threading.Tasks.Task` + diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons.mdx index bdbe31e..dac3f5d 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons.mdx @@ -6,8 +6,6 @@ tag: "STATIC" keywords: ['MintlifyIcons', 'CloudNimble.DotNetDocs.Mintlify.MintlifyIcons', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Mintlify.dll @@ -28,7 +26,7 @@ Provides FontAwesome 7 icon mappings for different .NET documentation entities i ## Methods -### GetIconForAccessibility +### GetIconForAccessibility Gets the icon for an Accessibility enum value. @@ -49,7 +47,7 @@ public static string GetIconForAccessibility(Microsoft.CodeAnalysis.Accessibilit Type: `string` The FontAwesome icon name. -### GetIconForAccessModifier +### GetIconForAccessModifier Gets the icon for an access modifier. @@ -70,7 +68,7 @@ public static string GetIconForAccessModifier(string accessModifier) Type: `string` The FontAwesome icon name. -### GetIconForAssembly +### GetIconForAssembly Gets the appropriate icon for a DocAssembly. @@ -91,7 +89,7 @@ public static string GetIconForAssembly(CloudNimble.DotNetDocs.Core.DocAssembly Type: `string` The FontAwesome icon name. -### GetIconForEntity +### GetIconForEntity Gets the appropriate icon for a DocEntity based on its type. @@ -112,7 +110,7 @@ public static string GetIconForEntity(CloudNimble.DotNetDocs.Core.DocEntity enti Type: `string` The FontAwesome icon name. -### GetIconForMember +### GetIconForMember Gets the icon for a DocMember based on its kind and characteristics. @@ -133,7 +131,7 @@ public static string GetIconForMember(CloudNimble.DotNetDocs.Core.DocMember memb Type: `string` The FontAwesome icon name. -### GetIconForMethod +### GetIconForMethod Gets the icon for a DocMember method, considering special characteristics. @@ -154,7 +152,7 @@ public static string GetIconForMethod(CloudNimble.DotNetDocs.Core.DocMember docM Type: `string` The FontAwesome icon name. -### GetIconForNamespace +### GetIconForNamespace Gets the icon for a DocNamespace based on whether it has types. @@ -175,7 +173,7 @@ public static string GetIconForNamespace(CloudNimble.DotNetDocs.Core.DocNamespac Type: `string` The FontAwesome icon name. -### GetIconForNamespaceSegment +### GetIconForNamespaceSegment Gets an icon based on the namespace segment for organization-specific icons. @@ -196,7 +194,7 @@ public static string GetIconForNamespaceSegment(string namespaceName) Type: `string` The FontAwesome icon name based on common patterns. -### GetIconForType +### GetIconForType Gets the icon for a DocType based on its kind and characteristics. @@ -217,7 +215,7 @@ public static string GetIconForType(CloudNimble.DotNetDocs.Core.DocType docType) Type: `string` The FontAwesome icon name. -### GetIconForTypeByName +### GetIconForTypeByName Gets an appropriate icon based on common type naming patterns. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer.mdx index e374acb..71344eb 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MintlifyRenderer', 'CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase', 'CloudNimble.DotNetDocs.Core.IDocRenderer'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Mintlify.dll @@ -33,7 +31,7 @@ Generates structured MDX documentation with Mintlify-specific features including ## Constructors -### .ctor +### .ctor Initializes a new instance of the [MintlifyRenderer](/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer) class. @@ -53,7 +51,7 @@ public MintlifyRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context, Micr ## Methods -### RenderAsync +### RenderAsync Renders the documentation assembly to MDX files with optional docs.json generation. @@ -67,14 +65,14 @@ public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAs | Name | Type | Description | |------|------|-------------| -| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly` | The documentation assembly to render. | +| `model` | `CloudNimble.DotNetDocs.Core.DocAssembly?` | The documentation assembly to render, or null for documentation-only mode. | #### Returns Type: `System.Threading.Tasks.Task` A task representing the asynchronous rendering operation. -### RenderPlaceholdersAsync +### RenderPlaceholdersAsync Renders placeholder conceptual content files for the documentation assembly. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions.mdx index 2c1bbf8..38d70f6 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MintlifyRendererOptions', 'CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Mintlify.dll @@ -27,7 +25,7 @@ Configuration options for the Mintlify documentation renderer. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Configuration options for the Mintlify documentation renderer. public MintlifyRendererOptions() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### GenerateDocsJson +### GenerateDocsJson Gets or sets whether to generate the docs.json navigation file. @@ -63,7 +61,7 @@ Type: `bool` True to generate docs.json alongside MDX files; otherwise, false. Default is true. -### GenerateNamespaceIndex +### GenerateNamespaceIndex Gets or sets whether to generate index files for namespaces. @@ -79,7 +77,7 @@ Type: `bool` True to generate index.mdx files for namespace documentation; otherwise, false. Default is true. -### IncludeIcons +### IncludeIcons Gets or sets whether to include icons in navigation and frontmatter. @@ -95,7 +93,7 @@ Type: `bool` True to include FontAwesome icons; otherwise, false. Default is true. -### NamespaceOrder +### NamespaceOrder Gets or sets the custom order for namespaces in navigation. @@ -111,7 +109,7 @@ Type: `System.Collections.Generic.List?` A list of namespace patterns in the desired order, or null for alphabetical ordering. Supports wildcards (e.g., "System.*" matches all System namespaces). -### Navigation +### Navigation Gets or sets the navigation configuration for DotNetDocs-specific properties. @@ -127,7 +125,7 @@ Type: `CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig` A DocsNavigationConfig instance that controls navigation mode, type, and name. Default is a new instance with Mode=Unified, Type=Pages, and Name=null. -### Template +### Template Gets or sets a custom template for the docs.json configuration. @@ -143,7 +141,7 @@ Type: `Mintlify.Core.Models.DocsJsonConfig?` A DocsJsonConfig instance to use as a template, or null to use defaults. The navigation section will be generated automatically. -### UnifiedGroupName +### UnifiedGroupName Gets or sets the group name used when NavigationMode is Unified. @@ -160,7 +158,7 @@ The name of the unified API reference group. Default is "API Reference". ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -180,7 +178,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -201,7 +199,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -215,7 +213,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -229,7 +227,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -243,7 +241,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -264,7 +262,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode.mdx index f582287..1a87f4f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['NavigationMode', 'CloudNimble.DotNetDocs.Mintlify.NavigationMode', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Mintlify.dll diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType.mdx index c70f33e..533ed10 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['NavigationType', 'CloudNimble.DotNetDocs.Mintlify.NavigationType', 'CloudNimble.DotNetDocs.Mintlify', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Mintlify.dll diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer.mdx index fe2232b..f76ab18 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MintlifyMarkdownTransformer', 'CloudNimble.DotNetDocs.Mintlify.Transformers.MintlifyMarkdownTransformer', 'CloudNimble.DotNetDocs.Mintlify.Transformers', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Core.IDocTransformer'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Mintlify.dll @@ -33,7 +31,7 @@ MDX (used by Mintlify) requires JSX-style comments {/* */} instead of HTML comme ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ MDX (used by Mintlify) requires JSX-style comments {/* */} instead of HTML comme public MintlifyMarkdownTransformer() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -73,7 +71,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -94,7 +92,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -108,7 +106,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -122,7 +120,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -136,7 +134,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -157,7 +155,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -171,7 +169,7 @@ public virtual string ToString() Type: `string?` -### TransformAsync +### TransformAsync Transforms a documentation entity by converting HTML comments to JSX comments. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/index.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/index.mdx index e8ba5ba..14231c3 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/index.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Mintlify/index.mdx @@ -3,7 +3,7 @@ title: Overview description: "Summary of the CloudNimble.DotNetDocs.Mintlify Namespace" icon: folder-tree mode: wide -keywords: ['CloudNimble.DotNetDocs.Mintlify', 'namespace', 'DocsNavigationConfig', 'MintlifyIcons', 'MintlifyRenderer', 'MintlifyRendererOptions', 'NavigationMode', 'NavigationType'] +keywords: ['CloudNimble.DotNetDocs.Mintlify', 'namespace', 'DocsNavigationConfig', 'MintlifyDocReferenceHandler', 'MintlifyIcons', 'MintlifyRenderer', 'MintlifyRendererOptions', 'NavigationMode', 'NavigationType'] --- ## Types @@ -13,6 +13,7 @@ keywords: ['CloudNimble.DotNetDocs.Mintlify', 'namespace', 'DocsNavigationConfig | Name | Summary | | ---- | ------- | | [DocsNavigationConfig](/api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig) | Configuration for DotNetDocs-specific navigation properties. | +| [MintlifyDocReferenceHandler](/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler) | Handles documentation references for Mintlify documentation format. | | [MintlifyIcons](/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons) | Provides FontAwesome 7 icon mappings for different .NET documentation entities in Mintlify. | | [MintlifyRenderer](/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer) | Renders documentation as MDX files with Mintlify frontmatter and navigation. | | [MintlifyRendererOptions](/api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions) | Configuration options for the Mintlify documentation renderer. | diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand.mdx index 87cd8e6..502d034 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['AddCommand', 'CloudNimble.DotNetDocs.Tools.Commands.AddCommand', 'CloudNimble.DotNetDocs.Tools.Commands', 'class', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tools.dll @@ -33,7 +31,7 @@ This command creates a .docsproj file configured for the specified documentation ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ This command creates a .docsproj file configured for the specified documentation public AddCommand() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -51,7 +49,7 @@ public AddCommand() public DocsCommandBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -63,7 +61,7 @@ public Object() ## Properties -### DocumentationType +### DocumentationType Gets or sets the documentation type for the project. @@ -77,7 +75,7 @@ public string DocumentationType { get; set; } Type: `string?` -### OutputDirectory +### OutputDirectory Gets or sets the output directory for the generated documentation project. @@ -91,7 +89,7 @@ public string OutputDirectory { get; set; } Type: `string?` -### ProjectName +### ProjectName Gets or sets the name of the documentation project. @@ -109,7 +107,21 @@ Type: `string?` If not specified, the project name defaults to the solution name. -### SolutionPath +### SkipSolution + +Gets or sets whether to skip adding the project to the solution file. + +#### Syntax + +```csharp +public bool SkipSolution { get; set; } +``` + +#### Property Value + +Type: `bool` + +### SolutionPath Gets or sets the path to the solution file (.sln or .slnx) to use. @@ -123,7 +135,7 @@ public string SolutionPath { get; set; } Type: `string?` -### UsePrerelease +### UsePrerelease Gets or sets whether to use the latest prerelease version of the DotNetDocs.Sdk. @@ -139,7 +151,7 @@ Type: `bool` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -159,7 +171,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -180,7 +192,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -194,7 +206,7 @@ public virtual int GetHashCode() Type: `int` -### GetLatestSdkVersionAsync +### GetLatestSdkVersionAsync Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -217,7 +229,7 @@ protected static System.Threading.Tasks.Task GetLatestSdkVersionAsync(bo Type: `System.Threading.Tasks.Task` The latest version string, or null if the query fails. -### GetType +### GetType Inherited Inherited from `object` @@ -231,7 +243,7 @@ public System.Type GetType() Type: `System.Type` -### GetVersion +### GetVersion Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -248,7 +260,7 @@ internal static string GetVersion() Type: `string` The version string. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -262,7 +274,7 @@ protected internal object MemberwiseClone() Type: `object` -### OnExecute +### OnExecute Executes the command to create and add a documentation project to the specified solution. @@ -291,7 +303,7 @@ If the solution file is not specified, the method attempts to locate one in the provided, in a default location based on the solution file. Any errors encountered during execution are reported to the console, and a nonzero exit code is returned. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -312,7 +324,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -326,7 +338,7 @@ public virtual string ToString() Type: `string?` -### WriteHeader +### WriteHeader Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase.mdx index fab8623..424e768 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocsCommandBase', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase', 'CloudNimble.DotNetDocs.Tools.Commands.Base', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tools.dll @@ -27,7 +25,7 @@ Base class for all DotNetDocs CLI commands, providing shared functionality like ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Base class for all DotNetDocs CLI commands, providing shared functionality like public DocsCommandBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -67,7 +65,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -88,7 +86,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -102,7 +100,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -116,7 +114,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -130,7 +128,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -151,7 +149,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual string ToString() Type: `string?` -### WriteHeader +### WriteHeader Writes the DotNetDocs CLI header to the console with colorful ASCII art and version information. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand.mdx index dc3e9bf..aaccf50 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['BuildCommand', 'CloudNimble.DotNetDocs.Tools.Commands.BuildCommand', 'CloudNimble.DotNetDocs.Tools.Commands', 'class', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tools.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tools.Commands.BuildCommand ## Constructors -### .ctor +### .ctor #### Syntax @@ -30,7 +28,7 @@ CloudNimble.DotNetDocs.Tools.Commands.BuildCommand public BuildCommand() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -40,7 +38,7 @@ public BuildCommand() public DocsCommandBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### ApiReferencePath +### ApiReferencePath #### Syntax @@ -64,7 +62,7 @@ public string ApiReferencePath { get; set; } Type: `string` -### AssemblyListFile +### AssemblyListFile #### Syntax @@ -76,7 +74,7 @@ public string AssemblyListFile { get; set; } Type: `string` -### DocumentationType +### DocumentationType #### Syntax @@ -88,7 +86,7 @@ public string DocumentationType { get; set; } Type: `string` -### NamespaceMode +### NamespaceMode #### Syntax @@ -100,7 +98,7 @@ public string NamespaceMode { get; set; } Type: `string` -### OutputPath +### OutputPath #### Syntax @@ -114,7 +112,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -134,7 +132,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -155,7 +153,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -169,7 +167,7 @@ public virtual int GetHashCode() Type: `int` -### GetLatestSdkVersionAsync +### GetLatestSdkVersionAsync Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -192,7 +190,7 @@ protected static System.Threading.Tasks.Task GetLatestSdkVersionAsync(bo Type: `System.Threading.Tasks.Task` The latest version string, or null if the query fails. -### GetType +### GetType Inherited Inherited from `object` @@ -206,7 +204,7 @@ public System.Type GetType() Type: `System.Type` -### GetVersion +### GetVersion Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -223,7 +221,7 @@ internal static string GetVersion() Type: `string` The version string. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -237,7 +235,7 @@ protected internal object MemberwiseClone() Type: `object` -### OnExecute +### OnExecute #### Syntax @@ -255,7 +253,7 @@ public System.Threading.Tasks.Task OnExecute(McMaster.Extensions.CommandLin Type: `System.Threading.Tasks.Task` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -276,7 +274,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -290,7 +288,7 @@ public virtual string ToString() Type: `string?` -### WriteHeader +### WriteHeader Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand.mdx index 8f62537..14be8b8 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocsRootCommand', 'CloudNimble.DotNetDocs.Tools.Commands.DocsRootCommand', 'CloudNimble.DotNetDocs.Tools.Commands', 'class', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tools.dll @@ -33,7 +31,7 @@ This command serves as the entry point for the DotNetDocs CLI and provides acces ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ This command serves as the entry point for the DotNetDocs CLI and provides acces public DocsRootCommand() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -51,7 +49,7 @@ public DocsRootCommand() public DocsCommandBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -63,7 +61,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -83,7 +81,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -104,7 +102,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -118,7 +116,7 @@ public virtual int GetHashCode() Type: `int` -### GetLatestSdkVersionAsync +### GetLatestSdkVersionAsync Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -141,7 +139,7 @@ protected static System.Threading.Tasks.Task GetLatestSdkVersionAsync(bo Type: `System.Threading.Tasks.Task` The latest version string, or null if the query fails. -### GetType +### GetType Inherited Inherited from `object` @@ -155,7 +153,7 @@ public System.Type GetType() Type: `System.Type` -### GetVersion +### GetVersion Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -172,7 +170,7 @@ internal static string GetVersion() Type: `string` The version string. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -186,7 +184,7 @@ protected internal object MemberwiseClone() Type: `object` -### OnExecute +### OnExecute Displays the help information for the specified command-line application. @@ -207,7 +205,7 @@ public int OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication Type: `int` Always returns 0 after displaying the help information. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -228,7 +226,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -242,7 +240,7 @@ public virtual string ToString() Type: `string?` -### WriteHeader +### WriteHeader Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand.mdx index cdf0c68..387c303 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['UpdateCommand', 'CloudNimble.DotNetDocs.Tools.Commands.UpdateCommand', 'CloudNimble.DotNetDocs.Tools.Commands', 'class', 'CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tools.dll @@ -32,7 +30,7 @@ This command searches for all .docsproj files in the current directory (and opti ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This command searches for all .docsproj files in the current directory (and opti public UpdateCommand() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -50,7 +48,7 @@ public UpdateCommand() public DocsCommandBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -62,7 +60,7 @@ public Object() ## Properties -### ProjectPath +### ProjectPath Gets or sets the project name or path to a specific .docsproj file to update. @@ -76,7 +74,7 @@ public string ProjectPath { get; set; } Type: `string?` -### Recursive +### Recursive Gets or sets whether to search recursively in subdirectories. @@ -90,7 +88,7 @@ public bool Recursive { get; set; } Type: `bool` -### UsePrerelease +### UsePrerelease Gets or sets whether to use the latest prerelease version of the DotNetDocs.Sdk. @@ -106,7 +104,7 @@ Type: `bool` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -126,7 +124,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -147,7 +145,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -161,7 +159,7 @@ public virtual int GetHashCode() Type: `int` -### GetLatestSdkVersionAsync +### GetLatestSdkVersionAsync Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -184,7 +182,7 @@ protected static System.Threading.Tasks.Task GetLatestSdkVersionAsync(bo Type: `System.Threading.Tasks.Task` The latest version string, or null if the query fails. -### GetType +### GetType Inherited Inherited from `object` @@ -198,7 +196,7 @@ public System.Type GetType() Type: `System.Type` -### GetVersion +### GetVersion Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` @@ -215,7 +213,7 @@ internal static string GetVersion() Type: `string` The version string. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -229,7 +227,7 @@ protected internal object MemberwiseClone() Type: `object` -### OnExecute +### OnExecute Executes the command to update .docsproj SDK references to the latest version from NuGet. @@ -258,7 +256,7 @@ If a specific project is not specified, the method searches for all .docsproj fi (e.g., "MyProject.Docs") or a file path (e.g., "MyProject.Docs.docsproj" or "path/to/MyProject.Docs.docsproj"). Any errors encountered during execution are reported to the console, and a nonzero exit code is returned. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -279,7 +277,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -293,7 +291,7 @@ public virtual string ToString() Type: `string?` -### WriteHeader +### WriteHeader Inherited Inherited from `CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion.mdx index e42b9a1..c13f82f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['NuGetVersion', 'CloudNimble.DotNetDocs.Tools.Models.NuGetVersion', 'CloudNimble.DotNetDocs.Tools.Models', 'class', 'System.Object', 'System.IComparable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tools.dll @@ -33,7 +31,7 @@ This class provides basic semantic versioning support with major, minor, patch, ## Constructors -### .ctor +### .ctor Initializes a new instance of the [NuGetVersion](/api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion) class from a version string. @@ -54,7 +52,7 @@ public NuGetVersion(string version) The version string should be in the format "major.minor.patch" or "major.minor.patch-prerelease". If any component cannot be parsed, it defaults to 0. -### .ctor +### .ctor Inherited Inherited from `object` @@ -66,7 +64,7 @@ public Object() ## Properties -### IsPrerelease +### IsPrerelease Gets a value indicating whether this version is a prerelease version. @@ -80,7 +78,7 @@ public bool IsPrerelease { get; } Type: `bool` -### Major +### Major Gets the major version component. @@ -94,7 +92,7 @@ public int Major { get; } Type: `int` -### Minor +### Minor Gets the minor version component. @@ -108,7 +106,7 @@ public int Minor { get; } Type: `int` -### Patch +### Patch Gets the patch version component. @@ -122,7 +120,7 @@ public int Patch { get; } Type: `int` -### Prerelease +### Prerelease Gets the prerelease label, if any. @@ -138,7 +136,7 @@ Type: `string?` ## Methods -### CompareTo +### CompareTo Compares the current version to another version. @@ -166,7 +164,7 @@ Version comparison follows semantic versioning rules. Stable versions are consid prerelease versions with the same major.minor.patch numbers. Prerelease versions are compared lexicographically by their prerelease labels. -### Equals +### Equals Override Determines whether the specified object is equal to the current version. @@ -187,7 +185,7 @@ public override bool Equals(object obj) Type: `bool` `true` if the specified object is equal to the current version; otherwise, `false`. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -207,7 +205,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -228,7 +226,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Override Returns a hash code for the current version. @@ -243,7 +241,7 @@ public override int GetHashCode() Type: `int` A hash code for the current version. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -257,7 +255,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -271,7 +269,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -285,7 +283,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -306,7 +304,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns a string representation of the version. @@ -321,7 +319,7 @@ public override string ToString() Type: `string` A string in the format "major.minor.patch" or "major.minor.patch-prerelease". -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Program.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Program.mdx index 53cc644..ca678cb 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Program.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/CloudNimble/DotNetDocs/Tools/Program.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['Program', 'CloudNimble.DotNetDocs.Tools.Program', 'CloudNimble.DotNetDocs.Tools', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tools.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tools.Program ## Constructors -### .ctor +### .ctor #### Syntax @@ -30,7 +28,7 @@ CloudNimble.DotNetDocs.Tools.Program public Program() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -42,7 +40,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -62,7 +60,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -83,7 +81,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -111,7 +109,7 @@ public System.Type GetType() Type: `System.Type` -### Main +### Main Initializes and runs the application using the specified command-line arguments. @@ -137,7 +135,7 @@ A task that represents the asynchronous operation. The task result contains the This method configures the application's host, sets the content root, and runs the command-line application asynchronously. It is typically used as the application's entry point. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -151,7 +149,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -172,7 +170,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Microsoft/Extensions/DependencyInjection/IServiceCollection.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Microsoft/Extensions/DependencyInjection/IServiceCollection.mdx index e2d2587..24713df 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Microsoft/Extensions/DependencyInjection/IServiceCollection.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Microsoft/Extensions/DependencyInjection/IServiceCollection.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['IServiceCollection', 'Microsoft.Extensions.DependencyInjection.IServiceCollection', 'Microsoft.Extensions.DependencyInjection', 'error'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Microsoft.Extensions.DependencyInjection.Abstractions.dll @@ -29,7 +27,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/microsoft.e ## Methods -### AddDocEnricher +### AddDocEnricher Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` @@ -67,7 +65,7 @@ services.AddDocEnricher<ConceptualContentEnricher>(); Registers the enricher as Scoped implementation of IDocEnricher. Enrichers add conceptual content to documentation entities. -### AddDocRenderer +### AddDocRenderer Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` @@ -104,7 +102,7 @@ services.AddDocRenderer<MyCustomRenderer>(); Registers the renderer as Scoped implementation of IDocRenderer. -### AddDocTransformer +### AddDocTransformer Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` @@ -142,7 +140,7 @@ services.AddDocTransformer<InheritDocTransformer>(); Registers the transformer as Scoped implementation of IDocTransformer. Transformers modify the documentation model before rendering. -### AddDotNetDocs +### AddDotNetDocs Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` @@ -184,7 +182,7 @@ This method registers: - All built-in renderers (Markdown, JSON, YAML) as Scoped - MarkdownXmlTransformer for processing XML documentation tags -### AddDotNetDocsCore +### AddDotNetDocsCore Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` @@ -225,7 +223,7 @@ Use this method when you want to manually register specific renderers. - ProjectContext as Singleton - DocumentationManager as Scoped -### AddDotNetDocsPipeline +### AddDotNetDocsPipeline Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` @@ -262,7 +260,7 @@ services.AddDotNetDocsPipeline(pipeline => }); ``` -### AddJsonRenderer +### AddJsonRenderer Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` @@ -300,7 +298,7 @@ services.AddJsonRenderer(options => Registers JsonRenderer as Scoped implementation of IDocRenderer. -### AddMarkdownRenderer +### AddMarkdownRenderer Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` @@ -325,10 +323,183 @@ The service collection for chaining. #### Remarks -Registers MarkdownRenderer as Scoped implementation of IDocRenderer. - Also registers MarkdownXmlTransformer to process XML documentation tags. -### AddYamlRenderer + +Registers the following services: + + + + +### AddMintlifyRenderer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions` + +Adds the Mintlify renderer to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyRenderer(); +``` + +#### Remarks + + + +This method registers: + + + + +### AddMintlifyRenderer Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions` + +Adds a custom Mintlify renderer implementation to the service collection. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyRenderer(Microsoft.Extensions.DependencyInjection.IServiceCollection services) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Type Parameters + +- `TRenderer` - The type of Mintlify renderer to add. + +#### Examples + +```csharp +services.AddMintlifyRenderer<CustomMintlifyRenderer>(); +``` + +#### Remarks + + + +Registers the custom renderer as Scoped implementation of IDocRenderer. + + + +The renderer must inherit from MintlifyRenderer. + + + +This method also registers: + + + + +### AddMintlifyServices Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions` + +Adds Mintlify documentation services including the renderer and DocsJsonManager. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyServices(Microsoft.Extensions.DependencyInjection.IServiceCollection services) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyServices(); +``` + +#### Remarks + + + +This method registers: + + + + +### AddMintlifyServices Extension + +Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsMintlify_IServiceCollectionExtensions` + +Adds Mintlify documentation services with configuration options. + +#### Syntax + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddMintlifyServices(Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action configureMintlify) +``` + +#### Parameters + +| Name | Type | Description | +|------|------|-------------| +| `services` | `Microsoft.Extensions.DependencyInjection.IServiceCollection` | The service collection. | +| `configureMintlify` | `System.Action` | Action to configure Mintlify options. | + +#### Returns + +Type: `Microsoft.Extensions.DependencyInjection.IServiceCollection` +The service collection for chaining. + +#### Examples + +```csharp +services.AddMintlifyServices(options => +{ + options.GenerateDocsJson = true; + options.IncludeIcons = true; +}); +``` + +#### Remarks + + + +This method registers: + + + + +### AddYamlRenderer Extension Extension method from `Microsoft.Extensions.DependencyInjection.DotNetDocsCore_IServiceCollectionExtensions` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ApiConfigConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ApiConfigConverter.mdx index 66a0468..f05d08d 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ApiConfigConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ApiConfigConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ApiConfigConverter', 'Mintlify.Core.Converters.ApiConfigConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -34,7 +32,7 @@ API configurations in Mintlify (OpenAPI and AsyncAPI) can be specified as: ## Constructors -### .ctor +### .ctor #### Syntax @@ -44,7 +42,7 @@ public ApiConfigConverter() ## Methods -### CanConvert +### CanConvert Override Determines whether the specified type can be converted by this converter. @@ -65,7 +63,7 @@ public override bool CanConvert(System.Type typeToConvert) Type: `bool` True if the type is ApiSpecConfig; otherwise, false. -### Read +### Read Override Reads and converts the JSON to an ApiSpecConfig object. @@ -94,7 +92,7 @@ An ApiSpecConfig for all supported API configuration formats. |-----------|-------------| | `JsonException` | Thrown when the JSON token type is not supported. | -### Write +### Write Override Writes the ApiSpecConfig object to JSON. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/BackgroundImageConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/BackgroundImageConverter.mdx index 1cdd54a..1ef6c82 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/BackgroundImageConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/BackgroundImageConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BackgroundImageConverter', 'Mintlify.Core.Converters.BackgroundImageConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Background image configurations in Mintlify can be specified as: ## Constructors -### .ctor +### .ctor #### Syntax @@ -43,7 +41,7 @@ public BackgroundImageConverter() ## Methods -### CanConvert +### CanConvert Override Determines whether the specified type can be converted by this converter. @@ -64,7 +62,7 @@ public override bool CanConvert(System.Type typeToConvert) Type: `bool` True if the type is BackgroundImageConfig; otherwise, false. -### Read +### Read Override Reads and converts the JSON to a BackgroundImageConfig object. @@ -93,7 +91,7 @@ A BackgroundImageConfig for both simple URLs and theme-specific configurations. |-----------|-------------| | `JsonException` | Thrown when the JSON token type is not supported. | -### Write +### Write Override Writes the BackgroundImageConfig object to JSON. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ColorConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ColorConverter.mdx index 7121f77..9a27fa5 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ColorConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ColorConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ColorConverter', 'Mintlify.Core.Converters.ColorConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Color configurations in Mintlify can be specified as: ## Constructors -### .ctor +### .ctor #### Syntax @@ -43,7 +41,7 @@ public ColorConverter() ## Methods -### CanConvert +### CanConvert Override Determines whether the specified type can be converted by this converter. @@ -64,7 +62,7 @@ public override bool CanConvert(System.Type typeToConvert) Type: `bool` True if the type is ColorConfig; otherwise, false. -### Read +### Read Override Reads and converts the JSON to a ColorConfig object. @@ -93,7 +91,7 @@ A ColorConfig object. |-----------|-------------| | `JsonException` | Thrown when the JSON token type is not supported. | -### Write +### Write Override Writes the ColorConfig object to JSON. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/IconConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/IconConverter.mdx index 6edfe27..9369b07 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/IconConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/IconConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['IconConverter', 'Mintlify.Core.Converters.IconConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Icons in Mintlify can be specified as: ## Constructors -### .ctor +### .ctor #### Syntax @@ -43,7 +41,7 @@ public IconConverter() ## Methods -### CanConvert +### CanConvert Override Determines whether the specified type can be converted by this converter. @@ -64,7 +62,7 @@ public override bool CanConvert(System.Type typeToConvert) Type: `bool` True if the type is IconConfig; otherwise, false. -### Read +### Read Override Reads and converts the JSON to an IconConfig object. @@ -93,7 +91,7 @@ An IconConfig for both simple icon names and complex icon configurations. |-----------|-------------| | `JsonException` | Thrown when the JSON token type is not supported. | -### Write +### Write Override Writes the IconConfig object to JSON. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationJsonConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationJsonConverter.mdx index 34dc4e4..ee15324 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationJsonConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationJsonConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['NavigationJsonConverter', 'Mintlify.Core.Converters.NavigationJsonConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -27,7 +25,7 @@ Custom JSON converter for navigation that outputs simple array format for Mintli ## Constructors -### .ctor +### .ctor #### Syntax @@ -37,7 +35,7 @@ public NavigationJsonConverter() ## Methods -### Read +### Read Override Reads navigation from JSON, supporting both array and object formats. @@ -59,7 +57,7 @@ public override Mintlify.Core.Models.NavigationConfig Read(ref System.Text.Json. Type: `Mintlify.Core.Models.NavigationConfig?` -### Write +### Write Override Writes navigation to JSON in the appropriate format for Mintlify compatibility. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationPageConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationPageConverter.mdx index c495c43..dffa61d 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationPageConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationPageConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['NavigationPageConverter', 'Mintlify.Core.Converters.NavigationPageConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This converter is used for polymorphic navigation page properties in Mintlify co ## Constructors -### .ctor +### .ctor #### Syntax @@ -42,7 +40,7 @@ public NavigationPageConverter() ## Methods -### CanConvert +### CanConvert Override Determines whether the specified type can be converted by this converter. @@ -63,7 +61,7 @@ public override bool CanConvert(System.Type typeToConvert) Type: `bool` True if the type is object; otherwise, false. -### Read +### Read Override Reads and converts the JSON to a navigation page object. @@ -92,7 +90,7 @@ A string for page paths or a GroupConfig for nested navigation groups. |-----------|-------------| | `JsonException` | Thrown when the JSON token type is not supported. | -### Write +### Write Override Writes the navigation page object to JSON. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationPageListConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationPageListConverter.mdx index 2ebe1a3..d032a67 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationPageListConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/NavigationPageListConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['NavigationPageListConverter', 'Mintlify.Core.Converters.NavigationPageListConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter>'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This converter uses a static NavigationPageConverter instance for efficient conv ## Constructors -### .ctor +### .ctor #### Syntax @@ -42,7 +40,7 @@ public NavigationPageListConverter() ## Methods -### Read +### Read Override Reads and converts the JSON array to a list of navigation page objects. @@ -71,7 +69,7 @@ A list containing string and GroupConfig objects. |-----------|-------------| | `JsonException` | Thrown when the JSON token is not a StartArray. | -### Write +### Write Override Writes the list of navigation page objects to JSON array. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter.mdx index 0ad79af..649ddcf 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/PrimaryNavigationConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['PrimaryNavigationConverter', 'Mintlify.Core.Converters.PrimaryNavigationConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Primary navigation in Mintlify NavbarConfig can be specified as: ## Constructors -### .ctor +### .ctor #### Syntax @@ -43,7 +41,7 @@ public PrimaryNavigationConverter() ## Methods -### CanConvert +### CanConvert Override Determines whether the specified type can be converted by this converter. @@ -64,7 +62,7 @@ public override bool CanConvert(System.Type typeToConvert) Type: `bool` True if the type is PrimaryNavigationConfig; otherwise, false. -### Read +### Read Override Reads and converts the JSON to a PrimaryNavigationConfig object. @@ -93,7 +91,7 @@ A PrimaryNavigationConfig object. |-----------|-------------| | `JsonException` | Thrown when the JSON token type is not supported. | -### Write +### Write Override Writes the PrimaryNavigationConfig object to JSON. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ServerConfigConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ServerConfigConverter.mdx index 584117d..efcc015 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ServerConfigConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Converters/ServerConfigConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ServerConfigConverter', 'Mintlify.Core.Converters.ServerConfigConverter', 'Mintlify.Core.Converters', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Server configurations in Mintlify can be specified as: ## Constructors -### .ctor +### .ctor #### Syntax @@ -43,7 +41,7 @@ public ServerConfigConverter() ## Methods -### CanConvert +### CanConvert Override Determines whether the specified type can be converted by this converter. @@ -64,7 +62,7 @@ public override bool CanConvert(System.Type typeToConvert) Type: `bool` True if the type is ServerConfig; otherwise, false. -### Read +### Read Override Reads and converts the JSON to a ServerConfig object. @@ -93,7 +91,7 @@ A ServerConfig for all supported server configuration formats. |-----------|-------------| | `JsonException` | Thrown when the JSON token type is not supported. | -### Write +### Write Override Writes the ServerConfig object to JSON. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/DocsJsonManager.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/DocsJsonManager.mdx index 98e93e6..43b6378 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/DocsJsonManager.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/DocsJsonManager.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocsJsonManager', 'Mintlify.Core.DocsJsonManager', 'Mintlify.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ This class provides comprehensive support for loading, validating, and modifying ## Constructors -### .ctor +### .ctor Initializes a new instance of the [DocsJsonManager](/api-reference/Mintlify/Core/DocsJsonManager) class. @@ -49,7 +47,7 @@ public DocsJsonManager(Mintlify.Core.DocsJsonValidator validator = null) |------|------|-------------| | `validator` | `Mintlify.Core.DocsJsonValidator?` | The validator to use for validating configurations. If null, a new instance will be created. | -### .ctor +### .ctor Initializes a new instance of the [DocsJsonManager](/api-reference/Mintlify/Core/DocsJsonManager) class with the specified file path. @@ -72,7 +70,7 @@ public DocsJsonManager(string filePath, Mintlify.Core.DocsJsonValidator validato |-----------|-------------| | `ArgumentException` | Thrown when the file path does not exist or is not a JSON file. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -84,7 +82,7 @@ public Object() ## Properties -### Configuration +### Configuration Gets the loaded Mintlify documentation configuration. @@ -100,7 +98,7 @@ Type: `Mintlify.Core.Models.DocsJsonConfig?` The [DocsJsonConfig](/api-reference/Mintlify/Core/Models/DocsJsonConfig) instance loaded from the file system or string content. Returns null if no configuration has been loaded or if loading failed. -### ConfigurationErrors +### ConfigurationErrors Gets the collection of configuration loading errors encountered during processing. @@ -116,7 +114,7 @@ Type: `System.Collections.Generic.List` A collection of [CompilerError](https://learn.microsoft.com/dotnet/api/system.codedom.compiler.compilererror) instances representing validation errors, parsing failures, or other issues encountered during configuration loading. -### FilePath +### FilePath Gets the file path of the loaded docs.json configuration file. @@ -132,7 +130,7 @@ Type: `string?` The full path to the docs.json file that was loaded. Returns null if the configuration was loaded from string content rather than a file. -### IsLoaded +### IsLoaded Gets a value indicating whether the configuration has been successfully loaded. @@ -149,7 +147,7 @@ True if the configuration was loaded without errors; otherwise, false. ## Methods -### AddNavigationItem +### AddNavigationItem Adds a navigation item (page or group) to the specified collection, tracking paths appropriately. @@ -171,7 +169,7 @@ public bool AddNavigationItem(System.Collections.Generic.List pages, obj Type: `bool` True if the item was added; false if it was skipped (duplicate). -### AddPage +### AddPage Adds a page to the navigation structure if it doesn't already exist. @@ -195,7 +193,7 @@ public bool AddPage(System.Collections.Generic.List pages, string pagePa Type: `bool` True if the page was added; false if it already existed and duplicates are not allowed. -### AddPage +### AddPage Adds a page to a hierarchical group path (slash-separated) in the navigation structure. @@ -224,7 +222,7 @@ True if the page was added; false if it already existed and duplicates are not a |-----------|-------------| | `InvalidOperationException` | Thrown when no configuration is loaded. | -### AddPageToGroup +### AddPageToGroup Adds a page to a group if it doesn't already exist. @@ -248,7 +246,7 @@ public bool AddPageToGroup(Mintlify.Core.Models.GroupConfig group, string pagePa Type: `bool` True if the page was added; false if it already existed and duplicates are not allowed. -### ApplyDefaults +### ApplyDefaults Applies default values to missing configuration properties. @@ -271,7 +269,7 @@ public void ApplyDefaults(string name = null, string theme = "mint") |-----------|-------------| | `InvalidOperationException` | Thrown when no configuration is loaded. | -### ApplyUrlPrefix +### ApplyUrlPrefix Applies a URL prefix to all page references in the navigation structure. @@ -300,7 +298,7 @@ This method recursively traverses the entire navigation structure and prepends t specified prefix to all page URLs, href attributes, and root paths. The prefix is normalized to ensure proper URL formatting (e.g., trailing slashes are handled). -### CreateDefault +### CreateDefault Creates a default Mintlify documentation configuration with basic structure. @@ -328,7 +326,7 @@ A new [DocsJsonConfig](/api-reference/Mintlify/Core/Models/DocsJsonConfig) insta |-----------|-------------| | `ArgumentException` | Thrown when name is null or whitespace. | -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -348,7 +346,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -369,7 +367,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### FindOrCreateGroup +### FindOrCreateGroup Finds or creates a group with the specified name in the pages collection. @@ -391,7 +389,7 @@ public Mintlify.Core.Models.GroupConfig FindOrCreateGroup(System.Collections.Gen Type: `Mintlify.Core.Models.GroupConfig` The existing or newly created group. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -405,7 +403,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -419,7 +417,7 @@ public System.Type GetType() Type: `System.Type` -### IsPathKnown +### IsPathKnown Checks if a page path is already known (tracked for duplicate prevention). @@ -440,7 +438,7 @@ public bool IsPathKnown(string pagePath) Type: `bool` True if the path is already known; otherwise, false. -### Load +### Load Loads and parses the docs.json file from the file path specified in the constructor. @@ -456,7 +454,7 @@ public void Load() |-----------|-------------| | `InvalidOperationException` | Thrown when no file path has been specified. | -### Load +### Load Loads and parses the docs.json configuration from the specified string content. @@ -478,7 +476,7 @@ public void Load(string content) |-----------|-------------| | `ArgumentException` | Thrown when content is null or whitespace. | -### Load +### Load Loads the specified configuration and applies validation and cleaning steps. @@ -500,7 +498,7 @@ This method replaces any existing configuration and clears previous configuratio errors. After loading, the configuration is validated and navigation groups are cleaned to ensure consistency. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -514,7 +512,7 @@ protected internal object MemberwiseClone() Type: `object` -### Merge +### Merge Merges another docs.json configuration into the current configuration. @@ -544,7 +542,7 @@ public void Merge(Mintlify.Core.Models.DocsJsonConfig other, bool combineBasePro This method performs a shallow merge, with the other configuration taking precedence for non-null values. Navigation structures are combined intelligently. -### MergeNavigation +### MergeNavigation Merges navigation from another NavigationConfig into the current configuration's navigation. @@ -574,7 +572,7 @@ This method intelligently merges navigation structures, combining groups with th and deduplicating page references. Use the MergeOptions parameter to control specific behaviors like how empty groups are handled. -### MergeNavigation +### MergeNavigation Merges navigation from an existing docs.json file into the current configuration. @@ -605,7 +603,7 @@ This method loads navigation from an external docs.json file and merges it into current configuration. Only the navigation structure is merged; other configuration properties are not affected. -### PopulateNavigationFromPath +### PopulateNavigationFromPath Populates the navigation structure from a directory path by scanning for MDX files. @@ -649,7 +647,7 @@ The method preserves the directory structure in the navigation while applying th -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -670,7 +668,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### Save +### Save Saves the current configuration to the file system using the original file path. @@ -686,7 +684,7 @@ public void Save() |-----------|-------------| | `InvalidOperationException` | Thrown when no configuration is loaded or no file path is specified. | -### Save +### Save Saves the current configuration to the specified file path. @@ -709,7 +707,7 @@ public void Save(string filePath) | `ArgumentException` | Thrown when filePath is null or whitespace. | | `InvalidOperationException` | Thrown when no configuration is loaded. | -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/DocsJsonValidator.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/DocsJsonValidator.mdx index a7c1cd6..229e6ba 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/DocsJsonValidator.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/DocsJsonValidator.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocsJsonValidator', 'Mintlify.Core.DocsJsonValidator', 'Mintlify.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This class provides comprehensive validation of the docs.json configuration to e ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class provides comprehensive validation of the docs.json configuration to e public DocsJsonValidator() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -72,7 +70,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -93,7 +91,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -107,7 +105,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -121,7 +119,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -135,7 +133,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -156,7 +154,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -170,7 +168,7 @@ public virtual string ToString() Type: `string?` -### Validate +### Validate Validates a docs.json configuration against the Mintlify schema. @@ -191,7 +189,7 @@ public System.Collections.Generic.List Validate(Mintlify.Core.Models.Doc Type: `System.Collections.Generic.List` A list of validation errors. Empty if configuration is valid. -### ValidateApi +### ValidateApi Validates the API configuration. @@ -208,7 +206,7 @@ public void ValidateApi(Mintlify.Core.Models.DocsJsonConfig config, System.Colle | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateAppearance +### ValidateAppearance Validates the appearance configuration. @@ -225,7 +223,7 @@ public void ValidateAppearance(Mintlify.Core.Models.DocsJsonConfig config, Syste | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateColors +### ValidateColors Validates the color configuration. @@ -242,7 +240,7 @@ public void ValidateColors(Mintlify.Core.Models.DocsJsonConfig config, System.Co | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateGroups +### ValidateGroups Validates group configurations in navigation. @@ -259,7 +257,7 @@ public void ValidateGroups(Mintlify.Core.Models.DocsJsonConfig config, System.Co | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateIcons +### ValidateIcons Validates the icons configuration. @@ -276,7 +274,7 @@ public void ValidateIcons(Mintlify.Core.Models.DocsJsonConfig config, System.Col | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateLogo +### ValidateLogo Validates the logo configuration. @@ -293,7 +291,7 @@ public void ValidateLogo(Mintlify.Core.Models.DocsJsonConfig config, System.Coll | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateNavigation +### ValidateNavigation Validates the navigation configuration. @@ -310,7 +308,7 @@ public void ValidateNavigation(Mintlify.Core.Models.DocsJsonConfig config, Syste | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateRequired +### ValidateRequired Validates that the configuration has all required properties. @@ -327,7 +325,7 @@ public void ValidateRequired(Mintlify.Core.Models.DocsJsonConfig config, System. | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateSeo +### ValidateSeo Validates the SEO configuration. @@ -344,7 +342,7 @@ public void ValidateSeo(Mintlify.Core.Models.DocsJsonConfig config, System.Colle | `config` | `Mintlify.Core.Models.DocsJsonConfig` | The configuration to validate. | | `errors` | `System.Collections.Generic.List` | The list to add errors to. | -### ValidateTheme +### ValidateTheme Validates the theme configuration. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/MintlifyConstants.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/MintlifyConstants.mdx index 212da7d..0354c0f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/MintlifyConstants.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/MintlifyConstants.mdx @@ -6,8 +6,6 @@ tag: "STATIC" keywords: ['MintlifyConstants', 'Mintlify.Core.MintlifyConstants', 'Mintlify.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -28,7 +26,7 @@ Contains constants and shared configuration objects for Mintlify documentation g ## Properties -### JsonSerializerOptions +### JsonSerializerOptions Gets the shared JsonSerializerOptions instance for consistent Mintlify JSON serialization. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/MintlifyOptions.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/MintlifyOptions.mdx index 41e77f2..eb509af 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/MintlifyOptions.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/MintlifyOptions.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MintlifyOptions', 'Mintlify.Core.MintlifyOptions', 'Mintlify.Core', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This class contains all the configuration settings that control how the Mintlify ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class contains all the configuration settings that control how the Mintlify public MintlifyOptions() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### AppearanceDefault +### AppearanceDefault Gets or sets the default appearance mode (system, light, dark). @@ -66,7 +64,7 @@ public string AppearanceDefault { get; set; } Type: `string` -### AppearanceStrict +### AppearanceStrict Gets or sets whether to hide the light/dark mode toggle. @@ -80,7 +78,7 @@ public bool AppearanceStrict { get; set; } Type: `bool` -### BaseUrl +### BaseUrl Gets or sets the base URL for cross-references to external documentation. @@ -94,7 +92,7 @@ public string BaseUrl { get; set; } Type: `string` -### Clean +### Clean Gets or sets whether to clean the output directory before generating. @@ -108,7 +106,7 @@ public bool Clean { get; set; } Type: `bool` -### ConfigOnly +### ConfigOnly Gets or sets whether to only generate the docs.json file without MDX files. @@ -122,7 +120,7 @@ public bool ConfigOnly { get; set; } Type: `bool` -### FaviconDark +### FaviconDark Gets or sets the dark mode favicon path. @@ -136,7 +134,7 @@ public string FaviconDark { get; set; } Type: `string?` -### FaviconLight +### FaviconLight Gets or sets the favicon path or light mode favicon. @@ -150,7 +148,7 @@ public string FaviconLight { get; set; } Type: `string` -### ForceBuild +### ForceBuild Gets or sets whether to force a rebuild instead of using existing binaries. @@ -170,7 +168,7 @@ When false (default), DocFX will attempt to use existing compiled assemblies for faster documentation generation. When true, forces a complete rebuild which may be slower but ensures all dependencies are up to date. -### GenerateConfig +### GenerateConfig Gets or sets whether to generate a docs.json configuration file. @@ -184,7 +182,7 @@ public bool GenerateConfig { get; set; } Type: `bool` -### GenerateNavigationFiles +### GenerateNavigationFiles Gets or sets whether to generate navigation.json files in non-api-reference folders. @@ -204,7 +202,7 @@ When true, the generator will create navigation.json files in directories that d already have them, preserving the auto-discovered navigation structure. This allows users to customize navigation later without losing their changes during regeneration. -### GitHubUrl +### GitHubUrl Gets or sets the GitHub URL for footer social links. @@ -218,7 +216,7 @@ public string GitHubUrl { get; set; } Type: `string` -### IconLibrary +### IconLibrary Gets or sets the icon library to use (fontawesome, lucide). @@ -232,7 +230,7 @@ public string IconLibrary { get; set; } Type: `string` -### IncludeExamples +### IncludeExamples Gets or sets whether to include code examples in the generated documentation. @@ -246,7 +244,7 @@ public bool IncludeExamples { get; set; } Type: `bool` -### IncludeInheritance +### IncludeInheritance Gets or sets whether to include inheritance information. @@ -260,7 +258,7 @@ public bool IncludeInheritance { get; set; } Type: `bool` -### IncludeInternal +### IncludeInternal Gets or sets whether to include internal members in the documentation. @@ -274,7 +272,7 @@ public bool IncludeInternal { get; set; } Type: `bool` -### IncludeSeeAlso +### IncludeSeeAlso Gets or sets whether to include see also references. @@ -288,7 +286,7 @@ public bool IncludeSeeAlso { get; set; } Type: `bool` -### LogoDark +### LogoDark Gets or sets the path to the dark logo file. @@ -302,7 +300,7 @@ public string LogoDark { get; set; } Type: `string` -### LogoHref +### LogoHref Gets or sets the URL to redirect to when clicking the logo. @@ -316,7 +314,7 @@ public string LogoHref { get; set; } Type: `string?` -### LogoLight +### LogoLight Gets or sets the path to the light logo file. @@ -330,7 +328,7 @@ public string LogoLight { get; set; } Type: `string` -### MaxDepth +### MaxDepth Gets or sets the maximum depth for nested type documentation. @@ -344,7 +342,7 @@ public int MaxDepth { get; set; } Type: `int` -### NamespaceFilter +### NamespaceFilter Gets or sets the namespace filter regex pattern. Only namespaces matching this pattern will be included. @@ -359,7 +357,7 @@ public string NamespaceFilter { get; set; } Type: `string?` -### OutputDirectory +### OutputDirectory Gets or sets the output directory for generated documentation. @@ -373,7 +371,7 @@ public string OutputDirectory { get; set; } Type: `string` -### PreserveExistingConfig +### PreserveExistingConfig Gets or sets whether to preserve existing docs.json configuration when updating. @@ -394,7 +392,7 @@ When true (default), the generator will read any existing docs.json file and mer navigation, styling, integrations, and other settings. When false, the generator will completely replace the docs.json file with new configuration. -### PrimaryColor +### PrimaryColor Gets or sets the primary color for the documentation theme. @@ -408,7 +406,7 @@ public string PrimaryColor { get; set; } Type: `string` -### PrimaryDarkColor +### PrimaryDarkColor Gets or sets the primary color for dark mode. @@ -422,7 +420,7 @@ public string PrimaryDarkColor { get; set; } Type: `string` -### SearchPrompt +### SearchPrompt Gets or sets the search prompt text. @@ -436,7 +434,7 @@ public string SearchPrompt { get; set; } Type: `string?` -### SeoIndexing +### SeoIndexing Gets or sets the SEO indexing mode (navigable, all). @@ -450,7 +448,7 @@ public string SeoIndexing { get; set; } Type: `string` -### SiteDescription +### SiteDescription Gets or sets the description of the documentation site. @@ -464,7 +462,7 @@ public string SiteDescription { get; set; } Type: `string` -### SiteName +### SiteName Gets or sets the name of the documentation site. @@ -478,7 +476,7 @@ public string SiteName { get; set; } Type: `string` -### SolutionNamePrefix +### SolutionNamePrefix Gets or sets the solution name prefix to strip from project names when generating paths. @@ -498,7 +496,7 @@ For example, if the solution is "CloudNimble.Breakdance" and projects are named "CloudNimble.Breakdance.AspNetCore", the output path will be "/aspnetcore/" instead of "/cloudnimble-breakdance-aspnetcore/". -### StripBackticksAroundLinks +### StripBackticksAroundLinks Gets or sets whether to strip backticks around parameter and return value links. @@ -518,7 +516,7 @@ When true (default), removes backticks around markdown links in parameter descri and return value documentation to ensure proper link rendering in Mintlify. This fixes the issue where links inside code formatting don't render correctly. -### Theme +### Theme Gets or sets the theme for the documentation site. @@ -532,7 +530,7 @@ public string Theme { get; set; } Type: `string` -### TypeFilter +### TypeFilter Gets or sets the type filter regex pattern. Only types matching this pattern will be included. @@ -547,7 +545,7 @@ public string TypeFilter { get; set; } Type: `string?` -### Verbose +### Verbose Gets or sets whether to enable verbose output during generation. @@ -561,7 +559,7 @@ public bool Verbose { get; set; } Type: `bool` -### WebsiteUrl +### WebsiteUrl Gets or sets the website URL for footer social links. @@ -577,7 +575,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -597,7 +595,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -618,7 +616,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -632,7 +630,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -646,7 +644,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -660,7 +658,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -681,7 +679,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -695,7 +693,7 @@ public virtual string ToString() Type: `string?` -### Validate +### Validate Validates the options and throws an exception if any are invalid. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/AnchorConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/AnchorConfig.mdx index de3a0af..8df5955 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/AnchorConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/AnchorConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['AnchorConfig', 'Mintlify.Core.Models.AnchorConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationSectionBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -31,7 +29,7 @@ Anchors provide navigation links in your documentation. The anchor name is requi ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ Anchors provide navigation links in your documentation. The anchor name is requi public AnchorConfig() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -49,7 +47,7 @@ public AnchorConfig() protected NavigationSectionBase() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -59,7 +57,7 @@ protected NavigationSectionBase() protected NavigationContainerBase() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -69,7 +67,7 @@ protected NavigationContainerBase() protected NavigationItemBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -81,7 +79,7 @@ public Object() ## Properties -### Anchor +### Anchor Gets or sets the name of the anchor. @@ -99,7 +97,7 @@ Type: `string` This is a required field that appears as the anchor label. -### AsyncApi +### AsyncApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -120,7 +118,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Color +### Color Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -140,7 +138,7 @@ Type: `Mintlify.Core.Models.ColorPairConfig?` Defines the primary and secondary colors used for this section's visual styling. -### Description +### Description Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -160,7 +158,7 @@ Type: `string?` Provides additional descriptive text about this navigation section. -### Dropdowns +### Dropdowns Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -180,7 +178,7 @@ Type: `System.Collections.Generic.List?` Dropdowns create expandable menu sections within this navigation section. -### Global +### Global Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -200,7 +198,7 @@ Type: `Mintlify.Core.Models.GlobalNavigationConfig?` Global navigation items persist across different tabs and pages for consistent navigation. -### Groups +### Groups Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -220,7 +218,7 @@ Type: `System.Collections.Generic.List?` Groups organize pages into labeled sections within this navigation container. -### Hidden +### Hidden Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -240,7 +238,7 @@ Type: `System.Nullable?` When true, this navigation item will not be displayed in the navigation by default. -### Href +### Href Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -260,7 +258,7 @@ Type: `string?` Can be used to link to an external URL or specify a path for this container. -### Icon +### Icon Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -281,7 +279,7 @@ Type: `Mintlify.Core.Models.IconConfig?` Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project. -### Languages +### Languages Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -301,7 +299,7 @@ Type: `System.Collections.Generic.List?` Allows partitioning navigation into different language-specific versions. -### OpenApi +### OpenApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -322,7 +320,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Pages +### Pages Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -342,7 +340,7 @@ Type: `System.Collections.Generic.List?` Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. -### Tabs +### Tabs Gets or sets the tabs for the anchor. @@ -360,7 +358,7 @@ Type: `System.Collections.Generic.List?` Allows creating multiple tabs within an anchor section. -### Versions +### Versions Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -382,7 +380,7 @@ Allows partitioning navigation into different version-specific documentation. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -402,7 +400,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -423,7 +421,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -437,7 +435,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -451,7 +449,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -465,7 +463,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -486,7 +484,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiConfig.mdx index c86d64a..56b4491 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ApiConfig', 'Mintlify.Core.Models.ApiConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls how API documentation is displayed and how the API p ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls how API documentation is displayed and how the API p public ApiConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### AsyncApi +### AsyncApi Gets or sets the AsyncAPI specification configuration. @@ -71,7 +69,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Examples +### Examples Gets or sets the configuration for autogenerated API examples. @@ -90,7 +88,7 @@ Type: `Mintlify.Core.Models.ApiExamplesConfig?` Controls which programming languages are shown in code examples and whether optional parameters are included in the generated examples. -### Mdx +### Mdx Gets or sets the MDX configuration for API pages generated from MDX files. @@ -109,7 +107,7 @@ Type: `Mintlify.Core.Models.MdxConfig?` Allows manual definition of API endpoints in individual MDX files rather than using an OpenAPI specification. Useful for small APIs or prototyping. -### OpenApi +### OpenApi Gets or sets the OpenAPI specification configuration. @@ -128,7 +126,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Params +### Params Gets or sets the display settings for API parameters. @@ -147,7 +145,7 @@ Type: `Mintlify.Core.Models.ApiParamsConfig?` Controls how API parameters are displayed in the documentation, including whether they are expanded by default. -### Playground +### Playground Gets or sets the API playground settings. @@ -166,7 +164,7 @@ Type: `Mintlify.Core.Models.ApiPlaygroundConfig?` Controls the display mode of the API playground and whether requests are proxied through Mintlify's servers for CORS handling. -### Proxy +### Proxy Gets or sets whether to pass API requests through a proxy server. @@ -189,7 +187,7 @@ When true, API requests from the playground are routed through Mintlify's ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -209,7 +207,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -230,7 +228,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -244,7 +242,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -258,7 +256,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -272,7 +270,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -293,7 +291,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiExamplesConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiExamplesConfig.mdx index 686550b..ce557c7 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiExamplesConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiExamplesConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ApiExamplesConfig', 'Mintlify.Core.Models.ApiExamplesConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Controls which programming languages are shown in code examples and whether ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Controls which programming languages are shown in code examples and whether public ApiExamplesConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Defaults +### Defaults Gets or sets whether to show optional parameters in API examples. @@ -81,7 +79,7 @@ Valid values are: - "required": Show only required parameters Defaults to "all" when not specified. -### Languages +### Languages Gets or sets the programming languages for autogenerated API snippets. @@ -109,7 +107,7 @@ Specifies which programming languages should be included in the automatically generated code examples. Common values include: "javascript", "python", "curl", "go", "java", "php", "ruby", etc. -### Prefill +### Prefill Gets or sets whether to prefill the API playground with data from schema examples. @@ -140,7 +138,7 @@ When enabled, the playground automatically populates request fields with example ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -160,7 +158,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -209,7 +207,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -223,7 +221,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -244,7 +242,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiParamsConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiParamsConfig.mdx index 6759df4..fe6be46 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiParamsConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiParamsConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ApiParamsConfig', 'Mintlify.Core.Models.ApiParamsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Controls how API parameters are displayed in the interactive playground ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Controls how API parameters are displayed in the interactive playground public ApiParamsConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Expanded +### Expanded Gets or sets whether to expand all parameters by default. @@ -82,7 +80,7 @@ When true, all API parameters will be displayed in an expanded state. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -102,7 +100,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -123,7 +121,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -137,7 +135,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -151,7 +149,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -165,7 +163,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -186,7 +184,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig.mdx index 1a4611d..f039d79 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiPlaygroundConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ApiPlaygroundConfig', 'Mintlify.Core.Models.ApiPlaygroundConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Controls how the API playground is displayed and whether API requests ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Controls how the API playground is displayed and whether API requests public ApiPlaygroundConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Display +### Display Gets or sets the display mode of the API playground. @@ -82,7 +80,7 @@ Valid values are: - "none": Hide the playground completely Defaults to "interactive" when not specified. -### Proxy +### Proxy Gets or sets whether to pass API requests through a proxy server. @@ -113,7 +111,7 @@ When true, API requests from the playground are routed through Mintlify's ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -133,7 +131,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -154,7 +152,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -168,7 +166,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -182,7 +180,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -196,7 +194,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -217,7 +215,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiSpecConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiSpecConfig.mdx index c926df2..a3d5fac 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiSpecConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ApiSpecConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ApiSpecConfig', 'Mintlify.Core.Models.ApiSpecConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ API specifications can be specified as simple URLs, multiple URLs, or detailed c ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ API specifications can be specified as simple URLs, multiple URLs, or detailed c public ApiSpecConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Directory +### Directory Gets or sets the directory path for API specifications. @@ -71,7 +69,7 @@ Type: `string?` Specifies a directory containing API specification files. Used in conjunction with Source for complex configurations. -### Source +### Source Gets or sets the source URL or path for API specifications. @@ -89,7 +87,7 @@ Type: `string?` Can be an absolute URL or relative path to an API specification file. -### Urls +### Urls Gets or sets the list of URLs when multiple specifications are provided. @@ -110,7 +108,7 @@ Used internally when the API config represents multiple URL strings. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -151,7 +149,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -179,7 +177,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -193,7 +191,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -214,7 +212,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the API specification configuration. @@ -229,7 +227,7 @@ public override string ToString() Type: `string` The source URL, first URL, or empty string. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/AppearanceConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/AppearanceConfig.mdx index fa36a86..7900d38 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/AppearanceConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/AppearanceConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['AppearanceConfig', 'Mintlify.Core.Models.AppearanceConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls the default appearance mode and whether users can to ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls the default appearance mode and whether users can to public AppearanceConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Default +### Default Gets or sets the default light/dark mode for the documentation site. @@ -71,7 +69,7 @@ Type: `string?` Valid values are "system" (follows user's system preference), "light", or "dark". Defaults to "system" if not specified. -### Strict +### Strict Gets or sets whether to hide the light/dark mode toggle from users. @@ -92,7 +90,7 @@ When set to true, users will not be able to switch between light and dark modes, ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -112,7 +110,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -133,7 +131,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -147,7 +145,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -161,7 +159,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -175,7 +173,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -196,7 +194,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BackgroundConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BackgroundConfig.mdx index bfc04d5..2071746 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BackgroundConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BackgroundConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BackgroundConfig', 'Mintlify.Core.Models.BackgroundConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls the background appearance including images, decorati ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls the background appearance including images, decorati public BackgroundConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Color +### Color Gets or sets the background color configuration. @@ -71,7 +69,7 @@ Type: `Mintlify.Core.Models.ColorConfig?` Can be a hex color string or an object with color configuration properties. This controls the base background color of the documentation site. -### Decoration +### Decoration Gets or sets the background decoration style. @@ -90,7 +88,7 @@ Type: `string?` Valid values are "gradient", "grid", or "windows". This adds decorative background patterns to enhance the visual appearance of the site. -### Image +### Image Gets or sets the background image configuration. @@ -112,7 +110,7 @@ Can be a string URL for a single image, or an object with "light" and "dark" ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -153,7 +151,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -167,7 +165,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -181,7 +179,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -195,7 +193,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -216,7 +214,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BackgroundImageConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BackgroundImageConfig.mdx index c260abe..833cbbf 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BackgroundImageConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BackgroundImageConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BackgroundImageConfig', 'Mintlify.Core.Models.BackgroundImageConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Background images can be simple URL/path references or theme-specific configurat ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Background images can be simple URL/path references or theme-specific configurat public BackgroundImageConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Dark +### Dark Gets or sets the background image for dark mode. @@ -71,7 +69,7 @@ Type: `string?` Can be an absolute URL or relative path to an image file. Used when the theme switches to dark mode. -### Light +### Light Gets or sets the background image for light mode. @@ -90,7 +88,7 @@ Type: `string?` Can be an absolute URL or relative path to an image file. Used when the theme is in light mode. -### Url +### Url Gets or sets the single image URL when not using theme-specific images. @@ -111,7 +109,7 @@ Used internally when the background image is a simple string. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -131,7 +129,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -152,7 +150,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -166,7 +164,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -180,7 +178,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -194,7 +192,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -215,7 +213,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the background image configuration. @@ -230,7 +228,7 @@ public override string ToString() Type: `string` The URL, light image, dark image, or empty string. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BannerConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BannerConfig.mdx index 6fe0908..9bc193c 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BannerConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/BannerConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BannerConfig', 'Mintlify.Core.Models.BannerConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration allows you to display a banner at the top of your documentati ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration allows you to display a banner at the top of your documentati public BannerConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Content +### Content Gets or sets the content to display in the banner. @@ -72,7 +70,7 @@ The text or MDX content that will be displayed in the banner. MDX formatting is supported, allowing for rich content including links, emphasis, and other formatting. This content should be concise but informative. -### Dismissible +### Dismissible Gets or sets whether to show a dismiss button on the banner. @@ -94,7 +92,7 @@ When true, displays a dismiss button (X) on the right side of the banner, ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -114,7 +112,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -135,7 +133,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -149,7 +147,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -163,7 +161,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -177,7 +175,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -198,7 +196,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorConfig.mdx index e2d4ba4..835a48a 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ColorConfig', 'Mintlify.Core.Models.ColorConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -28,7 +26,7 @@ Represents a color configuration for Mintlify. ## Constructors -### .ctor +### .ctor Initializes a new instance of the [ColorConfig](/api-reference/Mintlify/Core/Models/ColorConfig) class. @@ -38,7 +36,7 @@ Initializes a new instance of the [ColorConfig](/api-reference/Mintlify/Core/Mod public ColorConfig() ``` -### .ctor +### .ctor Initializes a new instance of the [ColorConfig](/api-reference/Mintlify/Core/Models/ColorConfig) class with a single color. @@ -54,7 +52,7 @@ public ColorConfig(string color) |------|------|-------------| | `color` | `string?` | The hex color string for both light and dark modes. | -### .ctor +### .ctor Initializes a new instance of the [ColorConfig](/api-reference/Mintlify/Core/Models/ColorConfig) class with separate light and dark colors. @@ -71,7 +69,7 @@ public ColorConfig(string light, string dark) | `light` | `string?` | The hex color string for light mode. | | `dark` | `string?` | The hex color string for dark mode. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -83,7 +81,7 @@ public Object() ## Properties -### Dark +### Dark Gets or sets the color in hex format to use in dark mode. @@ -97,7 +95,7 @@ public string Dark { get; set; } Type: `string?` -### Light +### Light Gets or sets the color in hex format to use in light mode. @@ -113,7 +111,7 @@ Type: `string?` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -133,7 +131,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -154,7 +152,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -168,7 +166,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -182,7 +180,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -196,7 +194,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -217,7 +215,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the color configuration. @@ -232,7 +230,7 @@ public override string ToString() Type: `string` The light color, dark color, or empty string. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorPairConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorPairConfig.mdx index 7923b9a..4c4fb1e 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorPairConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorPairConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ColorPairConfig', 'Mintlify.Core.Models.ColorPairConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -27,7 +25,7 @@ Represents a color pair configuration for light and dark modes. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Represents a color pair configuration for light and dark modes. public ColorPairConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Dark +### Dark Gets or sets the color in hex format to use in dark mode. @@ -61,7 +59,7 @@ public string Dark { get; set; } Type: `string?` -### Light +### Light Gets or sets the color in hex format to use in light mode. @@ -77,7 +75,7 @@ Type: `string?` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the color pair configuration. @@ -196,7 +194,7 @@ public override string ToString() Type: `string` The light color, dark color, or empty string. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorsConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorsConfig.mdx index e8d0a38..2b72902 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorsConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ColorsConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ColorsConfig', 'Mintlify.Core.Models.ColorsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -31,7 +29,7 @@ The colors to use in your documentation. At the very least, you must define the ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ The colors to use in your documentation. At the very least, you must define the public ColorsConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### Dark +### Dark Gets or sets the dark color of the theme in hex format. Used for light mode. @@ -65,7 +63,7 @@ public string Dark { get; set; } Type: `string?` -### Light +### Light Gets or sets the light color of the theme in hex format. Used for dark mode. @@ -79,7 +77,7 @@ public string Light { get; set; } Type: `string?` -### Primary +### Primary Gets or sets the primary color of the theme in hex format. @@ -99,7 +97,7 @@ This is a required field. Must be a valid hex color in format #RRGGBB or #RGB. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -119,7 +117,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -140,7 +138,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -154,7 +152,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -168,7 +166,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -182,7 +180,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -203,7 +201,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ContextualConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ContextualConfig.mdx index 710a322..d011703 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ContextualConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ContextualConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ContextualConfig', 'Mintlify.Core.Models.ContextualConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls the contextual options that appear in the documentat ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls the contextual options that appear in the documentat public ContextualConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Options +### Options Gets or sets the list of contextual options to enable. @@ -81,7 +79,7 @@ Valid options include: ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -101,7 +99,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -122,7 +120,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -136,7 +134,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -150,7 +148,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -164,7 +162,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -185,7 +183,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/DocsJsonConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/DocsJsonConfig.mdx index 17e2c4e..5d33bc8 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/DocsJsonConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/DocsJsonConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DocsJsonConfig', 'Mintlify.Core.Models.DocsJsonConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This class represents the complete structure of a Mintlify docs.json configurati ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class represents the complete structure of a Mintlify docs.json configurati public DocsJsonConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Api +### Api Gets or sets the API reference configuration. @@ -66,7 +64,7 @@ public Mintlify.Core.Models.ApiConfig Api { get; set; } Type: `Mintlify.Core.Models.ApiConfig?` -### Appearance +### Appearance Gets or sets the appearance configuration. @@ -80,7 +78,7 @@ public Mintlify.Core.Models.AppearanceConfig Appearance { get; set; } Type: `Mintlify.Core.Models.AppearanceConfig?` -### Background +### Background Gets or sets the background configuration. @@ -94,7 +92,7 @@ public Mintlify.Core.Models.BackgroundConfig Background { get; set; } Type: `Mintlify.Core.Models.BackgroundConfig?` -### Banner +### Banner Gets or sets the banner configuration. @@ -108,7 +106,7 @@ public Mintlify.Core.Models.BannerConfig Banner { get; set; } Type: `Mintlify.Core.Models.BannerConfig?` -### Colors +### Colors Gets or sets the color configuration. @@ -126,7 +124,7 @@ Type: `Mintlify.Core.Models.ColorsConfig` This is a required field. At minimum, the primary color must be defined. -### Contextual +### Contextual Gets or sets the contextual options configuration. @@ -140,7 +138,7 @@ public Mintlify.Core.Models.ContextualConfig Contextual { get; set; } Type: `Mintlify.Core.Models.ContextualConfig?` -### Description +### Description Gets or sets the optional description used for SEO and LLM indexing. @@ -154,7 +152,7 @@ public string Description { get; set; } Type: `string?` -### Errors +### Errors Gets or sets the error pages configuration. @@ -168,7 +166,7 @@ public Mintlify.Core.Models.ErrorsConfig Errors { get; set; } Type: `Mintlify.Core.Models.ErrorsConfig?` -### Favicon +### Favicon Gets or sets the favicon configuration. @@ -182,7 +180,7 @@ public Mintlify.Core.Models.FaviconConfig Favicon { get; set; } Type: `Mintlify.Core.Models.FaviconConfig?` -### Fonts +### Fonts Gets or sets the fonts configuration. @@ -196,7 +194,7 @@ public Mintlify.Core.Models.FontsConfig Fonts { get; set; } Type: `Mintlify.Core.Models.FontsConfig?` -### Footer +### Footer Gets or sets the footer configuration. @@ -210,7 +208,7 @@ public Mintlify.Core.Models.FooterConfig Footer { get; set; } Type: `Mintlify.Core.Models.FooterConfig?` -### Icons +### Icons Gets or sets the icons configuration. @@ -224,7 +222,7 @@ public Mintlify.Core.Models.IconsConfig Icons { get; set; } Type: `Mintlify.Core.Models.IconsConfig?` -### Integrations +### Integrations Gets or sets the integrations configuration. @@ -238,7 +236,7 @@ public Mintlify.Core.Models.IntegrationsConfig Integrations { get; set; } Type: `Mintlify.Core.Models.IntegrationsConfig?` -### Interaction +### Interaction Gets or sets the interaction configuration for navigation elements. @@ -257,7 +255,7 @@ Type: `Mintlify.Core.Models.InteractionConfig?` Controls how users interact with navigation elements such as groups and dropdowns, including whether expanding a group automatically navigates to its first page. -### Logo +### Logo Gets or sets the logo configuration. @@ -271,7 +269,7 @@ public Mintlify.Core.Models.LogoConfig Logo { get; set; } Type: `Mintlify.Core.Models.LogoConfig?` -### Name +### Name Gets or sets the name of the project, organization, or product. @@ -289,7 +287,7 @@ Type: `string` This is a required field. -### Navbar +### Navbar Gets or sets the navbar configuration. @@ -303,7 +301,7 @@ public Mintlify.Core.Models.NavbarConfig Navbar { get; set; } Type: `Mintlify.Core.Models.NavbarConfig?` -### Navigation +### Navigation Gets or sets the navigation structure. @@ -321,7 +319,7 @@ Type: `Mintlify.Core.Models.NavigationConfig` This is a required field that defines the structure of your documentation. -### Redirects +### Redirects Gets or sets the redirects. @@ -335,7 +333,7 @@ public System.Collections.Generic.List Redi Type: `System.Collections.Generic.List?` -### Schema +### Schema Gets or sets the JSON schema URL. @@ -349,7 +347,7 @@ public string Schema { get; set; } Type: `string?` -### Search +### Search Gets or sets the search configuration. @@ -363,7 +361,7 @@ public Mintlify.Core.Models.SearchConfig Search { get; set; } Type: `Mintlify.Core.Models.SearchConfig?` -### Seo +### Seo Gets or sets the SEO configuration. @@ -377,7 +375,7 @@ public Mintlify.Core.Models.SeoConfig Seo { get; set; } Type: `Mintlify.Core.Models.SeoConfig?` -### Styling +### Styling Gets or sets the styling configuration. @@ -391,7 +389,7 @@ public Mintlify.Core.Models.StylingConfig Styling { get; set; } Type: `Mintlify.Core.Models.StylingConfig?` -### Theme +### Theme Gets or sets the theme name. @@ -409,7 +407,7 @@ Type: `string` This is a required field. Valid values are: mint, maple, palm, willow, linden, almond, aspen. -### Thumbnails +### Thumbnails Gets or sets the thumbnails configuration. @@ -430,7 +428,7 @@ Defines custom thumbnail images for social media sharing and link previews. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -450,7 +448,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -471,7 +469,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -485,7 +483,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -499,7 +497,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -513,7 +511,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -534,7 +532,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/DropdownConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/DropdownConfig.mdx index feee286..3cc6a67 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/DropdownConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/DropdownConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DropdownConfig', 'Mintlify.Core.Models.DropdownConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationSectionBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -31,7 +29,7 @@ Dropdowns create expandable navigation menus. The dropdown name is required. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ Dropdowns create expandable navigation menus. The dropdown name is required. public DropdownConfig() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -49,7 +47,7 @@ public DropdownConfig() protected NavigationSectionBase() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -59,7 +57,7 @@ protected NavigationSectionBase() protected NavigationContainerBase() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -69,7 +67,7 @@ protected NavigationContainerBase() protected NavigationItemBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -81,7 +79,7 @@ public Object() ## Properties -### Anchors +### Anchors Gets or sets the anchors for the dropdown. @@ -99,7 +97,7 @@ Type: `System.Collections.Generic.List?` Anchors provide persistent navigation items within the dropdown. -### AsyncApi +### AsyncApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -120,7 +118,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Color +### Color Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -140,7 +138,7 @@ Type: `Mintlify.Core.Models.ColorPairConfig?` Defines the primary and secondary colors used for this section's visual styling. -### Description +### Description Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -160,7 +158,7 @@ Type: `string?` Provides additional descriptive text about this navigation section. -### Dropdown +### Dropdown Gets or sets the name of the dropdown. @@ -178,7 +176,7 @@ Type: `string` This is a required field that appears as the dropdown label in navigation. -### Dropdowns +### Dropdowns Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -198,7 +196,7 @@ Type: `System.Collections.Generic.List?` Dropdowns create expandable menu sections within this navigation section. -### Global +### Global Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -218,7 +216,7 @@ Type: `Mintlify.Core.Models.GlobalNavigationConfig?` Global navigation items persist across different tabs and pages for consistent navigation. -### Groups +### Groups Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -238,7 +236,7 @@ Type: `System.Collections.Generic.List?` Groups organize pages into labeled sections within this navigation container. -### Hidden +### Hidden Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -258,7 +256,7 @@ Type: `System.Nullable?` When true, this navigation item will not be displayed in the navigation by default. -### Href +### Href Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -278,7 +276,7 @@ Type: `string?` Can be used to link to an external URL or specify a path for this container. -### Icon +### Icon Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -299,7 +297,7 @@ Type: `Mintlify.Core.Models.IconConfig?` Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project. -### Languages +### Languages Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -319,7 +317,7 @@ Type: `System.Collections.Generic.List?` Allows partitioning navigation into different language-specific versions. -### OpenApi +### OpenApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -340,7 +338,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Pages +### Pages Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -360,7 +358,7 @@ Type: `System.Collections.Generic.List?` Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. -### Tabs +### Tabs Gets or sets the tabs for the dropdown. @@ -378,7 +376,7 @@ Type: `System.Collections.Generic.List?` Allows creating multiple tabs within a dropdown section. -### Versions +### Versions Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -400,7 +398,7 @@ Allows partitioning navigation into different version-specific documentation. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -420,7 +418,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -441,7 +439,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -455,7 +453,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -469,7 +467,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -483,7 +481,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -504,7 +502,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Error404Config.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Error404Config.mdx index e36d827..e97c74f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Error404Config.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Error404Config.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['Error404Config', 'Mintlify.Core.Models.Error404Config', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls what happens when users try to access pages that don ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls what happens when users try to access pages that don public Error404Config() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Redirect +### Redirect Gets or sets whether to automatically redirect users to the home page when a 404 error occurs. @@ -75,7 +73,7 @@ When true (default), users who navigate to non-existent pages will be automatica ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -95,7 +93,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -116,7 +114,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -144,7 +142,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -158,7 +156,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -179,7 +177,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ErrorsConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ErrorsConfig.mdx index 7e6189e..36588ba 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ErrorsConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ErrorsConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ErrorsConfig', 'Mintlify.Core.Models.ErrorsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls how various error conditions are handled, ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls how various error conditions are handled, public ErrorsConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### NotFound +### NotFound Gets or sets the configuration for 404 (Not Found) error handling. @@ -73,7 +71,7 @@ Defines how the site behaves when users attempt to access pages that don't exist ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -156,7 +154,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FaviconConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FaviconConfig.mdx index 8ef5d99..983c2fe 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FaviconConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FaviconConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FaviconConfig', 'Mintlify.Core.Models.FaviconConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -28,7 +26,7 @@ Represents the favicon configuration for Mintlify. ## Constructors -### .ctor +### .ctor Initializes a new instance of the [FaviconConfig](/api-reference/Mintlify/Core/Models/FaviconConfig) class. @@ -38,7 +36,7 @@ Initializes a new instance of the [FaviconConfig](/api-reference/Mintlify/Core/M public FaviconConfig() ``` -### .ctor +### .ctor Initializes a new instance of the [FaviconConfig](/api-reference/Mintlify/Core/Models/FaviconConfig) class with a single favicon path. @@ -54,7 +52,7 @@ public FaviconConfig(string faviconPath) |------|------|-------------| | `faviconPath` | `string?` | The path to the favicon file. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -66,7 +64,7 @@ public Object() ## Properties -### Dark +### Dark Gets or sets the path to the dark favicon file, including the file extension. @@ -80,7 +78,7 @@ public string Dark { get; set; } Type: `string?` -### Light +### Light Gets or sets the path to the light favicon file, including the file extension. @@ -96,7 +94,7 @@ Type: `string?` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -116,7 +114,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -137,7 +135,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -151,7 +149,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -165,7 +163,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -179,7 +177,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -200,7 +198,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the favicon configuration. @@ -215,7 +213,7 @@ public override string ToString() Type: `string` The favicon path or empty string. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter.mdx index 15ba47a..976a974 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FaviconConfigJsonConverter.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FaviconConfigJsonConverter', 'Mintlify.Core.Models.FaviconConfigJsonConverter', 'Mintlify.Core.Models', 'class', 'System.Text.Json.Serialization.JsonConverter'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -27,7 +25,7 @@ Custom JSON converter for FaviconConfig that supports both string and object for ## Constructors -### .ctor +### .ctor #### Syntax @@ -37,7 +35,7 @@ public FaviconConfigJsonConverter() ## Methods -### Read +### Read Override Reads and converts the JSON to a FaviconConfig object. @@ -60,7 +58,7 @@ public override Mintlify.Core.Models.FaviconConfig Read(ref System.Text.Json.Utf Type: `Mintlify.Core.Models.FaviconConfig?` A FaviconConfig object. -### Write +### Write Override Writes a FaviconConfig object as JSON. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FontsConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FontsConfig.mdx index 7cc6078..53bb4ff 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FontsConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FontsConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FontsConfig', 'Mintlify.Core.Models.FontsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration allows customization of typography by specifying custom fonts ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration allows customization of typography by specifying custom fonts public FontsConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Family +### Family Gets or sets the font family name. @@ -71,7 +69,7 @@ Type: `string?` Specifies the name of the font family to use, such as "Open Sans" or "Playfair Display". This should match the font family name defined in the font file. -### Format +### Format Gets or sets the font file format. @@ -90,7 +88,7 @@ Type: `string?` Specifies the format of the font file. Valid values are "woff" or "woff2". WOFF2 is preferred for modern browsers as it provides better compression. -### Source +### Source Gets or sets the font source URL. @@ -110,7 +108,7 @@ Specifies the URL where the font file can be downloaded from. Should be a complete URL pointing to the font file, such as "https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2". -### Weight +### Weight Gets or sets the font weight. @@ -132,7 +130,7 @@ Specifies the font weight as a numeric value such as 400 (normal) or 700 (bold). ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -152,7 +150,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -173,7 +171,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -187,7 +185,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -201,7 +199,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -215,7 +213,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -236,7 +234,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterConfig.mdx index 09d4924..7435bc6 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FooterConfig', 'Mintlify.Core.Models.FooterConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -27,7 +25,7 @@ Represents the footer configuration for Mintlify. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Represents the footer configuration for Mintlify. public FooterConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Links +### Links Gets or sets the footer links. @@ -61,7 +59,7 @@ public System.Collections.Generic.List Lin Type: `System.Collections.Generic.List?` -### Socials +### Socials Gets or sets the social media links. @@ -77,7 +75,7 @@ Type: `System.Collections.Generic.Dictionary?` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterLink.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterLink.mdx index 746d9e3..e5a8be1 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterLink.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterLink.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FooterLink', 'Mintlify.Core.Models.FooterLink', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -27,7 +25,7 @@ Represents a footer link. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Represents a footer link. public FooterLink() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Href +### Href Gets or sets the URL of the link. @@ -61,7 +59,7 @@ public string Href { get; set; } Type: `string?` -### Label +### Label Gets or sets the label of the link. @@ -81,7 +79,7 @@ This is a required field that appears as the link text in the footer. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -101,7 +99,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -122,7 +120,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -136,7 +134,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -150,7 +148,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -164,7 +162,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -185,7 +183,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterLinkGroup.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterLinkGroup.mdx index b483b2d..71aa4d3 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterLinkGroup.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FooterLinkGroup.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FooterLinkGroup', 'Mintlify.Core.Models.FooterLinkGroup', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -27,7 +25,7 @@ Represents a group of footer links. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Represents a group of footer links. public FooterLinkGroup() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Header +### Header Gets or sets the header title of the column. @@ -65,7 +63,7 @@ Type: `string` This is a required field that appears as the column title in the footer. -### Items +### Items Gets or sets the items in the footer group. @@ -81,7 +79,7 @@ Type: `System.Collections.Generic.List?` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -101,7 +99,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -122,7 +120,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -136,7 +134,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -150,7 +148,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -164,7 +162,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -185,7 +183,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FrontMatterConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FrontMatterConfig.mdx index b4a0a7b..41fe571 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FrontMatterConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/FrontMatterConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FrontMatterConfig', 'Mintlify.Core.Models.FrontMatterConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ This class contains all the documented frontmatter properties supported by Mintl ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ This class contains all the documented frontmatter properties supported by Mintl public FrontMatterConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### Canonical +### Canonical Gets or sets the canonical URL for SEO. @@ -71,7 +69,7 @@ Type: `string` Helps prevent duplicate content issues by specifying the canonical version of the page. -### Classes +### Classes Gets or sets custom CSS classes for the page. @@ -89,7 +87,7 @@ Type: `System.Collections.Generic.List` Additional CSS classes to apply to the page for custom styling. -### Data +### Data Gets or sets custom data attributes. @@ -107,7 +105,7 @@ Type: `System.Collections.Generic.Dictionary` Custom data attributes to add to the page for analytics or custom JavaScript. -### Deprecated +### Deprecated Gets or sets a value indicating whether the page is deprecated. @@ -125,7 +123,7 @@ Type: `System.Nullable` When true, displays a deprecation notice on the page. -### Description +### Description Gets or sets the description of the page. @@ -143,7 +141,7 @@ Type: `string` Used for SEO meta descriptions and page summaries. -### Groups +### Groups Gets or sets the groups that can access this page. @@ -161,7 +159,7 @@ Type: `System.Collections.Generic.List` Used for access control in authenticated documentation sites. -### Hidden +### Hidden Gets or sets a value indicating whether the page should be hidden from navigation. @@ -179,7 +177,7 @@ Type: `System.Nullable` When true, the page is accessible by direct URL but not shown in navigation menus. -### Icon +### Icon Gets or sets the icon for the page. @@ -198,7 +196,7 @@ Type: `string` Can be a FontAwesome icon name, Lucide icon name, or a custom icon path. Examples: "cube", "book", "settings", "star". -### IconType +### IconType Gets or sets the icon type. @@ -216,7 +214,7 @@ Type: `string` Specifies the icon style. Common values: "solid", "regular", "light", "duotone". -### Meta +### Meta Gets or sets additional meta tags for the page. @@ -234,7 +232,7 @@ Type: `System.Collections.Generic.Dictionary` Dictionary of additional meta tag name/content pairs for custom SEO or social media tags. -### Mode +### Mode Gets or sets the layout mode for the page. @@ -252,7 +250,7 @@ Type: `string` Controls the page layout. Common values: "wide", "centered". -### OgDescription +### OgDescription Gets or sets the OpenGraph description. @@ -270,7 +268,7 @@ Type: `string` Description used when the page is shared on social media platforms. -### OgImage +### OgImage Gets or sets the OpenGraph image URL. @@ -288,7 +286,7 @@ Type: `string` Image used when the page is shared on social media platforms. -### OgTitle +### OgTitle Gets or sets the OpenGraph title. @@ -306,7 +304,7 @@ Type: `string` Title used when the page is shared on social media platforms. -### Order +### Order Gets or sets the navigation order. @@ -324,7 +322,7 @@ Type: `System.Nullable` Numeric value to control the order of pages in navigation. Lower numbers appear first. -### Public +### Public Gets or sets a value indicating whether the page is public. @@ -342,7 +340,7 @@ Type: `System.Nullable` Controls visibility in public documentation sites. -### Robots +### Robots Gets or sets the robots meta tag content. @@ -360,7 +358,7 @@ Type: `string` Controls search engine indexing. Common values: "index,follow", "noindex,nofollow". -### SidebarTitle +### SidebarTitle Gets or sets the sidebar title. @@ -378,7 +376,7 @@ Type: `string` Shorter title used in the sidebar navigation. If not specified, the main title is used. -### Tag +### Tag Gets or sets the tag for the page. @@ -396,7 +394,7 @@ Type: `string` Displays a tag badge next to the title. Common values: "NEW", "BETA", "DEPRECATED". -### Title +### Title Gets or sets the title of the page. @@ -414,7 +412,7 @@ Type: `string` This is the main heading displayed at the top of the page and used in navigation. -### Url +### Url Gets or sets the external URL for the page. @@ -432,7 +430,7 @@ Type: `string` If specified, clicking on this page in navigation will redirect to this URL instead of showing content. -### Version +### Version Gets or sets the version for the page. @@ -452,7 +450,7 @@ Used for version-specific documentation. ## Methods -### Create +### Create Creates a FrontMatterConfig with basic title and description, properly escaped. @@ -474,7 +472,7 @@ public static Mintlify.Core.Models.FrontMatterConfig Create(string title, string Type: `Mintlify.Core.Models.FrontMatterConfig` A new FrontMatterConfig instance. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -494,7 +492,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -515,7 +513,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### EscapeYamlValue +### EscapeYamlValue Escapes a value for safe use in YAML frontmatter. @@ -536,7 +534,7 @@ public static string EscapeYamlValue(string value) Type: `string` The escaped value, properly quoted if necessary. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -550,7 +548,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -564,7 +562,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -578,7 +576,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -599,7 +597,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -613,7 +611,7 @@ public virtual string ToString() Type: `string?` -### ToYaml +### ToYaml Generates YAML frontmatter from this configuration. diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalAnchorConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalAnchorConfig.mdx index ab17c6b..bc873b5 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalAnchorConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalAnchorConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GlobalAnchorConfig', 'Mintlify.Core.Models.GlobalAnchorConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration defines an anchor link that appears globally across all secti ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration defines an anchor link that appears globally across all secti public GlobalAnchorConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Anchor +### Anchor Gets or sets the display name for the anchor link. @@ -72,7 +70,7 @@ Specifies the text that will be shown for the anchor link. Should be concise and descriptive of the link's destination, such as "GitHub", "API Status", "Support", etc. This is a required field. -### Color +### Color Gets or sets the color configuration for the anchor. @@ -92,7 +90,7 @@ Defines custom colors for the anchor link in light and dark modes. This allows the anchor to have distinctive styling that matches your brand or indicates different types of external resources. -### Hidden +### Hidden Gets or sets whether this anchor is hidden by default. @@ -112,7 +110,7 @@ When true, this anchor will not be visible in the global navigation unless specifically shown. This can be useful for anchors that are temporary or not ready for public access. -### Href +### Href Gets or sets the URL or path for this anchor link. @@ -132,7 +130,7 @@ Specifies where users should be directed when they click on this anchor. Can be a relative path within the documentation or an absolute URL for external resources such as GitHub repositories, status pages, or support portals. -### Icon +### Icon Gets or sets the icon to display alongside the anchor name. @@ -154,7 +152,7 @@ Can be a string icon name from the configured icon library, or an object ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -174,7 +172,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -195,7 +193,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -209,7 +207,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -223,7 +221,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -237,7 +235,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -258,7 +256,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalDropdownConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalDropdownConfig.mdx index 1fd5bd6..769512e 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalDropdownConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalDropdownConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GlobalDropdownConfig', 'Mintlify.Core.Models.GlobalDropdownConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration defines a dropdown menu that appears globally across all sect ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration defines a dropdown menu that appears globally across all sect public GlobalDropdownConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Color +### Color Gets or sets the color configuration for the dropdown. @@ -72,7 +70,7 @@ Defines custom colors for the dropdown in light and dark modes. This allows the dropdown to have distinctive styling that matches your brand or indicates different types of content. -### Description +### Description Gets or sets the description text for the dropdown. @@ -91,7 +89,7 @@ Type: `string?` Optional descriptive text that can appear in the dropdown or as a tooltip. Provides additional context about what users will find in the dropdown menu. -### Dropdown +### Dropdown Gets or sets the display name for the dropdown button. @@ -111,7 +109,7 @@ Specifies the text that will be shown on the dropdown button. Should be concise and descriptive of the dropdown's contents, such as "Resources", "Tools", "Community", etc. This is a required field. -### Hidden +### Hidden Gets or sets whether this dropdown is hidden by default. @@ -131,7 +129,7 @@ When true, this dropdown will not be visible in the global navigation unless specifically shown. This can be useful for dropdowns that are in development or not ready for public access. -### Href +### Href Gets or sets the primary URL or path for this dropdown. @@ -151,7 +149,7 @@ Specifies where users should be directed when they click directly on the dropdow button (rather than selecting a specific item). Can be a relative path or absolute URL. This is optional if the dropdown only contains sub-items. -### Icon +### Icon Gets or sets the icon to display alongside the dropdown name. @@ -173,7 +171,7 @@ Can be a string icon name from the configured icon library, or an object ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -193,7 +191,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -214,7 +212,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -228,7 +226,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -242,7 +240,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -256,7 +254,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -277,7 +275,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalLanguageConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalLanguageConfig.mdx index fb6d82e..0e3f483 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalLanguageConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalLanguageConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GlobalLanguageConfig', 'Mintlify.Core.Models.GlobalLanguageConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration defines a language option that appears globally across all se ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration defines a language option that appears globally across all se public GlobalLanguageConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Default +### Default Gets or sets whether this language is the default language for the documentation. @@ -71,7 +69,7 @@ Type: `System.Nullable` When true, this language will be selected by default when users first visit the documentation. Only one language should be marked as default. -### Hidden +### Hidden Gets or sets whether this language option is hidden by default. @@ -91,7 +89,7 @@ When true, this language option will not be visible in the language selector unless specifically shown. This can be useful for languages that are in development or not ready for public access. -### Href +### Href Gets or sets the URL or path for this language version. @@ -111,7 +109,7 @@ Specifies where users should be directed when they select this language. Can be a relative path (e.g., "/es/") or an absolute URL for a different domain (e.g., "https://es.example.com/"). -### Language +### Language Gets or sets the language code in ISO 639-1 format. @@ -133,7 +131,7 @@ Specifies the language using a standard two-letter code such as "en" for English ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -153,7 +151,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -174,7 +172,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -188,7 +186,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -202,7 +200,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -216,7 +214,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -237,7 +235,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalNavigationConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalNavigationConfig.mdx index ddbc78d..ad18442 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalNavigationConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalNavigationConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GlobalNavigationConfig', 'Mintlify.Core.Models.GlobalNavigationConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -27,7 +25,7 @@ Represents global navigation configuration that appears on all sections and page ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Represents global navigation configuration that appears on all sections and page public GlobalNavigationConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Anchors +### Anchors Gets or sets the anchors configuration. @@ -61,7 +59,7 @@ public System.Collections.Generic.List Type: `System.Collections.Generic.List?` -### Dropdowns +### Dropdowns Gets or sets the dropdowns configuration. @@ -75,7 +73,7 @@ public System.Collections.Generic.List?` -### Languages +### Languages Gets or sets the languages configuration. @@ -89,7 +87,7 @@ public System.Collections.Generic.List?` -### Tabs +### Tabs Gets or sets the tabs configuration. @@ -103,7 +101,7 @@ public System.Collections.Generic.List Tab Type: `System.Collections.Generic.List?` -### Versions +### Versions Gets or sets the versions configuration. @@ -119,7 +117,7 @@ Type: `System.Collections.Generic.List ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -139,7 +137,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -160,7 +158,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -174,7 +172,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -188,7 +186,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -202,7 +200,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -223,7 +221,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalTabConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalTabConfig.mdx index 5c33e13..192a1e5 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalTabConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalTabConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GlobalTabConfig', 'Mintlify.Core.Models.GlobalTabConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration defines a tab that appears globally across all sections and p ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration defines a tab that appears globally across all sections and p public GlobalTabConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Hidden +### Hidden Gets or sets whether this tab is hidden by default. @@ -72,7 +70,7 @@ When true, this tab will not be visible in the global navigation unless specifically shown. This can be useful for tabs that are in development or not ready for public access. -### Href +### Href Gets or sets the URL or path for this tab. @@ -92,7 +90,7 @@ Specifies where users should be directed when they click on this tab. Can be a relative path (e.g., "/api/") or an absolute URL for external content. This determines the landing page for the tab. -### Icon +### Icon Gets or sets the icon to display alongside the tab name. @@ -112,7 +110,7 @@ Can be a string icon name from the configured icon library, or an object with detailed icon configuration including style and library properties. The icon appears before or alongside the tab text to provide visual context. -### Tab +### Tab Gets or sets the display name for the tab. @@ -134,7 +132,7 @@ Specifies the text that will be shown on the tab button. Should be concise ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -154,7 +152,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -175,7 +173,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -189,7 +187,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -203,7 +201,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -217,7 +215,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -238,7 +236,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalVersionConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalVersionConfig.mdx index 92f1133..3736fe8 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalVersionConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GlobalVersionConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GlobalVersionConfig', 'Mintlify.Core.Models.GlobalVersionConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration defines a version option that appears globally across all sec ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration defines a version option that appears globally across all sec public GlobalVersionConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Default +### Default Gets or sets whether this version is the default version for the documentation. @@ -71,7 +69,7 @@ Type: `System.Nullable` When true, this version will be selected by default when users first visit the documentation. Only one version should be marked as default. -### Hidden +### Hidden Gets or sets whether this version option is hidden by default. @@ -91,7 +89,7 @@ When true, this version option will not be visible in the version selector unless specifically shown. This can be useful for versions that are deprecated, in development, or not ready for public access. -### Href +### Href Gets or sets the URL or path for this version of the documentation. @@ -111,7 +109,7 @@ Specifies where users should be directed when they select this version. Can be a relative path (e.g., "/v2/") or an absolute URL for a different domain (e.g., "https://v2.docs.example.com/"). -### Version +### Version Gets or sets the version identifier or name. @@ -133,7 +131,7 @@ Specifies the version name that will be displayed to users, such as "v1.0", ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -153,7 +151,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -174,7 +172,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -188,7 +186,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -202,7 +200,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -216,7 +214,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -237,7 +235,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GroupConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GroupConfig.mdx index 1471e17..b45637f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GroupConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/GroupConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GroupConfig', 'Mintlify.Core.Models.GroupConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationItemBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -31,7 +29,7 @@ Groups organize pages into sections in your navigation. The group name is requir ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ Groups organize pages into sections in your navigation. The group name is requir public GroupConfig() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -49,7 +47,7 @@ public GroupConfig() protected NavigationItemBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -61,7 +59,7 @@ public Object() ## Properties -### AsyncApi +### AsyncApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -82,7 +80,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Expanded +### Expanded Gets or sets whether the group is expanded by default in the navigation sidebar. @@ -101,7 +99,7 @@ Type: `System.Nullable?` When true, the group will be expanded by default showing all its pages. When false or null, the group will be collapsed by default. -### Group +### Group Gets or sets the name of the group. @@ -122,7 +120,7 @@ This is a required field that appears as the group title in navigation. they are not recommended as Mintlify treats each empty group as a separate ungrouped navigation section rather than merging them together. -### Hidden +### Hidden Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -142,7 +140,7 @@ Type: `System.Nullable?` When true, this navigation item will not be displayed in the navigation by default. -### Icon +### Icon Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -163,7 +161,7 @@ Type: `Mintlify.Core.Models.IconConfig?` Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project. -### OpenApi +### OpenApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -184,7 +182,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Pages +### Pages Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -204,7 +202,7 @@ Type: `System.Collections.Generic.List?` Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. -### Root +### Root Gets or sets the root page for the group. @@ -222,7 +220,7 @@ Type: `string?` Specifies the default page to display when the group is selected. -### Tag +### Tag Gets or sets the tag for the group. @@ -242,7 +240,7 @@ Displays a label tag (e.g., "NEW", "BETA") next to the group name. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -262,7 +260,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -283,7 +281,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -297,7 +295,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -311,7 +309,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -325,7 +323,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -346,7 +344,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IconConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IconConfig.mdx index 7d29b29..dd3afba 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IconConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IconConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['IconConfig', 'Mintlify.Core.Models.IconConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Icons can be simple string references or detailed configurations with style and ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Icons can be simple string references or detailed configurations with style and public IconConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Library +### Library Gets or sets the icon library. @@ -71,7 +69,7 @@ Type: `string?` Specifies which icon library to use. Defaults to "fontawesome" if not specified. Supported libraries include "fontawesome" and "lucide". -### Name +### Name Gets or sets the icon name. @@ -89,7 +87,7 @@ Type: `string` This is the specific icon name, such as "home", "folder", "user", etc. -### Style +### Style Gets or sets the icon style. @@ -110,7 +108,7 @@ Specifies the style variant of the icon. Common styles include: ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -151,7 +149,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -179,7 +177,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -193,7 +191,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -214,7 +212,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the icon. @@ -229,7 +227,7 @@ public override string ToString() Type: `string` The icon name or an empty string if null. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IconsConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IconsConfig.mdx index cb5de07..51e47d7 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IconsConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IconsConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['IconsConfig', 'Mintlify.Core.Models.IconsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration determines which icon library is used throughout the document ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration determines which icon library is used throughout the document public IconsConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Library +### Library Gets or sets the icon library to be used throughout the documentation. @@ -75,7 +73,7 @@ Valid values are "fontawesome" or "lucide". The selected library determines ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -95,7 +93,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -116,7 +114,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -144,7 +142,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -158,7 +156,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -179,7 +177,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig.mdx index 1835f49..e31606c 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/AmplitudeConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['AmplitudeConfig', 'Mintlify.Core.Models.Integrations.AmplitudeConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Amplitude is a product analytics platform that helps teams build better products ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Amplitude is a product analytics platform that helps teams build better products public AmplitudeConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### ApiKey +### ApiKey Gets or sets the Amplitude API key for your project. @@ -75,7 +73,7 @@ This is the unique identifier for your Amplitude project. You can find this ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -95,7 +93,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -116,7 +114,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -144,7 +142,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -158,7 +156,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -179,7 +177,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig.mdx index 14e4d7a..1a73170 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/ClearbitConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClearbitConfig', 'Mintlify.Core.Models.Integrations.ClearbitConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Clearbit provides business intelligence and data enrichment services, helping ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Clearbit provides business intelligence and data enrichment services, helping public ClearbitConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### PublicApiKey +### PublicApiKey Gets or sets the Clearbit public API key. @@ -75,7 +73,7 @@ This is your public API key for Clearbit, which enables data enrichment ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -95,7 +93,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -116,7 +114,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -144,7 +142,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -158,7 +156,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -179,7 +177,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/FathomConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/FathomConfig.mdx index 5448cff..d4020a5 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/FathomConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/FathomConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['FathomConfig', 'Mintlify.Core.Models.Integrations.FathomConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Fathom is a simple, privacy-focused website analytics platform that doesn't ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Fathom is a simple, privacy-focused website analytics platform that doesn't public FathomConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### SiteId +### SiteId Gets or sets the Fathom site ID. @@ -75,7 +73,7 @@ This is the unique identifier for your site in Fathom analytics. You can ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -95,7 +93,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -116,7 +114,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -144,7 +142,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -158,7 +156,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -179,7 +177,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config.mdx index 11b0e0e..649910d 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/GoogleAnalytics4Config.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GoogleAnalytics4Config', 'Mintlify.Core.Models.Integrations.GoogleAnalytics4Config', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Google Analytics 4 (GA4) is Google's next-generation analytics platform that ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Google Analytics 4 (GA4) is Google's next-generation analytics platform that public GoogleAnalytics4Config() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### MeasurementId +### MeasurementId Gets or sets the Google Analytics 4 measurement ID. @@ -76,7 +74,7 @@ This is the unique identifier for your GA4 web data stream, typically in ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -96,7 +94,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -117,7 +115,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -131,7 +129,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -145,7 +143,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -159,7 +157,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -180,7 +178,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/GtmConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/GtmConfig.mdx index f38e5e7..608bb50 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/GtmConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/GtmConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['GtmConfig', 'Mintlify.Core.Models.Integrations.GtmConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Google Tag Manager (GTM) is a tag management system that allows you to quickly ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Google Tag Manager (GTM) is a tag management system that allows you to quickly public GtmConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### TagId +### TagId Gets or sets the Google Tag Manager container ID. @@ -76,7 +74,7 @@ This is the unique identifier for your GTM container, typically in the format ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -96,7 +94,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -117,7 +115,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -131,7 +129,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -145,7 +143,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -159,7 +157,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -180,7 +178,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HeapConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HeapConfig.mdx index 368ec02..c331df8 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HeapConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HeapConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['HeapConfig', 'Mintlify.Core.Models.Integrations.HeapConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Heap is an analytics platform that automatically captures every user interaction ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Heap is an analytics platform that automatically captures every user interaction public HeapConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### AppId +### AppId Gets or sets the Heap application ID. @@ -75,7 +73,7 @@ This is the unique identifier for your Heap project. You can find this ID ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -95,7 +93,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -116,7 +114,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -144,7 +142,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -158,7 +156,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -179,7 +177,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig.mdx index 52e59b6..50e17d3 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HightouchConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['HightouchConfig', 'Mintlify.Core.Models.Integrations.HightouchConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Hightouch is a data activation platform that syncs data from your warehouse ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Hightouch is a data activation platform that syncs data from your warehouse public HightouchConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### ApiKey +### ApiKey Gets or sets the Hightouch API key. @@ -74,7 +72,7 @@ This is your Hightouch API key that enables event tracking and data ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -94,7 +92,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -115,7 +113,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -129,7 +127,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -143,7 +141,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -157,7 +155,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -178,7 +176,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig.mdx index 36698da..57896a3 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/HotjarConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['HotjarConfig', 'Mintlify.Core.Models.Integrations.HotjarConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Hotjar is a behavior analytics tool that provides heatmaps, session recordings, ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Hotjar is a behavior analytics tool that provides heatmaps, session recordings, public HotjarConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### Hjid +### Hjid Gets or sets the Hotjar site ID. @@ -73,7 +71,7 @@ This is the unique identifier for your site in Hotjar, found in your Hotjar tracking code. It is typically a numeric value that identifies which Hotjar site configuration to use. -### Hjsv +### Hjsv Gets or sets the Hotjar script version. @@ -95,7 +93,7 @@ This is the version number of the Hotjar tracking script, also found in your ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -115,7 +113,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -136,7 +134,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -150,7 +148,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -164,7 +162,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -178,7 +176,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -199,7 +197,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig.mdx index a8cbdc5..aee1336 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/LogRocketConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['LogRocketConfig', 'Mintlify.Core.Models.Integrations.LogRocketConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ LogRocket is a session replay and analytics platform that records user sessions, ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ LogRocket is a session replay and analytics platform that records user sessions, public LogRocketConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### AppId +### AppId Gets or sets the LogRocket application ID. @@ -76,7 +74,7 @@ This is the unique identifier for your LogRocket application, typically in ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -96,7 +94,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -117,7 +115,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -131,7 +129,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -145,7 +143,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -159,7 +157,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -180,7 +178,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig.mdx index e222430..3e1dc5b 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/MixpanelConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MixpanelConfig', 'Mintlify.Core.Models.Integrations.MixpanelConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Mixpanel is a product analytics platform that helps you understand user behavior ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Mixpanel is a product analytics platform that helps you understand user behavior public MixpanelConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### ProjectToken +### ProjectToken Gets or sets the Mixpanel project token. @@ -75,7 +73,7 @@ This is the unique identifier for your Mixpanel project. You can find this ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -95,7 +93,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -116,7 +114,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -144,7 +142,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -158,7 +156,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -179,7 +177,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PirschConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PirschConfig.mdx index dc2aadd..0c83f16 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PirschConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PirschConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['PirschConfig', 'Mintlify.Core.Models.Integrations.PirschConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Pirsch is a privacy-friendly, GDPR-compliant web analytics platform that provide ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Pirsch is a privacy-friendly, GDPR-compliant web analytics platform that provide public PirschConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### Id +### Id Gets or sets the Pirsch identification code. @@ -75,7 +73,7 @@ This is the unique identifier for your Pirsch analytics instance. You can ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -95,7 +93,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -116,7 +114,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -130,7 +128,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -144,7 +142,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -158,7 +156,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -179,7 +177,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig.mdx index 275968d..d793533 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PlausibleConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['PlausibleConfig', 'Mintlify.Core.Models.Integrations.PlausibleConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Plausible is a lightweight, open-source, privacy-friendly web analytics platform ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ Plausible is a lightweight, open-source, privacy-friendly web analytics platform public PlausibleConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### Domain +### Domain Gets or sets the domain being tracked in Plausible. @@ -73,7 +71,7 @@ This is the domain name that you registered in your Plausible account. It should match the domain where your documentation is hosted. All analytics events will be attributed to this domain in your Plausible dashboard. -### Server +### Server Gets or sets the custom Plausible server URL. @@ -96,7 +94,7 @@ This is optional and only needed if you are self-hosting Plausible or using ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -116,7 +114,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -137,7 +135,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -151,7 +149,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -165,7 +163,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -179,7 +177,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -200,7 +198,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig.mdx index eeb14e3..a029081 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/PostHogConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['PostHogConfig', 'Mintlify.Core.Models.Integrations.PostHogConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ PostHog is an open-source product analytics platform that provides session ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ PostHog is an open-source product analytics platform that provides session public PostHogConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### ApiHost +### ApiHost Gets or sets the PostHog API host URL. @@ -74,7 +72,7 @@ This is optional and only needed if you are self-hosting PostHog. If not https://app.posthog.com. If you are self-hosting, specify the full URL to your PostHog instance. -### ApiKey +### ApiKey Gets or sets the PostHog project API key. @@ -96,7 +94,7 @@ This is your PostHog project's API key, which typically starts with "phc_". ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -116,7 +114,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -137,7 +135,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -151,7 +149,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -165,7 +163,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -179,7 +177,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -200,7 +198,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig.mdx index 98104b2..7e4aa57 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/Integrations/SegmentConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SegmentConfig', 'Mintlify.Core.Models.Integrations.SegmentConfig', 'Mintlify.Core.Models.Integrations', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -34,7 +32,7 @@ Segment is a customer data platform that collects, transforms, and routes ## Constructors -### .ctor +### .ctor #### Syntax @@ -42,7 +40,7 @@ Segment is a customer data platform that collects, transforms, and routes public SegmentConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -54,7 +52,7 @@ public Object() ## Properties -### Key +### Key Gets or sets the Segment write key. @@ -77,7 +75,7 @@ This is your Segment source's write key, which identifies which Segment ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IntegrationsConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IntegrationsConfig.mdx index 3366571..66cdca2 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IntegrationsConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/IntegrationsConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['IntegrationsConfig', 'Mintlify.Core.Models.IntegrationsConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -34,7 +32,7 @@ This configuration enables integration with various analytics, feedback, and oth ## Constructors -### .ctor +### .ctor #### Syntax @@ -42,7 +40,7 @@ This configuration enables integration with various analytics, feedback, and oth public IntegrationsConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -54,7 +52,7 @@ public Object() ## Properties -### Amplitude +### Amplitude Gets or sets the Amplitude analytics integration configuration. @@ -73,7 +71,7 @@ Type: `Mintlify.Core.Models.Integrations.AmplitudeConfig?` Amplitude provides product analytics to understand user behavior and engagement. When configured, all documentation events are automatically sent to your Amplitude project. -### Clearbit +### Clearbit Gets or sets the Clearbit data enrichment integration configuration. @@ -92,7 +90,7 @@ Type: `Mintlify.Core.Models.Integrations.ClearbitConfig?` Clearbit enriches your analytics data with company and demographic information. When configured, visitor data is enhanced with business intelligence. -### Fathom +### Fathom Gets or sets the Fathom analytics integration configuration. @@ -112,7 +110,7 @@ Fathom provides simple, privacy-focused analytics that is GDPR compliant and doesn't use cookies. When configured, page views and events are tracked in your Fathom dashboard. -### GoogleAnalytics4 +### GoogleAnalytics4 Gets or sets the Google Analytics 4 integration configuration. @@ -132,7 +130,7 @@ Google Analytics 4 (GA4) is Google's next-generation analytics platform. When configured, all documentation events are sent to your GA4 property. Note that GA4 data may take 2-3 days to appear after initial setup. -### Gtm +### Gtm Gets or sets the Google Tag Manager integration configuration. @@ -151,7 +149,7 @@ Type: `Mintlify.Core.Models.Integrations.GtmConfig?` Google Tag Manager (GTM) allows flexible tag management for analytics and marketing. When configured, you can manage all tracking tags through the GTM interface. -### Heap +### Heap Gets or sets the Heap analytics integration configuration. @@ -170,7 +168,7 @@ Type: `Mintlify.Core.Models.Integrations.HeapConfig?` Heap automatically captures all user interactions without manual event tracking. When configured, every user interaction on your documentation is automatically tracked. -### Hightouch +### Hightouch Gets or sets the Hightouch data activation integration configuration. @@ -189,7 +187,7 @@ Type: `Mintlify.Core.Models.Integrations.HightouchConfig?` Hightouch syncs data from your warehouse to business tools. When configured, documentation events can be synchronized to your data warehouse and downstream tools. -### Hotjar +### Hotjar Gets or sets the Hotjar behavior analytics integration configuration. @@ -208,7 +206,7 @@ Type: `Mintlify.Core.Models.Integrations.HotjarConfig?` Hotjar provides heatmaps, session recordings, and user feedback tools. When configured, you can visualize how users interact with your documentation. -### LogRocket +### LogRocket Gets or sets the LogRocket session replay integration configuration. @@ -227,7 +225,7 @@ Type: `Mintlify.Core.Models.Integrations.LogRocketConfig?` LogRocket records user sessions including console logs and network activity. When configured, you can replay user sessions to understand issues and behavior. -### Mixpanel +### Mixpanel Gets or sets the Mixpanel product analytics integration configuration. @@ -246,7 +244,7 @@ Type: `Mintlify.Core.Models.Integrations.MixpanelConfig?` Mixpanel provides detailed product analytics and user behavior tracking. When configured, all documentation events are sent to your Mixpanel project. -### Pirsch +### Pirsch Gets or sets the Pirsch analytics integration configuration. @@ -265,7 +263,7 @@ Type: `Mintlify.Core.Models.Integrations.PirschConfig?` Pirsch is a privacy-friendly, GDPR-compliant analytics platform. When configured, page views and events are tracked without cookies. -### Plausible +### Plausible Gets or sets the Plausible analytics integration configuration. @@ -284,7 +282,7 @@ Type: `Mintlify.Core.Models.Integrations.PlausibleConfig?` Plausible is a lightweight, open-source, privacy-focused analytics platform. When configured, documentation engagement is tracked without cookies. -### PostHog +### PostHog Gets or sets the PostHog product analytics integration configuration. @@ -303,7 +301,7 @@ Type: `Mintlify.Core.Models.Integrations.PostHogConfig?` PostHog provides session recording, feature flags, and product analytics. When configured, all documentation events are sent to your PostHog instance. -### Segment +### Segment Gets or sets the Segment customer data platform integration configuration. @@ -325,7 +323,7 @@ Segment collects, transforms, and routes analytics data to various destinations. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -345,7 +343,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -366,7 +364,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -380,7 +378,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -394,7 +392,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -408,7 +406,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -429,7 +427,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/InteractionConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/InteractionConfig.mdx index 2072273..d16bcb5 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/InteractionConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/InteractionConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['InteractionConfig', 'Mintlify.Core.Models.InteractionConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Controls how users interact with navigation elements such as groups and dropdown ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Controls how users interact with navigation elements such as groups and dropdown public InteractionConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Drilldown +### Drilldown Gets or sets whether to automatically navigate to the first page when expanding a navigation group. @@ -86,7 +84,7 @@ Valid values are: ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -106,7 +104,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -127,7 +125,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -141,7 +139,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -155,7 +153,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -169,7 +167,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -190,7 +188,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/LanguageConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/LanguageConfig.mdx index f725d6b..870c0e6 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/LanguageConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/LanguageConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['LanguageConfig', 'Mintlify.Core.Models.LanguageConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -27,7 +25,7 @@ Represents a language configuration in Mintlify navigation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ Represents a language configuration in Mintlify navigation. public LanguageConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Anchors +### Anchors Gets or sets the anchors for the language. @@ -61,7 +59,7 @@ public System.Collections.Generic.List Anchor Type: `System.Collections.Generic.List?` -### AsyncApi +### AsyncApi Gets or sets the AsyncAPI configuration. @@ -75,7 +73,7 @@ public object AsyncApi { get; set; } Type: `object?` -### Default +### Default Gets or sets whether this language is the default language. @@ -89,7 +87,7 @@ public System.Nullable Default { get; set; } Type: `System.Nullable?` -### Dropdowns +### Dropdowns Gets or sets the dropdowns for the language. @@ -103,7 +101,7 @@ public System.Collections.Generic.List Drop Type: `System.Collections.Generic.List?` -### Global +### Global Gets or sets the global navigation configuration. @@ -117,7 +115,7 @@ public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } Type: `Mintlify.Core.Models.GlobalNavigationConfig?` -### Groups +### Groups Gets or sets the groups for the language. @@ -131,7 +129,7 @@ public System.Collections.Generic.List Groups Type: `System.Collections.Generic.List?` -### Hidden +### Hidden Gets or sets whether the current option is default hidden. @@ -145,7 +143,7 @@ public System.Nullable Hidden { get; set; } Type: `System.Nullable?` -### Href +### Href Gets or sets the URL or path for the language. @@ -159,7 +157,7 @@ public string Href { get; set; } Type: `string?` -### Language +### Language Gets or sets the language code in ISO 639-1 format. @@ -177,7 +175,7 @@ Type: `string` This is a required field that identifies the language. -### OpenApi +### OpenApi Gets or sets the OpenAPI configuration. @@ -191,7 +189,7 @@ public object OpenApi { get; set; } Type: `object?` -### Pages +### Pages Gets or sets the pages for the language. @@ -205,7 +203,7 @@ public System.Collections.Generic.List Pages { get; set; } Type: `System.Collections.Generic.List?` -### Tabs +### Tabs Gets or sets the tabs for the language. @@ -219,7 +217,7 @@ public System.Collections.Generic.List Tabs { ge Type: `System.Collections.Generic.List?` -### Versions +### Versions Gets or sets the versions for the language. @@ -235,7 +233,7 @@ Type: `System.Collections.Generic.List?` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -255,7 +253,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -276,7 +274,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -290,7 +288,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -304,7 +302,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -318,7 +316,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -339,7 +337,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/LogoConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/LogoConfig.mdx index 0480136..4f352e6 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/LogoConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/LogoConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['LogoConfig', 'Mintlify.Core.Models.LogoConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -28,7 +26,7 @@ Represents the logo configuration for Mintlify. ## Constructors -### .ctor +### .ctor #### Syntax @@ -36,7 +34,7 @@ Represents the logo configuration for Mintlify. public LogoConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -48,7 +46,7 @@ public Object() ## Properties -### Dark +### Dark Gets or sets the path to the dark logo file, including the file extension. @@ -62,7 +60,7 @@ public string Dark { get; set; } Type: `string?` -### Href +### Href Gets or sets the URL to redirect to when clicking the logo. If not provided, the logo will link to the homepage. @@ -77,7 +75,7 @@ public string Href { get; set; } Type: `string?` -### Light +### Light Gets or sets the path to the light logo file, including the file extension. @@ -93,7 +91,7 @@ Type: `string?` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -113,7 +111,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -134,7 +132,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -148,7 +146,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -162,7 +160,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -176,7 +174,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -197,7 +195,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the logo configuration. @@ -212,7 +210,7 @@ public override string ToString() Type: `string` The logo path or empty string. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MdxAuthConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MdxAuthConfig.mdx index 270146f..9d3b99d 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MdxAuthConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MdxAuthConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MdxAuthConfig', 'Mintlify.Core.Models.MdxAuthConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Specifies how API requests should be authenticated when using the interactive ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Specifies how API requests should be authenticated when using the interactive public MdxAuthConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Method +### Method Gets or sets the authentication method. @@ -82,7 +80,7 @@ Valid values are: "bearer", "basic", "key", "cobo". - key: API key authentication (custom header) - cobo: Cobo-specific authentication -### Name +### Name Gets or sets the name of the authentication header or parameter. @@ -112,7 +110,7 @@ For "key" authentication method, this specifies the header name (e.g., "x-api-ke ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -153,7 +151,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -167,7 +165,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -181,7 +179,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -195,7 +193,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -216,7 +214,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MdxConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MdxConfig.mdx index 5ba8f06..692ef0b 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MdxConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MdxConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MdxConfig', 'Mintlify.Core.Models.MdxConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ This configuration allows manual definition of API endpoints in individual MDX f ## Constructors -### .ctor +### .ctor #### Syntax @@ -41,7 +39,7 @@ This configuration allows manual definition of API endpoints in individual MDX f public MdxConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -53,7 +51,7 @@ public Object() ## Properties -### Auth +### Auth Gets or sets the authentication configuration for MDX-based API requests. @@ -72,7 +70,7 @@ Type: `Mintlify.Core.Models.MdxAuthConfig?` Defines the authentication method and parameters required for API calls made from the documentation playground. -### Server +### Server Gets or sets the base server URL(s) for API requests. @@ -103,7 +101,7 @@ Can be a single string URL or an array of URLs for multiple base endpoints. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -123,7 +121,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -144,7 +142,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -158,7 +156,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -172,7 +170,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -186,7 +184,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -207,7 +205,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MenuConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MenuConfig.mdx index 89421bd..ef4057f 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MenuConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MenuConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MenuConfig', 'Mintlify.Core.Models.MenuConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Menu items appear as dropdown menu options within tabs. ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Menu items appear as dropdown menu options within tabs. public MenuConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Description +### Description Gets or sets the description of the menu item. @@ -70,7 +68,7 @@ Type: `string?` Provides additional descriptive text for the menu item. -### Groups +### Groups Gets or sets the groups for the menu item. @@ -84,7 +82,7 @@ public System.Collections.Generic.List Groups Type: `System.Collections.Generic.List?` -### Icon +### Icon Gets or sets the icon to be displayed for the menu item. @@ -98,7 +96,7 @@ public Mintlify.Core.Models.IconConfig Icon { get; set; } Type: `Mintlify.Core.Models.IconConfig?` -### Item +### Item Gets or sets the name of the menu item. @@ -116,7 +114,7 @@ Type: `string` This is a required field that appears as the menu item label. -### Pages +### Pages Gets or sets the pages for the menu item. @@ -136,7 +134,7 @@ Pages can be strings (page paths) or nested GroupConfig objects. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -156,7 +154,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -191,7 +189,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -205,7 +203,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -219,7 +217,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -240,7 +238,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MergeOptions.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MergeOptions.mdx index 89d4a1f..2caa6d2 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MergeOptions.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/MergeOptions.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MergeOptions', 'Mintlify.Core.Models.MergeOptions', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -28,7 +26,7 @@ Defines merging as combining two navigation structures into one integrated struc ## Constructors -### .ctor +### .ctor #### Syntax @@ -36,7 +34,7 @@ Defines merging as combining two navigation structures into one integrated struc public MergeOptions() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -48,7 +46,7 @@ public Object() ## Properties -### AddRootPagesToGettingStarted +### AddRootPagesToGettingStarted Gets or sets whether to add newly discovered root-level pages to the "Getting Started" group instead of the root level. This is used when merging discovered navigation into template navigation. @@ -65,7 +63,7 @@ public bool AddRootPagesToGettingStarted { get; set; } Type: `bool` -### CombineEmptyGroups +### CombineEmptyGroups Gets or sets whether to combine groups with empty string names at the same navigation level. When true, multiple groups with empty names will be merged into a single group. @@ -83,7 +81,7 @@ Type: `bool` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -103,7 +101,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -124,7 +122,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -138,7 +136,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -152,7 +150,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -166,7 +164,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -187,7 +185,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavbarConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavbarConfig.mdx index 6bcfe50..58d32b0 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavbarConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavbarConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['NavbarConfig', 'Mintlify.Core.Models.NavbarConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls the content and appearance of the top navigation bar ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls the content and appearance of the top navigation bar public NavbarConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Links +### Links Gets or sets the list of navigation links to display in the navbar. @@ -71,7 +69,7 @@ Type: `System.Collections.Generic.List?` Each link should have a label, optional icon, and href pointing to the destination. These links appear in the top navigation bar of the documentation site. -### Primary +### Primary Gets or sets the primary call-to-action configuration in the navbar. @@ -93,7 +91,7 @@ Can be a button configuration with type "button", label, and href properties, ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -113,7 +111,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -134,7 +132,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -148,7 +146,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -162,7 +160,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -176,7 +174,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -197,7 +195,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavbarLink.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavbarLink.mdx index 6699210..3fcde8c 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavbarLink.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavbarLink.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['NavbarLink', 'Mintlify.Core.Models.NavbarLink', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Each navbar link consists of a label, optional icon, and destination URL. ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Each navbar link consists of a label, optional icon, and destination URL. public NavbarLink() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Href +### Href Gets or sets the destination URL for the navigation link. @@ -71,7 +69,7 @@ Type: `string?` Can be an absolute URL (https://example.com) or a relative path (/docs/page). This determines where users navigate when clicking the link. -### Icon +### Icon Gets or sets the icon to display alongside the navigation link. @@ -91,7 +89,7 @@ Can be a string icon name from the configured icon library, or an object with detailed icon configuration including style and library properties. The icon appears before the label text. -### Label +### Label Gets or sets the display text for the navigation link. @@ -112,7 +110,7 @@ This text appears in the navbar and should be concise and descriptive ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -153,7 +151,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -167,7 +165,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -181,7 +179,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -195,7 +193,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -216,7 +214,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationConfig.mdx index d8e28f7..564e428 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['NavigationConfig', 'Mintlify.Core.Models.NavigationConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This is a required field that defines the structure of your documentation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This is a required field that defines the structure of your documentation. public NavigationConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Anchors +### Anchors Gets or sets the anchors in the navigation. @@ -66,7 +64,7 @@ public System.Collections.Generic.List Anchor Type: `System.Collections.Generic.List?` -### Dropdowns +### Dropdowns Gets or sets the dropdowns in the navigation. @@ -80,7 +78,7 @@ public System.Collections.Generic.List Drop Type: `System.Collections.Generic.List?` -### Global +### Global Gets or sets global navigation items that appear on all sections and pages. @@ -94,7 +92,7 @@ public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } Type: `Mintlify.Core.Models.GlobalNavigationConfig?` -### Groups +### Groups Gets or sets the groups in the navigation. @@ -108,7 +106,7 @@ public System.Collections.Generic.List Groups Type: `System.Collections.Generic.List?` -### Languages +### Languages Gets or sets the languages in the navigation. @@ -122,7 +120,7 @@ public System.Collections.Generic.List Lang Type: `System.Collections.Generic.List?` -### Pages +### Pages Gets or sets the pages in the navigation. @@ -140,7 +138,7 @@ Type: `System.Collections.Generic.List?` Pages can be either strings (page paths) or nested GroupConfig objects. -### Products +### Products Gets or sets the products in the navigation. @@ -158,7 +156,7 @@ Type: `System.Collections.Generic.List?` Products separate documentation into distinct product-specific sections. -### Tabs +### Tabs Gets or sets the tabs in the navigation. @@ -172,7 +170,7 @@ public System.Collections.Generic.List Tabs { ge Type: `System.Collections.Generic.List?` -### Versions +### Versions Gets or sets the versions in the navigation. @@ -188,7 +186,7 @@ Type: `System.Collections.Generic.List?` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -208,7 +206,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -229,7 +227,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -243,7 +241,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -257,7 +255,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -271,7 +269,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -292,7 +290,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationContainerBase.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationContainerBase.mdx index 0b77264..cfece37 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationContainerBase.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationContainerBase.mdx @@ -6,8 +6,6 @@ tag: "ABSTRACT" keywords: ['NavigationContainerBase', 'Mintlify.Core.Models.NavigationContainerBase', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationItemBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Extends NavigationItemBase to add support for nested groups and external URLs. ## Constructors -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -43,7 +41,7 @@ Extends NavigationItemBase to add support for nested groups and external URLs. protected NavigationItemBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -55,7 +53,7 @@ public Object() ## Properties -### AsyncApi +### AsyncApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -76,7 +74,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Groups +### Groups Gets or sets the groups for this navigation container. @@ -94,7 +92,7 @@ Type: `System.Collections.Generic.List?` Groups organize pages into labeled sections within this navigation container. -### Hidden +### Hidden Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -114,7 +112,7 @@ Type: `System.Nullable?` When true, this navigation item will not be displayed in the navigation by default. -### Href +### Href Gets or sets the URL or path for this navigation container. @@ -132,7 +130,7 @@ Type: `string?` Can be used to link to an external URL or specify a path for this container. -### Icon +### Icon Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -153,7 +151,7 @@ Type: `Mintlify.Core.Models.IconConfig?` Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project. -### OpenApi +### OpenApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -174,7 +172,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Pages +### Pages Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -196,7 +194,7 @@ Pages can be strings (page paths) or nested GroupConfig objects for hierarchical ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -216,7 +214,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -237,7 +235,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -251,7 +249,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -265,7 +263,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -279,7 +277,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -300,7 +298,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationItemBase.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationItemBase.mdx index 6a27505..ec286eb 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationItemBase.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationItemBase.mdx @@ -6,8 +6,6 @@ tag: "ABSTRACT" keywords: ['NavigationItemBase', 'Mintlify.Core.Models.NavigationItemBase', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -33,7 +31,7 @@ Provides common properties shared across all navigation elements including ## Constructors -### .ctor +### .ctor Inherited Inherited from `object` @@ -45,7 +43,7 @@ public Object() ## Properties -### AsyncApi +### AsyncApi Gets or sets the AsyncAPI configuration. @@ -64,7 +62,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Hidden +### Hidden Gets or sets whether the current option is default hidden. @@ -82,7 +80,7 @@ Type: `System.Nullable?` When true, this navigation item will not be displayed in the navigation by default. -### Icon +### Icon Gets or sets the icon to be displayed in the section. @@ -101,7 +99,7 @@ Type: `Mintlify.Core.Models.IconConfig?` Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project. -### OpenApi +### OpenApi Gets or sets the OpenAPI configuration. @@ -120,7 +118,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Pages +### Pages Gets or sets the pages for this navigation item. @@ -140,7 +138,7 @@ Pages can be strings (page paths) or nested GroupConfig objects for hierarchical ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -160,7 +158,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -209,7 +207,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -223,7 +221,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -244,7 +242,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationSectionBase.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationSectionBase.mdx index 1cf6552..8627972 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationSectionBase.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/NavigationSectionBase.mdx @@ -6,8 +6,6 @@ tag: "ABSTRACT" keywords: ['NavigationSectionBase', 'Mintlify.Core.Models.NavigationSectionBase', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationContainerBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -34,7 +32,7 @@ Extends NavigationContainerBase to add support for colors, descriptions, ## Constructors -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -44,7 +42,7 @@ Extends NavigationContainerBase to add support for colors, descriptions, protected NavigationContainerBase() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -54,7 +52,7 @@ protected NavigationContainerBase() protected NavigationItemBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -66,7 +64,7 @@ public Object() ## Properties -### AsyncApi +### AsyncApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -87,7 +85,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Color +### Color Gets or sets the color configuration for this navigation section. @@ -105,7 +103,7 @@ Type: `Mintlify.Core.Models.ColorPairConfig?` Defines the primary and secondary colors used for this section's visual styling. -### Description +### Description Gets or sets the description of this navigation section. @@ -123,7 +121,7 @@ Type: `string?` Provides additional descriptive text about this navigation section. -### Dropdowns +### Dropdowns Gets or sets the dropdowns for this navigation section. @@ -141,7 +139,7 @@ Type: `System.Collections.Generic.List?` Dropdowns create expandable menu sections within this navigation section. -### Global +### Global Gets or sets global navigation items that appear on all sections and pages. @@ -159,7 +157,7 @@ Type: `Mintlify.Core.Models.GlobalNavigationConfig?` Global navigation items persist across different tabs and pages for consistent navigation. -### Groups +### Groups Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -179,7 +177,7 @@ Type: `System.Collections.Generic.List?` Groups organize pages into labeled sections within this navigation container. -### Hidden +### Hidden Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -199,7 +197,7 @@ Type: `System.Nullable?` When true, this navigation item will not be displayed in the navigation by default. -### Href +### Href Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -219,7 +217,7 @@ Type: `string?` Can be used to link to an external URL or specify a path for this container. -### Icon +### Icon Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -240,7 +238,7 @@ Type: `Mintlify.Core.Models.IconConfig?` Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project. -### Languages +### Languages Gets or sets the languages for this navigation section. @@ -258,7 +256,7 @@ Type: `System.Collections.Generic.List?` Allows partitioning navigation into different language-specific versions. -### OpenApi +### OpenApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -279,7 +277,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Pages +### Pages Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -299,7 +297,7 @@ Type: `System.Collections.Generic.List?` Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. -### Versions +### Versions Gets or sets the versions for this navigation section. @@ -319,7 +317,7 @@ Allows partitioning navigation into different version-specific documentation. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -339,7 +337,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -360,7 +358,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -374,7 +372,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -388,7 +386,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -402,7 +400,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -423,7 +421,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig.mdx index e0ea2ac..434da10 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['PrimaryNavigationConfig', 'Mintlify.Core.Models.PrimaryNavigationConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -28,7 +26,7 @@ Represents the primary navigation configuration for Mintlify navbar. ## Constructors -### .ctor +### .ctor Initializes a new instance of the [PrimaryNavigationConfig](/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig) class. @@ -38,7 +36,7 @@ Initializes a new instance of the [PrimaryNavigationConfig](/api-reference/Mintl public PrimaryNavigationConfig() ``` -### .ctor +### .ctor Initializes a new instance of the [PrimaryNavigationConfig](/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig) class for a button. @@ -55,7 +53,7 @@ public PrimaryNavigationConfig(string label, string href) | `label` | `string` | The button label. | | `href` | `string` | The button href URL. | -### .ctor +### .ctor Initializes a new instance of the [PrimaryNavigationConfig](/api-reference/Mintlify/Core/Models/PrimaryNavigationConfig) class for GitHub. @@ -71,7 +69,7 @@ public PrimaryNavigationConfig(string href) |------|------|-------------| | `href` | `string` | The GitHub URL. | -### .ctor +### .ctor Inherited Inherited from `object` @@ -83,7 +81,7 @@ public Object() ## Properties -### Href +### Href Gets or sets the href URL for the navigation item. @@ -97,7 +95,7 @@ public string Href { get; set; } Type: `string?` -### Label +### Label Gets or sets the label text for button-type navigation items. @@ -111,7 +109,7 @@ public string Label { get; set; } Type: `string?` -### Type +### Type Gets or sets the type of navigation item (e.g., "button", "github"). @@ -127,7 +125,7 @@ Type: `string?` ## Methods -### Button +### Button Creates a button-type navigation configuration. @@ -149,7 +147,7 @@ public static Mintlify.Core.Models.PrimaryNavigationConfig Button(string label, Type: `Mintlify.Core.Models.PrimaryNavigationConfig` A PrimaryNavigationConfig configured as a button. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -169,7 +167,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -190,7 +188,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -204,7 +202,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -218,7 +216,7 @@ public System.Type GetType() Type: `System.Type` -### GitHub +### GitHub Creates a GitHub-type navigation configuration. @@ -239,7 +237,7 @@ public static Mintlify.Core.Models.PrimaryNavigationConfig GitHub(string href) Type: `Mintlify.Core.Models.PrimaryNavigationConfig` A PrimaryNavigationConfig configured for GitHub. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -253,7 +251,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -274,7 +272,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the navigation configuration. @@ -289,7 +287,7 @@ public override string ToString() Type: `string` The href URL or empty string. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ProductConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ProductConfig.mdx index a4689a0..a6f01c8 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ProductConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ProductConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ProductConfig', 'Mintlify.Core.Models.ProductConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationContainerBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Products separate documentation into distinct product-specific sections. ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Products separate documentation into distinct product-specific sections. public ProductConfig() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -50,7 +48,7 @@ public ProductConfig() protected NavigationContainerBase() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -60,7 +58,7 @@ protected NavigationContainerBase() protected NavigationItemBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -72,7 +70,7 @@ public Object() ## Properties -### AsyncApi +### AsyncApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -93,7 +91,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Description +### Description Gets or sets the description of the product. @@ -111,7 +109,7 @@ Type: `string?` Provides additional context about the product section. -### Groups +### Groups Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -131,7 +129,7 @@ Type: `System.Collections.Generic.List?` Groups organize pages into labeled sections within this navigation container. -### Hidden +### Hidden Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -151,7 +149,7 @@ Type: `System.Nullable?` When true, this navigation item will not be displayed in the navigation by default. -### Href +### Href Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -171,7 +169,7 @@ Type: `string?` Can be used to link to an external URL or specify a path for this container. -### Icon +### Icon Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -192,7 +190,7 @@ Type: `Mintlify.Core.Models.IconConfig?` Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project. -### OpenApi +### OpenApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -213,7 +211,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Pages +### Pages Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -233,7 +231,7 @@ Type: `System.Collections.Generic.List?` Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. -### Product +### Product Gets or sets the name of the product. @@ -253,7 +251,7 @@ This is a required field that appears as the product label in navigation. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -273,7 +271,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -294,7 +292,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -308,7 +306,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -322,7 +320,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -336,7 +334,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -357,7 +355,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/RedirectConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/RedirectConfig.mdx index 131b922..8e0f4d2 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/RedirectConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/RedirectConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['RedirectConfig', 'Mintlify.Core.Models.RedirectConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration defines how requests to specific paths should be redirected ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration defines how requests to specific paths should be redirected public RedirectConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Destination +### Destination Gets or sets the destination path where requests should be redirected. @@ -72,7 +70,7 @@ Specifies where users should be redirected when they visit the source path. Can be a relative path (e.g., "/new-page") or an absolute URL (e.g., "https://example.com/page"). This is a required field. -### Permanent +### Permanent Gets or sets whether the redirect is permanent (301) or temporary (302). @@ -93,7 +91,7 @@ When true, returns a 301 (Moved Permanently) status code, indicating to search (Found) status code for temporary redirects. Permanent redirects are better for SEO when content has permanently moved. -### Source +### Source Gets or sets the source path that should be redirected. @@ -115,7 +113,7 @@ Specifies the original path that users might visit. When a request is made ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -135,7 +133,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -156,7 +154,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -170,7 +168,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -184,7 +182,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -198,7 +196,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -219,7 +217,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/SearchConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/SearchConfig.mdx index 6667865..0a6542e 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/SearchConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/SearchConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SearchConfig', 'Mintlify.Core.Models.SearchConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls the appearance and behavior of the search feature, ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls the appearance and behavior of the search feature, public SearchConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Prompt +### Prompt Gets or sets the placeholder text displayed in the search input field. @@ -73,7 +71,7 @@ This text appears in the search bar when it's empty, providing guidance ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -156,7 +154,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/SeoConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/SeoConfig.mdx index cd6b3c0..8f25048 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/SeoConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/SeoConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SeoConfig', 'Mintlify.Core.Models.SeoConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls how search engines index and display the documentati ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls how search engines index and display the documentati public SeoConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Indexing +### Indexing Gets or sets which pages should be indexed by search engines. @@ -72,7 +70,7 @@ Valid values are "navigable" (only pages in navigation) or "all" (all pages). The "navigable" setting indexes only pages that appear in the site navigation, while "all" indexes every page in the documentation. Defaults to "navigable". -### Metatags +### Metatags Gets or sets custom meta tags to be added to every page. @@ -94,7 +92,7 @@ Each key-value pair represents a meta tag name and its content. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -114,7 +112,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -135,7 +133,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -149,7 +147,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -163,7 +161,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -177,7 +175,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -198,7 +196,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ServerConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ServerConfig.mdx index e53d4d7..a45a72a 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ServerConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/ServerConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ServerConfig', 'Mintlify.Core.Models.ServerConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Server configurations can be simple URL strings or arrays of URLs for multiple e ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Server configurations can be simple URL strings or arrays of URLs for multiple e public ServerConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Url +### Url Gets or sets the single server URL. @@ -70,7 +68,7 @@ Type: `string?` Used when only a single server URL is specified. -### Urls +### Urls Gets or sets the list of server URLs. @@ -91,7 +89,7 @@ Used when multiple server URLs are provided. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -111,7 +109,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -132,7 +130,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -146,7 +144,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -160,7 +158,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -174,7 +172,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -195,7 +193,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Override Returns the string representation of the server configuration. @@ -210,7 +208,7 @@ public override string ToString() Type: `string` The primary URL or empty string. -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/StylingConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/StylingConfig.mdx index fe64753..8d7e737 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/StylingConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/StylingConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['StylingConfig', 'Mintlify.Core.Models.StylingConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ This configuration controls the visual styling of specific components such as ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This configuration controls the visual styling of specific components such as public StylingConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Codeblocks +### Codeblocks Gets or sets the code block theme. @@ -72,7 +70,7 @@ Valid values are "system" or "dark". The "system" option uses a theme that matches the current light/dark mode, while "dark" always uses a dark theme for code blocks regardless of the site's appearance mode. Defaults to "system". -### Eyebrows +### Eyebrows Gets or sets the eyebrows style for content sections. @@ -95,7 +93,7 @@ Valid values are "section" or "breadcrumbs". This controls the style of the ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -115,7 +113,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -136,7 +134,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -150,7 +148,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -164,7 +162,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -178,7 +176,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -199,7 +197,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/TabConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/TabConfig.mdx index 2e622fd..fdff75c 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/TabConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/TabConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['TabConfig', 'Mintlify.Core.Models.TabConfig', 'Mintlify.Core.Models', 'class', 'Mintlify.Core.Models.NavigationSectionBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Tabs provide top-level navigation sections in your documentation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Tabs provide top-level navigation sections in your documentation. public TabConfig() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -50,7 +48,7 @@ public TabConfig() protected NavigationSectionBase() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -60,7 +58,7 @@ protected NavigationSectionBase() protected NavigationContainerBase() ``` -### .ctor +### .ctor Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -70,7 +68,7 @@ protected NavigationContainerBase() protected NavigationItemBase() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -82,7 +80,7 @@ public Object() ## Properties -### Anchors +### Anchors Gets or sets the anchors for the tab. @@ -100,7 +98,7 @@ Type: `System.Collections.Generic.List?` Anchors provide persistent navigation items at the top of the sidebar. -### AsyncApi +### AsyncApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -121,7 +119,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files. -### Color +### Color Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -141,7 +139,7 @@ Type: `Mintlify.Core.Models.ColorPairConfig?` Defines the primary and secondary colors used for this section's visual styling. -### Description +### Description Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -161,7 +159,7 @@ Type: `string?` Provides additional descriptive text about this navigation section. -### Dropdowns +### Dropdowns Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -181,7 +179,7 @@ Type: `System.Collections.Generic.List?` Dropdowns create expandable menu sections within this navigation section. -### Global +### Global Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -201,7 +199,7 @@ Type: `Mintlify.Core.Models.GlobalNavigationConfig?` Global navigation items persist across different tabs and pages for consistent navigation. -### Groups +### Groups Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -221,7 +219,7 @@ Type: `System.Collections.Generic.List?` Groups organize pages into labeled sections within this navigation container. -### Hidden +### Hidden Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -241,7 +239,7 @@ Type: `System.Nullable?` When true, this navigation item will not be displayed in the navigation by default. -### Href +### Href Inherited Inherited from `Mintlify.Core.Models.NavigationContainerBase` @@ -261,7 +259,7 @@ Type: `string?` Can be used to link to an external URL or specify a path for this container. -### Icon +### Icon Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -282,7 +280,7 @@ Type: `Mintlify.Core.Models.IconConfig?` Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project. -### Languages +### Languages Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -302,7 +300,7 @@ Type: `System.Collections.Generic.List?` Allows partitioning navigation into different language-specific versions. -### Menu +### Menu Gets or sets the menu items for the tab. @@ -320,7 +318,7 @@ Type: `System.Collections.Generic.List?` Menu items create a dropdown menu within the tab navigation. -### OpenApi +### OpenApi Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -341,7 +339,7 @@ Type: `Mintlify.Core.Models.ApiSpecConfig?` Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files. -### Pages +### Pages Inherited Inherited from `Mintlify.Core.Models.NavigationItemBase` @@ -361,7 +359,7 @@ Type: `System.Collections.Generic.List?` Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation. -### Tab +### Tab Gets or sets the name of the tab. @@ -379,7 +377,7 @@ Type: `string` This is a required field that appears as the tab label in navigation. -### Versions +### Versions Inherited Inherited from `Mintlify.Core.Models.NavigationSectionBase` @@ -401,7 +399,7 @@ Allows partitioning navigation into different version-specific documentation. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -421,7 +419,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -442,7 +440,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -456,7 +454,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -470,7 +468,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -484,7 +482,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -505,7 +503,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/VersionConfig.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/VersionConfig.mdx index 2bed722..a0cc5b7 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/VersionConfig.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/Mintlify/Core/Models/VersionConfig.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['VersionConfig', 'Mintlify.Core.Models.VersionConfig', 'Mintlify.Core.Models', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** Mintlify.Core.dll @@ -32,7 +30,7 @@ Versions allow you to maintain multiple documentation versions. ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ Versions allow you to maintain multiple documentation versions. public VersionConfig() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### Anchors +### Anchors Gets or sets the anchors for the version. @@ -66,7 +64,7 @@ public System.Collections.Generic.List Anchor Type: `System.Collections.Generic.List?` -### AsyncApi +### AsyncApi Gets or sets the AsyncAPI configuration. @@ -80,7 +78,7 @@ public object AsyncApi { get; set; } Type: `object?` -### Default +### Default Gets or sets whether this version is the default version. @@ -94,7 +92,7 @@ public System.Nullable Default { get; set; } Type: `System.Nullable?` -### Dropdowns +### Dropdowns Gets or sets the dropdowns for the version. @@ -108,7 +106,7 @@ public System.Collections.Generic.List Drop Type: `System.Collections.Generic.List?` -### Global +### Global Gets or sets the global navigation configuration. @@ -122,7 +120,7 @@ public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; } Type: `Mintlify.Core.Models.GlobalNavigationConfig?` -### Groups +### Groups Gets or sets the groups for the version. @@ -136,7 +134,7 @@ public System.Collections.Generic.List Groups Type: `System.Collections.Generic.List?` -### Hidden +### Hidden Gets or sets whether the current option is default hidden. @@ -150,7 +148,7 @@ public System.Nullable Hidden { get; set; } Type: `System.Nullable?` -### Href +### Href Gets or sets the URL or path for the version. @@ -164,7 +162,7 @@ public string Href { get; set; } Type: `string?` -### Languages +### Languages Gets or sets the languages for the version. @@ -178,7 +176,7 @@ public System.Collections.Generic.List Lang Type: `System.Collections.Generic.List?` -### OpenApi +### OpenApi Gets or sets the OpenAPI configuration. @@ -192,7 +190,7 @@ public object OpenApi { get; set; } Type: `object?` -### Pages +### Pages Gets or sets the pages for the version. @@ -206,7 +204,7 @@ public System.Collections.Generic.List Pages { get; set; } Type: `System.Collections.Generic.List?` -### Tabs +### Tabs Gets or sets the tabs for the version. @@ -220,7 +218,7 @@ public System.Collections.Generic.List Tabs { ge Type: `System.Collections.Generic.List?` -### Version +### Version Gets or sets the name of the version. @@ -240,7 +238,7 @@ This is a required field that identifies the version. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -260,7 +258,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -281,7 +279,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -295,7 +293,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -309,7 +307,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -323,7 +321,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -344,7 +342,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Docs/api-reference/index.mdx b/src/CloudNimble.DotNetDocs.Docs/api-reference/index.mdx index accb018..4fecfd3 100644 --- a/src/CloudNimble.DotNetDocs.Docs/api-reference/index.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/api-reference/index.mdx @@ -12,6 +12,12 @@ mode: wide - [CloudNimble.DotNetDocs.Core.Renderers.YamlConverters](CloudNimble/DotNetDocs/Core/Renderers/YamlConverters) - [CloudNimble.DotNetDocs.Core.Transformers](CloudNimble/DotNetDocs/Core/Transformers) - [Microsoft.Extensions.DependencyInjection](Microsoft/Extensions/DependencyInjection) +- [CloudNimble.DotNetDocs.Mintlify](CloudNimble/DotNetDocs/Mintlify) +- [CloudNimble.DotNetDocs.Mintlify.Transformers](CloudNimble/DotNetDocs/Mintlify/Transformers) +- [CloudNimble.DotNetDocs.Tools](CloudNimble/DotNetDocs/Tools) +- [CloudNimble.DotNetDocs.Tools.Commands](CloudNimble/DotNetDocs/Tools/Commands) +- [CloudNimble.DotNetDocs.Tools.Commands.Base](CloudNimble/DotNetDocs/Tools/Commands/Base) +- [CloudNimble.DotNetDocs.Tools.Models](CloudNimble/DotNetDocs/Tools/Models) - [Mintlify.Core](Mintlify/Core) - [Mintlify.Core.Converters](Mintlify/Core/Converters) - [Mintlify.Core.Models](Mintlify/Core/Models) diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/best-practices.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/best-practices.mdz new file mode 100644 index 0000000..01a7368 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/best-practices.mdz @@ -0,0 +1,5 @@ + +# Best Practices + +Document best practices for `DocReferenceHandlerBase` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/considerations.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/considerations.mdz new file mode 100644 index 0000000..b9c78ca --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/considerations.mdz @@ -0,0 +1,5 @@ + +# Considerations + +Document considerations for `DocReferenceHandlerBase` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/examples.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/examples.mdz new file mode 100644 index 0000000..b750352 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/examples.mdz @@ -0,0 +1,9 @@ + +# Examples + +Provide examples of using `DocReferenceHandlerBase` here. + +```csharp +// Example code here +``` + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/patterns.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/patterns.mdz new file mode 100644 index 0000000..79436ef --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/patterns.mdz @@ -0,0 +1,5 @@ + +# Patterns + +Document common patterns for `DocReferenceHandlerBase` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/related-apis.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/related-apis.mdz new file mode 100644 index 0000000..db2808b --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/related-apis.mdz @@ -0,0 +1,6 @@ + +# Related APIs + +- API 1 +- API 2 + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/usage.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/usage.mdz new file mode 100644 index 0000000..1992121 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase/usage.mdz @@ -0,0 +1,5 @@ + +# Usage + +Describe how to use `DocReferenceHandlerBase` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/best-practices.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/best-practices.mdz new file mode 100644 index 0000000..b03f01c --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/best-practices.mdz @@ -0,0 +1,5 @@ + +# Best Practices + +Document best practices for `IDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/considerations.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/considerations.mdz new file mode 100644 index 0000000..68e8c4b --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/considerations.mdz @@ -0,0 +1,5 @@ + +# Considerations + +Document considerations for `IDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/examples.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/examples.mdz new file mode 100644 index 0000000..5cb8507 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/examples.mdz @@ -0,0 +1,9 @@ + +# Examples + +Provide examples of using `IDocReferenceHandler` here. + +```csharp +// Example code here +``` + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/patterns.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/patterns.mdz new file mode 100644 index 0000000..2acb208 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/patterns.mdz @@ -0,0 +1,5 @@ + +# Patterns + +Document common patterns for `IDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/related-apis.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/related-apis.mdz new file mode 100644 index 0000000..db2808b --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/related-apis.mdz @@ -0,0 +1,6 @@ + +# Related APIs + +- API 1 +- API 2 + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/usage.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/usage.mdz new file mode 100644 index 0000000..2d0c98d --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/IDocReferenceHandler/usage.mdz @@ -0,0 +1,5 @@ + +# Usage + +Describe how to use `IDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/best-practices.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/best-practices.mdz new file mode 100644 index 0000000..3e2c0d1 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/best-practices.mdz @@ -0,0 +1,5 @@ + +# Best Practices + +Document best practices for `MarkdownDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/considerations.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/considerations.mdz new file mode 100644 index 0000000..33e0ec6 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/considerations.mdz @@ -0,0 +1,5 @@ + +# Considerations + +Document considerations for `MarkdownDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/examples.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/examples.mdz new file mode 100644 index 0000000..d6d4777 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/examples.mdz @@ -0,0 +1,9 @@ + +# Examples + +Provide examples of using `MarkdownDocReferenceHandler` here. + +```csharp +// Example code here +``` + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/patterns.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/patterns.mdz new file mode 100644 index 0000000..7b14740 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/patterns.mdz @@ -0,0 +1,5 @@ + +# Patterns + +Document common patterns for `MarkdownDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/related-apis.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/related-apis.mdz new file mode 100644 index 0000000..db2808b --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/related-apis.mdz @@ -0,0 +1,6 @@ + +# Related APIs + +- API 1 +- API 2 + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/usage.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/usage.mdz new file mode 100644 index 0000000..6927438 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler/usage.mdz @@ -0,0 +1,5 @@ + +# Usage + +Describe how to use `MarkdownDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/best-practices.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/best-practices.mdz new file mode 100644 index 0000000..ed9b7df --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/best-practices.mdz @@ -0,0 +1,5 @@ + +# Best Practices + +Document best practices for `MintlifyDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/considerations.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/considerations.mdz new file mode 100644 index 0000000..d4961ce --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/considerations.mdz @@ -0,0 +1,5 @@ + +# Considerations + +Document considerations for `MintlifyDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/examples.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/examples.mdz new file mode 100644 index 0000000..3d83f62 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/examples.mdz @@ -0,0 +1,9 @@ + +# Examples + +Provide examples of using `MintlifyDocReferenceHandler` here. + +```csharp +// Example code here +``` + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/patterns.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/patterns.mdz new file mode 100644 index 0000000..4de58be --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/patterns.mdz @@ -0,0 +1,5 @@ + +# Patterns + +Document common patterns for `MintlifyDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/related-apis.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/related-apis.mdz new file mode 100644 index 0000000..db2808b --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/related-apis.mdz @@ -0,0 +1,6 @@ + +# Related APIs + +- API 1 +- API 2 + diff --git a/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/usage.mdz b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/usage.mdz new file mode 100644 index 0000000..3aed09d --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/conceptual/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler/usage.mdz @@ -0,0 +1,5 @@ + +# Usage + +Describe how to use `MintlifyDocReferenceHandler` here. + diff --git a/src/CloudNimble.DotNetDocs.Docs/docs.json b/src/CloudNimble.DotNetDocs.Docs/docs.json index 34465a1..3012710 100644 --- a/src/CloudNimble.DotNetDocs.Docs/docs.json +++ b/src/CloudNimble.DotNetDocs.Docs/docs.json @@ -39,10 +39,17 @@ "guides/index", "guides/pipeline", "guides/conceptual-docs", - "guides/deployment", - "guides/cli-reference", "guides/collections", - "guides/docsproj" + "guides/deployment", + { + "group": "References", + "icon": "book-spine", + "pages": [ + "guides/reference/index", + "guides/reference/docsproj", + "guides/reference/cli" + ] + } ] }, { @@ -57,6 +64,7 @@ "pages": [ "providers/mintlify/index", "providers/mintlify/navigation", + "providers/mintlify/collections", "providers/mintlify/dotnet-library" ] } @@ -107,13 +115,16 @@ "api-reference/CloudNimble/DotNetDocs/Core/DocNamespace", "api-reference/CloudNimble/DotNetDocs/Core/DocParameter", "api-reference/CloudNimble/DotNetDocs/Core/DocReference", + "api-reference/CloudNimble/DotNetDocs/Core/DocReferenceHandlerBase", "api-reference/CloudNimble/DotNetDocs/Core/DocType", "api-reference/CloudNimble/DotNetDocs/Core/DocTypeParameter", "api-reference/CloudNimble/DotNetDocs/Core/DocumentationManager", "api-reference/CloudNimble/DotNetDocs/Core/DocumentationReference", "api-reference/CloudNimble/DotNetDocs/Core/IDocEnricher", + "api-reference/CloudNimble/DotNetDocs/Core/IDocReferenceHandler", "api-reference/CloudNimble/DotNetDocs/Core/IDocRenderer", "api-reference/CloudNimble/DotNetDocs/Core/IDocTransformer", + "api-reference/CloudNimble/DotNetDocs/Core/MarkdownDocReferenceHandler", "api-reference/CloudNimble/DotNetDocs/Core/ProjectContext", "api-reference/CloudNimble/DotNetDocs/Core/ReferenceType", { @@ -162,6 +173,63 @@ ] } ] + }, + { + "group": "Mintlify", + "icon": "folder-tree", + "pages": [ + "api-reference/CloudNimble/DotNetDocs/Mintlify/index", + "api-reference/CloudNimble/DotNetDocs/Mintlify/DocsNavigationConfig", + "api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyDocReferenceHandler", + "api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyIcons", + "api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRenderer", + "api-reference/CloudNimble/DotNetDocs/Mintlify/MintlifyRendererOptions", + "api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationMode", + "api-reference/CloudNimble/DotNetDocs/Mintlify/NavigationType", + { + "group": "Transformers", + "icon": "folder-tree", + "pages": [ + "api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/index", + "api-reference/CloudNimble/DotNetDocs/Mintlify/Transformers/MintlifyMarkdownTransformer" + ] + } + ] + }, + { + "group": "Tools", + "icon": "folder-tree", + "pages": [ + "api-reference/CloudNimble/DotNetDocs/Tools/index", + "api-reference/CloudNimble/DotNetDocs/Tools/Program", + { + "group": "Commands", + "icon": "folder-tree", + "pages": [ + "api-reference/CloudNimble/DotNetDocs/Tools/Commands/index", + "api-reference/CloudNimble/DotNetDocs/Tools/Commands/AddCommand", + "api-reference/CloudNimble/DotNetDocs/Tools/Commands/BuildCommand", + "api-reference/CloudNimble/DotNetDocs/Tools/Commands/DocsRootCommand", + "api-reference/CloudNimble/DotNetDocs/Tools/Commands/UpdateCommand", + { + "group": "Base", + "icon": "folder-tree", + "pages": [ + "api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/index", + "api-reference/CloudNimble/DotNetDocs/Tools/Commands/Base/DocsCommandBase" + ] + } + ] + }, + { + "group": "Models", + "icon": "folder-tree", + "pages": [ + "api-reference/CloudNimble/DotNetDocs/Tools/Models/index", + "api-reference/CloudNimble/DotNetDocs/Tools/Models/NuGetVersion" + ] + } + ] } ] } diff --git a/src/CloudNimble.DotNetDocs.Docs/guides/collections.mdx b/src/CloudNimble.DotNetDocs.Docs/guides/collections.mdx index f830155..58c7d9e 100644 --- a/src/CloudNimble.DotNetDocs.Docs/guides/collections.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/guides/collections.mdx @@ -2,7 +2,7 @@ title: Documentation Collections sidebarTitle: Collections description: Combine multiple documentation projects into unified portals -icon: layer-group +icon: rectangle-vertical-history --- ## Overview @@ -37,9 +37,104 @@ After the collection completes its normal documentation generation, DotNetDocs: 5. **Saves** the final `docs.json` once with everything integrated - No complex merging logic or priorities neededjust copy files and combine navigation. This "Easy As Fuck"" design keeps collections simple and predictable. + No complex merging logic or priorities neededjust copy files and combine navigation. This "Easy AF" design keeps collections simple and predictable. +## Collection Root Content + +Most documentation collections have their own landing pages, guides, and conceptual content that serve as the "home" for the unified portal. This root content provides: + +- **Landing pages** that introduce the overall platform or product suite +- **Getting started guides** that span multiple referenced projects +- **Architecture documentation** that explains how components fit together +- **Shared resources** like images and snippets used across the collection + +### Controlling Root Navigation with MintlifyTemplate + +The `` element inside `` controls how the collection's own content appears alongside referenced documentation: + + + Configures how the collection's root content integrates with referenced documentation. + + **Attributes:** + + | Attribute | Description | Values | + |-----------|-------------|--------| + | `Mode` | How navigation groups are organized | `Unified` (single tree) or `Separated` (per-assembly) | + | `Type` | Where root content appears in navigation | `Pages` (main nav), `Tabs` (as a tab), or `Products` (as a product) | + | `Name` | Display name when using Tabs or Products | Custom string (e.g., "Platform Overview") | + + +### Navigation Type Examples + + + + Root content appears in the main navigation alongside groups. Referenced docs appear as tabs. + + ```xml + + My Platform + + + + + index;quickstart;architecture + + + + + + ``` + + + + Root content appears as its own tab, giving it equal prominence with referenced documentation. + + ```xml + + My Platform + + + + + index;quickstart + + + architecture;deployment + + + + + + ``` + + This creates a "Platform Overview" tab alongside tabs for each `DocumentationReference`. + + + + For multi-product portals where the collection itself is a product. + + ```xml + + EasyAF Suite + + + + + index;overview + + + + + + ``` + + + + + When `Type` is `Tabs` or `Products`, the `Name` attribute determines the display label. If omitted, the collection's `` value is used. + + ## Configuration ### Using DocumentationReference @@ -47,29 +142,8 @@ After the collection completes its normal documentation generation, DotNetDocs: Add `` items to your collection's `.docsproj` file, similar to how you use ``: -```xml Current (1.0.2) - - - Mintlify - true - - - - - - - - -``` - -```xml Preview (1.1.0-preview.1) - +```xml Current (1.2.0) + Mintlify true @@ -246,55 +320,33 @@ Create a unified documentation portal for a microservices architecture: **File**: `docs/MicroservicesPlatform.docsproj` -```xml Current (1.0.2) - - - - Mintlify - false - - - - Microservices Platform - quill - - #0066CC - - - - - - - - - - - - -``` - -```xml Preview (1.1.0-preview.1) - +```xml Current (1.2.0) + Mintlify false - + Microservices Platform quill #0066CC + + + + + + index;architecture + + + quickstart;deployment + + + + @@ -324,18 +376,18 @@ Create a unified documentation portal for a microservices architecture: **Resulting Structure**: ``` docs/ - introduction.md # Collection's own introduction - architecture.md # Collection's own architecture guide - services/ -  users/ # UserService documentation -   introduction.md -   api-reference/ -  orders/ # OrderService documentation -   introduction.md -   api-reference/ -  payments/ # PaymentService documentation -  notifications/ # NotificationService documentation - docs.json # Combined navigation + introduction.md # Collection's own introduction + architecture.md # Collection's own architecture guide + services/ +  users/ # UserService documentation +   introduction.md +   api-reference/ +  orders/ # OrderService documentation +   introduction.md +   api-reference/ +  payments/ # PaymentService documentation +  notifications/ # NotificationService documentation + docs.json # Combined navigation ``` ### Example 2: Multi-Product Suite @@ -345,38 +397,26 @@ Create a unified portal for related open-source products: **File**: `docs/EasyAF.Portal.docsproj` -```xml Current (1.0.2) - - - Mintlify - - EasyAF Product Suite - maple - - - - - - - - - - -``` - -```xml Preview (1.1.0-preview.1) - +```xml Current (1.2.0) + Mintlify EasyAF Product Suite maple + + + + + + index;getting-started + + + architecture;best-practices + + + + @@ -404,44 +444,39 @@ Create a unified portal for related open-source products: A collection that documents its own assemblies AND references external documentation: -```xml Current (1.0.2) - +```xml Current (1.2.0) + Mintlify true Folder - - - - - - - - -``` -```xml Preview (1.1.0-preview.1) - - - - Mintlify - true - Folder + + My Platform + + + + + + index;quickstart + + + + + + IntegrationType="Tabs" + Name="AI Plugin" /> + IntegrationType="Tabs" + Name="GitHub Plugin" /> ``` @@ -465,7 +500,7 @@ The `DocumentationReferenceResolverTask` checks: If you try to reference a project with a different `DocumentationType`, you'll see a warning: ``` -� Skipping documentation reference 'ServiceA.docsproj' because it uses 'DocFX' format. +  Skipping documentation reference 'ServiceA.docsproj' because it uses 'DocFX' format. Only 'Mintlify' documentation can be combined with Mintlify collections. Cross-format documentation combination is not currently supported. ``` diff --git a/src/CloudNimble.DotNetDocs.Docs/guides/index.mdx b/src/CloudNimble.DotNetDocs.Docs/guides/index.mdx index a214b2c..a4b441b 100644 --- a/src/CloudNimble.DotNetDocs.Docs/guides/index.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/guides/index.mdx @@ -10,22 +10,6 @@ Everything you need to master DotNetDocs, from getting started to advanced confi ## Getting Started - - Complete command-line reference for managing documentation projects and generating docs from assemblies. - - - - Configure your documentation project with MSBuild properties and customize the generation pipeline. - - Understand how DotNetDocs transforms assemblies and XML docs into rich, multi-format documentation. - - -## Advanced Topics - - Combine multiple documentation projects into unified portals for microservices, multi-product suites, and modular systems. + Combine multiple documentation projects into unified portals for microservices and multi-product suites. + + + +## Reference + + + + Complete command-line reference for managing documentation projects and generating docs from assemblies. + + + + Configure your documentation project with MSBuild properties and customize the generation pipeline. Deploy your documentation to Mintlify, GitHub Pages, Azure Static Web Apps, and other hosting platforms. - \ No newline at end of file + + diff --git a/src/CloudNimble.DotNetDocs.Docs/guides/pipeline.mdx b/src/CloudNimble.DotNetDocs.Docs/guides/pipeline.mdx index 82d09b4..9c74d30 100644 --- a/src/CloudNimble.DotNetDocs.Docs/guides/pipeline.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/guides/pipeline.mdx @@ -563,8 +563,8 @@ The `ProjectContext` class configures the entire pipeline. You can configure it - ```xml Current (1.1.0) - + ```xml Current (1.2.0) + @@ -599,46 +599,6 @@ The `ProjectContext` class configures the entire pipeline. You can configure it - - ``` - - ```xml Preview (1.2.0-preview.1) - - - - - Mintlify - true - - - Folder - - - true - false - - - Tests.Shared;*.Sdk - - - - My API Documentation - maple - - #419AC5 - #419AC5 - #3CD0E2 - - - /images/logo-light.svg - /images/logo-dark.svg - - - - - - - ``` diff --git a/src/CloudNimble.DotNetDocs.Docs/guides/reference/cli.mdx b/src/CloudNimble.DotNetDocs.Docs/guides/reference/cli.mdx new file mode 100644 index 0000000..a84b456 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/guides/reference/cli.mdx @@ -0,0 +1,586 @@ +--- +title: CLI Reference +sidebarTitle: CLI Reference +description: Complete command-line reference for the DotNetDocs CLI tool +icon: terminal +--- + +The DotNetDocs CLI provides commands to manage documentation projects and generate documentation from .NET assemblies. + + +## Commands + +### dotnet docs add + +Create and add a documentation project (`.docsproj`) to your solution. + +**Usage:** +```bash +dotnet docs add [options] +``` + +**Options:** + +| Option | Alias | Description | Default | +|--------|-------|-------------|---------| +| `--solution ` | `-s` | Path to solution file (.sln or .slnx) | Current directory search | +| `--name ` | | Name for the docs project | `{SolutionName}.Docs` | +| `--output ` | `-o` | Output directory for docs project | Project folder | +| `--type ` | `-t` | Documentation type | `Mintlify` | +| `--prerelease` | | Use latest prerelease SDK version | Latest stable version | + +**Documentation Types:** +- `Mintlify` - Mintlify documentation with MDX support (default) +- `DocFX` - DocFX documentation +- `MkDocs` - MkDocs documentation +- `Jekyll` - Jekyll documentation +- `Hugo` - Hugo documentation +- `Generic` - Generic markdown documentation + +**SDK Versioning:** + +By default, `dotnet docs add` queries NuGet.org to find the latest stable version of `DotNetDocs.Sdk` and uses it in the generated `.docsproj` file. Use `--prerelease` to get the latest preview version instead. + +```bash +# Use latest stable version (e.g., 1.0.0) +dotnet docs add + +# Use latest prerelease version (e.g., 1.0.0-preview.31) +dotnet docs add --prerelease +``` + +**Behavior:** + + + + Searches current directory for `.slnx` (preferred) or `.sln` file if not specified + + + Generates `.docsproj` file with Mintlify configuration and default theme + + + Adds project to solution in "Docs" solution folder + + + For `.slnx` files, adds `Type="C#"` attribute for proper Visual Studio support + + + +**Examples:** + + +```bash Basic Usage +# Create Mintlify docs project with latest stable SDK +dotnet docs add +``` + +```bash Prerelease Version +# Use latest prerelease SDK version +dotnet docs add --prerelease +``` + +```bash Specify Solution +# Target specific solution file +dotnet docs add --solution ../MyApp.sln +``` + +```bash Custom Type +# Create DocFX documentation project +dotnet docs add --type DocFX +``` + +```bash Custom Name +# Use custom project name +dotnet docs add --name MyCustomDocs --type MkDocs +``` + +```bash Custom Output +# Specify output directory +dotnet docs add --output ./documentation --type Hugo +``` + + +**Generated Project Template:** + + + + + ```xml Current (1.2.0) + + + Mintlify + true + Folder + true + + false + false + + Unified + + YourSolution + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + + + ``` + + + + + + ```xml Current (1.2.0) + + + DocFX + true + Folder + true + + false + false + + + ``` + + + Replace `DocFX` with your chosen documentation type (`MkDocs`, `Jekyll`, `Hugo`, or `Generic`). + + + +### dotnet docs update + +Update existing `.docsproj` files to use the latest DotNetDocs.Sdk version from NuGet. + +**Usage:** +```bash +dotnet docs update [options] +``` + +**Options:** + +| Option | Alias | Description | Default | +|--------|-------|-------------|---------| +| `--project ` | `-p` | Project name or path to .docsproj file to update | All .docsproj files in current directory | +| `--recursive` | `-r` | Search recursively in subdirectories | Current directory only | +| `--prerelease` | | Update to latest prerelease SDK version | Latest stable version | + + +The `--project` option accepts either a project name (e.g., `MyProject.Docs`) or a file path (e.g., `MyProject.Docs.docsproj` or `path/to/MyProject.Docs.docsproj`). If you provide just the project name, the tool will automatically append `.docsproj` to find the file. + + +**Behavior:** + + + + Queries NuGet.org for the latest version of DotNetDocs.Sdk (stable or prerelease) + + + Locates all .docsproj files (or a specific file if --file is specified) + + + Updates `Sdk="DotNetDocs.Sdk/X.X.X"` to the latest version in each file + + + Shows which files were updated and which were skipped + + + +**Examples:** + + +```bash Update Current Directory +# Update all .docsproj files in current directory +dotnet docs update +``` + +```bash Update Recursively +# Update all .docsproj files in current directory and subdirectories +dotnet docs update --recursive +``` + +```bash Update Specific Project +# Update a specific project by name +dotnet docs update --project MyProject.Docs + +# Or by file path +dotnet docs update --project MyProject.Docs.docsproj +``` + +```bash Update to Prerelease +# Update to latest prerelease version +dotnet docs update --prerelease --recursive +``` + + + +This command is useful when a new version of DotNetDocs.Sdk is released and you want to upgrade your documentation projects without manually editing each file. + + +### dotnet docs build + +Build documentation from .NET assemblies and XML documentation files. + +**Usage:** +```bash +dotnet docs build [options] +``` + +**Options:** + +| Option | Alias | Description | Default | Required | +|--------|-------|-------------|---------|----------| +| `--assembly-list ` | `-a` | Path to file containing assembly list | | ✅ | +| `--output ` | `-o` | Output path for documentation | | ✅ | +| `--type ` | `-t` | Documentation type | `Mintlify` | | +| `--namespace-mode ` | `-n` | Namespace organization | `File` | | +| `--api-reference-path ` | | API reference subfolder | `api-reference` | | + +**Documentation Types:** + +| Type | Description | +|------|-------------| +| `Mintlify` | Mintlify-enhanced MDX with icons, navigation, and frontmatter (default) | +| `DocFX` | DocFX-compatible documentation format | +| `MkDocs` | MkDocs-compatible documentation format | +| `Jekyll` | Jekyll-compatible documentation format | +| `Hugo` | Hugo-compatible documentation format | +| `Generic` | Generic Markdown documentation | + +**Namespace Modes:** + + + + Each namespace gets a single file. + + **Structure:** + ``` + docs/ + ├── MyNamespace.md + ├── MyNamespace.SubNamespace.md + └── MyNamespace.OtherNamespace.md + ``` + + **Best for:** Smaller projects, simpler file organization + + + + Each namespace becomes a folder with separate files per type. + + **Structure:** + ``` + docs/ + ├── MyNamespace/ + │ ├── index.md + │ ├── MyClass.md + │ ├── SubNamespace/ + │ │ ├── index.md + │ │ └── AnotherClass.md + ``` + + **Best for:** Large projects, hierarchical navigation + + + +**Assembly List File:** + +Create a text file with one assembly path per line: + +```text assemblies.txt +bin/Release/net8.0/MyProject.Core.dll +bin/Release/net8.0/MyProject.Extensions.dll +bin/Release/net8.0/MyProject.Utilities.dll +``` + + +Only assemblies with corresponding XML documentation files (`.xml`) will be processed. Assemblies without XML docs are skipped. + + +**Examples:** + + +```bash Basic Markdown +# Generate Markdown documentation +dotnet docs build \ + --assembly-list assemblies.txt \ + --output ./docs +``` + +```bash Mintlify Documentation +# Generate Mintlify MDX with docs.json +dotnet docs build \ + -a assemblies.txt \ + -o ./docs \ + --type Mintlify +``` + +```bash Folder Organization +# Use folder mode for namespaces +dotnet docs build \ + -a assemblies.txt \ + -o ./docs \ + --namespace-mode Folder +``` + +```bash DocFX Documentation +# Generate DocFX-compatible documentation +dotnet docs build \ + -a assemblies.txt \ + -o ./docs \ + --type DocFX +``` + +```bash Custom Paths +# Customize API reference path +dotnet docs build \ + -a assemblies.txt \ + -o ./docs \ + --api-reference-path reference +``` + + +## Complete Workflows + +### Quick Start Workflow + + + + ```bash + dotnet docs add + ``` + Creates `.docsproj` in your solution + + + + ```bash + dotnet build --configuration Release + ``` + Generates assemblies and XML docs + + + + ```bash + echo "bin/Release/net8.0/MyProject.dll" > assemblies.txt + ``` + List assemblies to document + + + + ```bash + dotnet docs build -a assemblies.txt -o ./docs --type Mintlify + ``` + Creates documentation files + + + + ```bash + npm i mint -g + cd docs + mint dev + ``` + View at http://localhost:3000 + + + +### Multi-Project Workflow + +For solutions with multiple projects: + + + + ```bash + dotnet build --configuration Release + ``` + + + + ```text assemblies.txt + ProjectA/bin/Release/net8.0/ProjectA.dll + ProjectB/bin/Release/net8.0/ProjectB.dll + ProjectC/bin/Release/net8.0/ProjectC.dll + ``` + + + + ```bash + dotnet docs build -a assemblies.txt -o ./docs --type Mintlify + ``` + All assemblies merged into single documentation site + + + +### CI/CD Integration + + + + ```yaml .github/workflows/docs.yml + name: Build Documentation + + on: + push: + branches: [main] + + jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Setup .NET + uses: actions/setup-dotnet@v4 + with: + dotnet-version: '8.0.x' + + - name: Install DotNetDocs CLI + run: dotnet tool install --global DotNetDocs + + - name: Build Projects + run: dotnet build --configuration Release + + - name: Generate Documentation + run: dotnet docs build -a assemblies.txt -o ./docs --type Mintlify + + - name: Deploy to Mintlify + run: | + cd docs + npx mintlify deploy + ``` + + + + ```yaml azure-pipelines.yml + trigger: + - main + + pool: + vmImage: 'ubuntu-latest' + + steps: + - task: UseDotNet@2 + inputs: + version: '8.0.x' + + - script: dotnet tool install --global DotNetDocs + displayName: 'Install DotNetDocs CLI' + + - script: dotnet build --configuration Release + displayName: 'Build Projects' + + - script: dotnet docs build -a assemblies.txt -o ./docs --type Mintlify + displayName: 'Generate Documentation' + + - task: PublishBuildArtifacts@1 + inputs: + pathToPublish: './docs' + artifactName: 'documentation' + ``` + + + +## Tips and Best Practices + + + + Enable XML documentation in your `.csproj` files: + + ```xml + + true + + ``` + + Without XML files, assemblies are skipped during documentation generation. + + + + Use relative paths in your assembly list file for portability across environments: + + ```text + # Good - relative paths + bin/Release/net8.0/MyProject.dll + + # Avoid - absolute paths + C:\Projects\MyApp\bin\Release\net8.0\MyProject.dll + ``` + + + + Choose namespace mode based on project size: + + - **File Mode**: Better for small-to-medium projects (< 50 types) + - **Folder Mode**: Better for large projects (> 50 types) + + + + Generate assembly lists dynamically in CI/CD: + + ```bash + # Find all assemblies with XML docs + find bin/Release -name "*.xml" | sed 's/.xml/.dll/' > assemblies.txt + ``` + + + +## Troubleshooting + + + + **Problem:** Assembly list file is empty or paths are incorrect + + **Solution:** + - Verify assembly paths in the list file + - Ensure you've built projects in Release mode + - Check that paths are relative to where you're running the command + + + + **Problem:** Assemblies don't have corresponding XML documentation files + + **Solution:** + - Add `true` to `.csproj` + - Rebuild projects + - Verify `.xml` files exist next to `.dll` files + + + + **Problem:** `dotnet docs add` can't find a solution file + + **Solution:** + - Run from directory containing `.sln` or `.slnx` file + - Or specify solution path: `dotnet docs add --solution path/to/solution.sln` + + + + **Problem:** Errors during documentation build + + **Solution:** + - Check that assemblies are valid .NET assemblies + - Ensure XML files match assembly structure + - Review console output for specific error messages + + + +## See Also + + + + Use MSBuild SDK for integrated documentation builds + + + + Understand how documentation generation works + + + + Learn about Mintlify-enhanced documentation + + + + View source code and report issues + + diff --git a/src/CloudNimble.DotNetDocs.Docs/guides/reference/docsproj.mdx b/src/CloudNimble.DotNetDocs.Docs/guides/reference/docsproj.mdx new file mode 100644 index 0000000..973a9b7 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/guides/reference/docsproj.mdx @@ -0,0 +1,479 @@ +--- +title: .docsproj Reference +sidebarTitle: .docsproj Reference +description: Configure your documentation project with MSBuild properties +icon: gear-complex-code +--- + +## Overview + +The `.docsproj` file is the heart of your DotNetDocs project. It uses the DotNetDocs.Sdk MSBuild SDK to configure how your documentation is generated, organized, and rendered. This guide covers all available MSBuild properties you can configure. + +## Basic Configuration + +### SDK Reference + +Every `.docsproj` file must reference the DotNetDocs.Sdk: + + +```xml Current (1.2.0) + + + +``` + + +### Essential Properties + + + The type of documentation system you're using. Supported values: + - `Mintlify` - Mintlify documentation (auto-detected from `docs.json`) + - `DocFX` - DocFX documentation (auto-detected from `docfx.json`) + - `MkDocs` - MkDocs documentation (auto-detected from `mkdocs.yml`) + - `Jekyll` - Jekyll documentation (auto-detected from `_config.yml`) + - `Hugo` - Hugo documentation (auto-detected from `hugo.toml`) + - `Generic` - Generic markdown documentation (default fallback) + + The SDK automatically detects your documentation type based on configuration files in your `DocumentationRoot`. + + + + The root directory containing your documentation files. This allows the `.docsproj` file to be in a different location than your actual documentation files. + + ```xml + $(MSBuildProjectDirectory)\..\docs\ + ``` + + + + When `true`, automatically generates API documentation from all packable projects in the solution during build. + + ```xml + true + ``` + + +## Output Configuration + +### Path Settings + + + The output directory for generated API reference documentation, relative to `DocumentationRoot`. + + ```xml + api + ``` + + + + The output directory for conceptual documentation, relative to `DocumentationRoot`. + + ```xml + guides + ``` + + +## Documentation Generation + +### Namespace Organization + + + Controls how namespaces are organized in generated documentation: + - `Folder` - Each namespace gets its own folder + - `File` - All namespaces in a single file + - `Flat` - Flat file structure without namespace hierarchy + + ```xml + Folder + ``` + + +### Content Options + + + When `true`, enables generation of conceptual documentation from XML comments. + + ```xml + true + ``` + + + + When `true`, shows placeholder content for types/members that don't have XML documentation. + + ```xml + false + ``` + + + + When `true`, displays documentation statistics during build (file counts, etc.). + + ```xml + true + ``` + + +## Mintlify-Specific Configuration + +### Navigation Settings + + + **1.1.0+**: Navigation configuration has been refactored. The `` element now uses attributes for Mode, Type, and Name. Legacy properties (`MintlifyNavigationMode`, `MintlifyNavigationType`, `MintlifyNavigationName`) are still supported for backward compatibility. + + + + Controls how API reference navigation is organized in Mintlify: + - `Unified` - Single unified navigation group + - `Separated` - Separate navigation groups per namespace/assembly + + Only applies when `DocumentationType` is `Mintlify`. + + + ```xml Current (1.0.x) + Unified + ``` + + ```xml 1.1.0+ + + + + + + + + ``` + + + + In 1.1.0 and later, use the `` attribute in `MintlifyTemplate` instead of the top-level property. + + + + + The name of the unified navigation group when using `MintlifyNavigationMode=Unified`. + + + ```xml Current (1.0.x) + API Documentation + ``` + + ```xml 1.1.0+ + + + API Documentation + ``` + + + +### Template Configuration + + + Path to an external `docs.json` template file. Auto-detected if `docs-template.json` exists in `DocumentationRoot`. + + ```xml + $(DocumentationRoot)templates\docs-template.json + ``` + + + + Inline Mintlify theme and branding configuration. This XML element allows you to configure the visual appearance and navigation structure of your Mintlify documentation. + + + ```xml Current (1.0.x) + + My Project + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + ``` + + ```xml 1.1.0+ + + My Project + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + + + + + + ``` + + + **Supported child elements:** + - `` - Project name displayed in documentation + - `` - Mintlify theme name (e.g., `maple`, `quill`, `venus`) + - `` - Color scheme configuration + - `` - Primary brand color + - `` - Light mode accent color + - `` - Dark mode accent color + - `` - **(1.1.0+)** Navigation configuration with attributes: + - `Mode` - Navigation organization mode: `Unified` (default) or `Separated` + - `Type` - Integration type: `Pages` (default), `Tabs`, or `Products` + - `Name` - Custom display name for tabs/products (optional, defaults to project name) + + + The `` element and its attributes are only available in 1.1.0 and later. For 1.0.x, use the legacy `MintlifyNavigationMode` property. + + + +## Documentation References + +The `` item allows you to combine multiple documentation projects into a single unified site. This is useful for organizations with multiple libraries or products that should share a common documentation portal. + + + References another `.docsproj` file to include in your documentation output. + + **Attributes:** + + | Attribute | Required | Description | + |-----------|----------|-------------| + | `Include` | Yes | Path to the referenced `.docsproj` file | + | `DestinationPath` | Yes | URL-friendly subfolder name for the copied content | + | `IntegrationType` | No | How to integrate navigation: `Tabs` or `Products` (default: `Tabs`) | + | `Name` | No | Display name for the navigation tab/product (defaults to project name) | + + ```xml + + + + ``` + + +### How References Are Processed + +When you include a `DocumentationReference`, the SDK: + +1. **Copies content files** to `/{DestinationPath}/` in your output +2. **Relocates shared resources** (`images/`, `snippets/`) to central locations with namespacing +3. **Rewrites internal paths** in MDX files to reference the relocated resources +4. **Merges navigation** into your `docs.json` as a Tab or Product + + + For Mintlify documentation, see [Collections](/providers/mintlify/collections) for detailed information about how path rewriting and resource relocation work. + + +### Multiple References Example + +```xml + + + Mintlify + + My Platform + + + + + index;quickstart + + + + + + + + + + + + + +``` + +## Advanced Configuration + +### Build Behavior + + + Controls whether the documentation project produces a NuGet package. Generally should remain `false` for documentation projects. + + ```xml + false + ``` + + + + Controls whether the documentation project can be published. Generally should remain `false` for documentation projects. + + ```xml + false + ``` + + + + Controls whether a NuGet package is generated during build. Generally should remain `false` for documentation projects. + + ```xml + false + ``` + + +### Project Discovery + + + Semicolon-separated list of glob patterns for excluding projects from documentation generation. + + ```xml + **/*.Tests.csproj;**/*Benchmark*.csproj + ``` + + +## Complete Example + +Here's a complete `.docsproj` file demonstrating common configuration: + + +```xml Current (1.2.0) + + + + + Mintlify + + + true + Folder + true + + + true + false + + + + My Amazing Library + maple + + #419AC5 + #419AC5 + #3CD0E2 + + + + + + + + + + +``` + + +## Environment Variables + +The SDK also respects standard MSBuild environment variables: + +- `$(Configuration)` - Build configuration (Debug/Release) +- `$(SolutionName)` - Name of the solution +- `$(SolutionFileName)` - Full filename of the solution file +- `$(MSBuildProjectDirectory)` - Directory containing the `.docsproj` file + +## Auto-Included Files + +The SDK automatically includes files based on your `DocumentationType`. You don't need to manually specify `` for these patterns: + +### Common Files (All Types) +- `README.md` +- `LICENSE*` +- `CHANGELOG*` +- `**/*.txt` +- All image files (png, jpg, gif, svg, webp, ico, pdf) +- All font files (woff, ttf, otf, eot) +- All web assets (css, scss, js, ts) + +### Mintlify-Specific +- `docs.json` +- `**/*.md`, `**/*.mdx`, `**/*.mdz` +- `api-reference/**/*` +- `conceptual/**/*` +- `overrides/**/*` +- `guides/**/*` +- `images/**/*` +- `snippets/**/*` +- `favicon.*` + +### DocFX-Specific +- `docfx.json` +- `toc.yml`, `toc.yaml` +- `**/*.yml`, `**/*.yaml` +- `articles/**/*` +- `api/**/*` +- `templates/**/*` + +### MkDocs-Specific +- `mkdocs.yml` +- `docs/**/*.md` +- `requirements.txt` +- `overrides/**/*` +- `theme/**/*` + +### Jekyll-Specific +- `_config.yml`, `_config.yaml` +- `_posts/**/*` +- `_layouts/**/*` +- `_includes/**/*` +- `_sass/**/*` +- `_data/**/*` +- `assets/**/*` +- `Gemfile*` + +### Hugo-Specific +- `hugo.toml`, `hugo.yaml`, `hugo.json` +- `config.*` +- `content/**/*` +- `layouts/**/*` +- `static/**/*` +- `themes/**/*` +- `archetypes/**/*` +- `data/**/*` +- `i18n/**/*` + +## Build Targets + +You can invoke specific documentation tasks using MSBuild targets: + +```bash +# Show available options and current configuration +dotnet build -t:DocumentationHelp + +# Show documentation statistics +dotnet build -t:DocumentationStats + +# Generate documentation explicitly +dotnet build -t:GenerateDocumentation +``` + +## Next Steps + + + + Learn how the documentation pipeline works + + + Add conceptual documentation to your project + + diff --git a/src/CloudNimble.DotNetDocs.Docs/guides/reference/index.mdx b/src/CloudNimble.DotNetDocs.Docs/guides/reference/index.mdx new file mode 100644 index 0000000..8cd34e4 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/guides/reference/index.mdx @@ -0,0 +1,70 @@ +--- +title: Reference +sidebarTitle: Overview +description: Complete technical reference for DotNetDocs SDK, CLI, and configuration +icon: book-bookmark +--- + +Detailed technical documentation for all DotNetDocs components, including the command-line interface and MSBuild SDK configuration. + +## Reference Documentation + + + + Complete command-line reference for the `dotnet easyaf` tool, including all commands, options, and usage examples. + + + + Comprehensive guide to MSBuild properties, items, and targets available in DotNetDocs.Sdk documentation projects. + + + +## Quick Reference + +### Common CLI Commands + +```bash +# Initialize a new documentation project +dotnet easyaf init -o ./docs -t mintlify + +# Generate documentation from XML comments +dotnet easyaf mintlify generate -x MyProject.xml -o ./api-reference + +# Build documentation project +dotnet build ./docs/MyProject.docsproj --configuration Release +``` + +### Essential .docsproj Properties + +| Property | Purpose | +|----------|---------| +| `DocumentationType` | Target format (Mintlify, DocFX, MkDocs, etc.) | +| `GenerateDocumentation` | Enable automatic API doc generation | +| `NamespaceMode` | Organize by Folder, File, or Flat structure | +| `ApiReferencePath` | Output directory for API documentation | + +### MSBuild Items + +| Item | Purpose | +|------|---------| +| `DocumentationReference` | Reference another documentation project for collections | +| `ProjectReference` | Reference a .NET project for API documentation | + +## See Also + + + + Return to the main Guides section + + + New to DotNetDocs? Start here + + diff --git a/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/collections.mdx b/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/collections.mdx new file mode 100644 index 0000000..706c07e --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/collections.mdx @@ -0,0 +1,219 @@ +--- +title: Documentation Collections +sidebarTitle: Collections +description: Learn how the Mintlify provider intelligently restructures combined documentation for seamless multi-project experiences +icon: rectangle-vertical-history +--- + +When combining multiple documentation projects into a unified site, the Mintlify provider goes beyond simple file copying. It automatically restructures +content, relocates shared resources, and rewrites internal paths to ensure everything works seamlessly together. + +## The Challenge + +Documentation projects (especially Mintlify-targeted ones) are typically designed as standalone sites. They reference images, snippets, and internal pages +using absolute paths like `/images/logo.png` or `/guides/quickstart`. When you combine multiple projects, these paths collide: + +```plaintext Without intelligent handling +/images/logo.png <- Which project's logo? +/snippets/Hero.jsx <- Which project's component? +/guides/quickstart <- Which project's guide? +``` + +## How Mintlify Collections Work + +The `MintlifyDocReferenceHandler` solves this by performing three key operations during the build process: + + + + Shared resource directories (`images/`, `snippets/`) are moved to central locations with project-specific namespacing: + + ```plaintext + /images/{DestinationPath}/logo.png + /snippets/{DestinationPath}/Hero.jsx + ``` + + + + All absolute paths in MDX files are automatically rewritten to reference the relocated resources and prefixed pages: + + | Original Path | Rewritten Path | + |---------------|----------------| + | `/images/logo.png` | `/images/product-1/logo.png` | + | `/snippets/Hero.jsx` | `/snippets/product-1/Hero.jsx` | + | `/guides/quickstart` | `/product-1/guides/quickstart` | + + + + The referenced project's navigation is merged into the parent's `docs.json`, appearing as a Tab or Product based on your configuration. + + + +## Supported Path Patterns + +The handler rewrites paths in all common MDX patterns: + + + + ```jsx + // Before + import { Hero } from '/snippets/Hero.jsx'; + + // After + import { Hero } from '/snippets/product-1/Hero.jsx'; + ``` + + + + ```markdown + // Before + ![Logo](/images/logo.png) + [Getting Started](/guides/quickstart) + + // After + ![Logo](/images/product-1/logo.png) + [Getting Started](/product-1/guides/quickstart) + ``` + + + + ```jsx + // Before + + + + // After + + + ``` + + + + ```jsx + // Before +
+ + // After +
+ ``` + + + + +Paths inside fenced code blocks are **not** rewritten, ensuring your documentation examples remain accurate. + + +## Output Structure + +After processing, your collection has a clean, conflict-free structure: + +```plaintext +docs/ +├── docs.json # Unified navigation +├── index.mdx # Collection landing page +├── images/ +│ ├── collection-logo.png # Collection's own images +│ ├── product-1/ # Product 1's images +│ │ ├── logo.png +│ │ └── screenshots/ +│ │ └── demo.png +│ └── product-2/ # Product 2's images +│ └── banner.png +├── snippets/ +│ ├── SharedComponent.jsx # Collection's components +│ ├── product-1/ # Product 1's snippets +│ │ └── Hero.jsx +│ └── product-2/ # Product 2's snippets +│ └── Features.jsx +├── product-1/ # Product 1's content +│ ├── index.mdx +│ └── guides/ +│ └── quickstart.mdx +└── product-2/ # Product 2's content + ├── index.mdx + └── api/ + └── overview.mdx +``` + +## Configuration Example + +```xml MyPlatform.docsproj + + + Mintlify + + My Platform + maple + + + + + index;quickstart + + + + + + + + + + + + + +``` + +## Best Practices + + + + Choose short, URL-friendly names like `product-1` rather than full project names. These become part of every URL in the referenced content. + + + + Keep images and snippets in their respective directories. The handler specifically looks for `images/` and `snippets/` folders to relocate. + + + + After building, verify that imports, images, and links resolve correctly. Check the browser console for 404 errors. + + + + Since code blocks aren't rewritten, your documentation examples will show the original paths - which is usually what you want for copy-paste accuracy. + + + +## Comparison with Base Markdown + +The Mintlify handler extends the base `MarkdownDocReferenceHandler` with additional patterns: + +| Feature | Markdown Handler | Mintlify Handler | +|---------|-----------------|------------------| +| Markdown images | Yes | Yes | +| Markdown links | Yes | Yes | +| ES imports | No | Yes | +| JSX src/href | No | Yes | +| CSS url() | No | Yes | +| .mdx files | No | Yes | + +## See Also + + + + Complete guide to Documentation Collections including configuration, integration types, and troubleshooting + + + Complete reference for the DocumentationReference tag and its properties + + + Learn how navigation from multiple projects is merged + + diff --git a/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/index.mdx b/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/index.mdx index 2dece86..81c0567 100644 --- a/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/index.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/index.mdx @@ -261,7 +261,7 @@ React components must be placed in the `snippets` folder and exported as named e ``` ```xml With MSBuild Integration (.docsproj) - + Mintlify Unified @@ -543,6 +543,12 @@ docs/ ## See Also + + Learn how Mintlify handles multi-project documentation with path rewriting and resource relocation + + + Deep dive into how Mintlify generates and merges navigation structures + Complete MintlifyRenderer API documentation diff --git a/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/navigation.mdx b/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/navigation.mdx index 06e65f5..fbbb4aa 100644 --- a/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/navigation.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/providers/mintlify/navigation.mdx @@ -342,7 +342,7 @@ Root navigation files are excluded automatically to prevent conflicts. The paren ### Complete Example: Multi-Library Collection ```xml CloudNimble.Platform.Docs.docsproj - + Mintlify Unified diff --git a/src/CloudNimble.DotNetDocs.Docs/quickstart.mdx b/src/CloudNimble.DotNetDocs.Docs/quickstart.mdx index 7ad5305..7dedb92 100644 --- a/src/CloudNimble.DotNetDocs.Docs/quickstart.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/quickstart.mdx @@ -52,44 +52,14 @@ import { ValueProposition } from '/snippets/ValueProposition.jsx'; - creates a new `{SolutionName}.Docs\{SolutionName}.Docs.docsproj` file that centralizes your documentation - adds the new project to your solution - The new project is pre-configured with sensible defaults. For Mintlify projects, it looks like this: - - + The new project is pre-configured with sensible defaults: - - ```xml - + + - - Mintlify - true - Folder - true - - false - false - - - {solutionName} - maple - - #419AC5 - #419AC5 - #3CD0E2 - - - - - - - - ``` - - - - ```xml - + ```xml Current (1.2.0) + Mintlify @@ -115,31 +85,15 @@ import { ValueProposition } from '/snippets/ValueProposition.jsx'; ``` - - - - - - ```xml - - - DocFX - true - Folder - true - - false - false - - - - ``` + - - ```xml - + + + + ```xml Current (1.2.0) + DocFX @@ -153,31 +107,15 @@ import { ValueProposition } from '/snippets/ValueProposition.jsx'; ``` - - - - - - ```xml - - - - MkDocs - true - Folder - true - - false - false - - - ``` + - - ```xml - + + + + ```xml Current (1.2.0) + MkDocs @@ -191,31 +129,15 @@ import { ValueProposition } from '/snippets/ValueProposition.jsx'; ``` - - - - - - ```xml - - - Jekyll - true - Folder - true - - false - false - - - - ``` + - - ```xml - + + + + ```xml Current (1.2.0) + Jekyll @@ -229,31 +151,15 @@ import { ValueProposition } from '/snippets/ValueProposition.jsx'; ``` - - - - - - ```xml - - - - Hugo - true - Folder - true - - false - false - - - ``` + - - ```xml - + + + + ```xml Current (1.2.0) + Hugo @@ -267,31 +173,15 @@ import { ValueProposition } from '/snippets/ValueProposition.jsx'; ``` - - - - - ```xml - - - - Generic - true - Folder - true - - false - false - - - - ``` + - - ```xml - + + + + ```xml Current (1.2.0) + Generic @@ -305,11 +195,11 @@ import { ValueProposition } from '/snippets/ValueProposition.jsx'; ``` + + - - You can see more of how to configure your .docsproj file in the [.docsproj Reference](/guides/docsproj) docs. Now your documentation lives right next to your code - no more context switching! Edit your doc files in Visual Studio with full IntelliSense support. diff --git a/src/CloudNimble.DotNetDocs.Docs/snippets/DocsBadge.jsx b/src/CloudNimble.DotNetDocs.Docs/snippets/DocsBadge.jsx deleted file mode 100644 index bd1d4c9..0000000 --- a/src/CloudNimble.DotNetDocs.Docs/snippets/DocsBadge.jsx +++ /dev/null @@ -1,35 +0,0 @@ -/** - * DocsBadge Component for Mintlify Documentation - * - * A customizable badge component that matches Mintlify's design system. - * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). - * - * Usage: - * - * - * - * - * - */ - -export function DocsBadge({ text, variant = 'neutral' }) { - // Tailwind color classes for consistent theming - // Using standard Tailwind colors that work in both light and dark modes - const variantClasses = { - success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', - neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', - info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', - warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', - danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' - }; - - const classes = variantClasses[variant] || variantClasses.neutral; - - return ( - - {text} - - ); -} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Docs/why-dotnetdocs.mdx b/src/CloudNimble.DotNetDocs.Docs/why-dotnetdocs.mdx index 702244b..07a93ef 100644 --- a/src/CloudNimble.DotNetDocs.Docs/why-dotnetdocs.mdx +++ b/src/CloudNimble.DotNetDocs.Docs/why-dotnetdocs.mdx @@ -7,39 +7,25 @@ icon: square-question ## Introduction -I've been a .NET developer for 25 years now, since the very early previews of the .NET Framework. In that time, I've seen technologies like the Web Forms, -WCF Data Services, and Silverlight come and go. I've also seen the rise of open source, the growth of the cloud, and the pervasiveness of C#. - A .NET influencer once tweeted "When I ask myself 'What would have the most impact today?' I sit down and write documentation." That has always stuck with me. -.NET has never had a truly fantastic documentation story. For a while, I had hoped DocFX would be the answer, but Microsoft kept all the best plugins for themselves and never -really contributed back to the platform in any meaningful way. I'm honestly not even sure what learn.microsoft.com is built on these days. - -Meanwhile, DocFX has languished in open source, with few contributors and even fewer updates. It's clunky, hard to customize, and frankly, a pain to use. So many hours wasted... -so much unrealized potential. - -### The Rise of AI - -In the last 18 months, documentation has gone from a "nice to have" to a requirement for AI coding tools. If the tool doesn't understand the code, it will generate shit. -Every. Single. Time. - -It happened with my own code. It happened with other libraries. Babysitting the AI so it doesn't take a wrong turn. Explaining concepts to the AI when it crashed out. Over and over -and over again. My ample forehead flatened against my desk and my hair grayer from the experience. +.NET has never had a truly fantastic documentation story. For a while, I had hoped DocFX would be the answer, but that didn't really pan out. -Which brought me back to that quote again. +AI changed everything. -A full decade since that tweet, how are .NET developers to follow that advice? GitHub Copilot can fill in your XML doc comments, but there's been -no place for them to go. +In the last 18 months, documentation has gone from a "nice to have" to a requirement for AI coding tools. If the tool doesn't understand the code, it will +generate garbage. Every. Single. Time. -### It's Time for a Change +Which brought me back to that quote. -With Claude at my fingertips, it was time to finally build the solution the .NET Ecosystem always deserved, so every .NET developer can be a better Context Engineer. +A full decade since that tweet, how are .NET developers to follow that advice? -Six weekends later, the first release is finally ready. +GitHub Copilot can fill in your XML doc comments, but there's been no truly fantastic place for them to be seen and understood. -Now *every* .NET developer can write better documentation. +With Claude at my fingertips, it was time to finally build the solution the .NET Ecosystem always deserved, so every .NET developer can be a better Context +Engineer. So try it out. Let us know what still needs work. Open up some issues and help us make this ecosystem we love that much better. diff --git a/src/CloudNimble.DotNetDocs.Mintlify/Extensions/DotNetDocsMintlify_IServiceCollectionExtensions.cs b/src/CloudNimble.DotNetDocs.Mintlify/Extensions/DotNetDocsMintlify_IServiceCollectionExtensions.cs index 8d8cbd3..243cbb1 100644 --- a/src/CloudNimble.DotNetDocs.Mintlify/Extensions/DotNetDocsMintlify_IServiceCollectionExtensions.cs +++ b/src/CloudNimble.DotNetDocs.Mintlify/Extensions/DotNetDocsMintlify_IServiceCollectionExtensions.cs @@ -120,6 +120,7 @@ public static IServiceCollection AddMintlifyServices(this IServiceCollection ser /// DocsJsonManager for manipulating docs.json files /// DocsJsonValidator to ensure correct structures /// MarkdownXmlTransformer for processing XML documentation tags + /// MintlifyDocReferenceHandler for processing DocumentationReferences /// /// /// @@ -139,6 +140,9 @@ public static IServiceCollection AddMintlifyRenderer(this IServiceCol // Register the MintlifyMarkdownTransformer for converting HTML comments to JSX comments (MDX compatibility) services.TryAddEnumerable(ServiceDescriptor.Scoped()); + // Register the MintlifyDocReferenceHandler for processing DocumentationReferences + services.TryAddEnumerable(ServiceDescriptor.Scoped()); + // Register DocsJsonManager for manipulating docs.json files services.TryAddScoped(); diff --git a/src/CloudNimble.DotNetDocs.Mintlify/MintlifyDocReferenceHandler.cs b/src/CloudNimble.DotNetDocs.Mintlify/MintlifyDocReferenceHandler.cs new file mode 100644 index 0000000..c72075b --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Mintlify/MintlifyDocReferenceHandler.cs @@ -0,0 +1,350 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using CloudNimble.DotNetDocs.Core; +using CloudNimble.DotNetDocs.Core.Configuration; + +namespace CloudNimble.DotNetDocs.Mintlify +{ + + /// + /// Handles documentation references for Mintlify documentation format. + /// + /// + /// + /// This handler extends to add Mintlify-specific + /// content rewriting patterns including ES imports, JSX attributes, and CSS url() references. + /// + /// + /// It processes referenced documentation by: + /// + /// + /// Copying content files with path rewriting + /// Relocating images to /images/{DestinationPath}/ + /// Relocating snippets to /snippets/{DestinationPath}/ + /// + /// + public partial class MintlifyDocReferenceHandler : MarkdownDocReferenceHandler + { + + #region Private Fields + + /// + /// Matches ES import statements: import X from '/snippets/X.jsx' + /// + [GeneratedRegex(@"from\s+['""](?/[^'""]+)['""]", + RegexOptions.Compiled, matchTimeoutMilliseconds: 1000)] + private static partial Regex EsImportRegex(); + + /// + /// Matches JSX src attributes: src="/images/logo.png" or src='/images/logo.png' + /// + [GeneratedRegex(@"src\s*=\s*['""](?/[^'""]+)['""]", + RegexOptions.Compiled, matchTimeoutMilliseconds: 1000)] + private static partial Regex JsxSrcRegex(); + + /// + /// Matches JSX href attributes: href="/guides/x" or href='/guides/x' + /// + [GeneratedRegex(@"href\s*=\s*['""](?/[^'""#?]+)(?[^'""]*)['""]", + RegexOptions.Compiled, matchTimeoutMilliseconds: 1000)] + private static partial Regex JsxHrefRegex(); + + /// + /// Matches CSS url() functions: url(/images/bg.svg) or url('/images/bg.svg') + /// + [GeneratedRegex(@"url\(\s*['""]?(?/[^'""\)]+)['""]?\s*\)", + RegexOptions.Compiled, matchTimeoutMilliseconds: 1000)] + private static partial Regex CssUrlRegex(); + + /// + /// File extensions that should have content rewritten. + /// + private static readonly HashSet RewriteExtensions = new(StringComparer.OrdinalIgnoreCase) + { + ".md", + ".mdx", + ".jsx", + ".tsx" + }; + + /// + /// Directories that should be relocated to central locations. + /// + private static readonly HashSet ResourceDirectoriesToRelocate = new(StringComparer.OrdinalIgnoreCase) + { + "images", + "snippets" + }; + + #endregion + + #region Properties + + /// + public override SupportedDocumentationType DocumentationType => SupportedDocumentationType.Mintlify; + + #endregion + + #region Public Methods + + /// + public override async Task ProcessAsync(DocumentationReference reference, string documentationRootPath) + { + ArgumentNullException.ThrowIfNull(reference); + ArgumentException.ThrowIfNullOrWhiteSpace(documentationRootPath); + + var sourcePath = reference.DocumentationRoot; + var destPath = Path.Combine(documentationRootPath, reference.DestinationPath); + + // Step 1: Copy and rewrite content files (excluding resource directories) + await CopyAndRewriteFilesAsync(sourcePath, destPath, reference.DestinationPath); + + // Step 2: Relocate resource directories to central locations + await RelocateResourcesAsync(sourcePath, documentationRootPath, reference.DestinationPath); + } + + #endregion + + #region Internal Methods + + /// + /// Copies files from source to destination with content path rewriting. + /// + /// The source directory. + /// The destination directory. + /// The destination path prefix for rewriting. + /// A task representing the asynchronous operation. + internal async Task CopyAndRewriteFilesAsync(string sourceDir, string destDir, string destinationPath) + { + if (!Directory.Exists(sourceDir)) + { + return; + } + + // Get exclusion patterns and add resource directories to exclude + var exclusionPatterns = GetExclusionPatternsForDocumentationType(SupportedDocumentationType.Mintlify); + + // Add resource directories to exclusion (they get relocated separately) + foreach (var resourceDir in ResourceDirectoriesToRelocate) + { + exclusionPatterns.Add($"{resourceDir}/**/*"); + } + + // Ensure destination directory exists + Directory.CreateDirectory(destDir); + + await CopyDirectoryWithRewritingAsync(sourceDir, destDir, sourceDir, destinationPath, exclusionPatterns); + } + + /// + /// Rewrites content with Mintlify-specific patterns in addition to base Markdown. + /// + /// The content to rewrite. + /// The destination path prefix. + /// The rewritten content. + internal string RewriteMintlifyContent(string content, string destinationPath) + { + if (string.IsNullOrWhiteSpace(content) || string.IsNullOrWhiteSpace(destinationPath)) + { + return content; + } + + // First apply base Markdown rewriting + content = RewriteMarkdownContent(content, destinationPath); + + // Find code block ranges for skipping + var codeBlockRanges = FindCodeBlockRangesInternal(content); + + // Rewrite ES imports: from '/snippets/X.jsx' + content = EsImportRegex().Replace(content, match => + { + if (IsInCodeBlock(match.Index, codeBlockRanges)) + { + return match.Value; + } + + var path = match.Groups["path"].Value; + var rewrittenPath = RewritePath(path, destinationPath); + + return $"from '{rewrittenPath}'"; + }); + + // Rewrite JSX src attributes + content = JsxSrcRegex().Replace(content, match => + { + if (IsInCodeBlock(match.Index, codeBlockRanges)) + { + return match.Value; + } + + var path = match.Groups["path"].Value; + var rewrittenPath = RewritePath(path, destinationPath); + + return $"src=\"{rewrittenPath}\""; + }); + + // Rewrite JSX href attributes + content = JsxHrefRegex().Replace(content, match => + { + if (IsInCodeBlock(match.Index, codeBlockRanges)) + { + return match.Value; + } + + var path = match.Groups["path"].Value; + var suffix = match.Groups["suffix"].Value; + var rewrittenPath = RewritePath(path, destinationPath); + + return $"href=\"{rewrittenPath}{suffix}\""; + }); + + // Rewrite CSS url() functions + content = CssUrlRegex().Replace(content, match => + { + if (IsInCodeBlock(match.Index, codeBlockRanges)) + { + return match.Value; + } + + var path = match.Groups["path"].Value; + var rewrittenPath = RewritePath(path, destinationPath); + + return $"url({rewrittenPath})"; + }); + + return content; + } + + #endregion + + #region Private Methods + + /// + /// Recursively copies a directory with content rewriting. + /// + private async Task CopyDirectoryWithRewritingAsync( + string sourceDir, + string destDir, + string baseSourceDir, + string destinationPath, + List exclusionPatterns) + { + if (!Directory.Exists(sourceDir)) + { + return; + } + + Directory.CreateDirectory(destDir); + + // Get all files to copy + var files = Directory.GetFiles(sourceDir); + var filesToProcess = files + .Select(sourceFile => new + { + SourceFile = sourceFile, + RelativePath = Path.GetRelativePath(baseSourceDir, sourceFile).Replace("\\", "/"), + DestFile = Path.Combine(destDir, Path.GetFileName(sourceFile)), + Extension = Path.GetExtension(sourceFile) + }) + .Where(f => !ShouldExcludeFile(f.RelativePath, exclusionPatterns)) + .ToList(); + + // Process files + await Parallel.ForEachAsync(filesToProcess, async (fileInfo, ct) => + { + await Task.Run(() => + { + if (RewriteExtensions.Contains(fileInfo.Extension)) + { + // Read, rewrite, and write content + var content = File.ReadAllText(fileInfo.SourceFile); + var rewrittenContent = RewriteMintlifyContent(content, destinationPath); + File.WriteAllText(fileInfo.DestFile, rewrittenContent); + } + else + { + // Just copy the file + File.Copy(fileInfo.SourceFile, fileInfo.DestFile, overwrite: true); + } + }, ct); + }); + + // Get subdirectories to process + var subDirectories = Directory.GetDirectories(sourceDir) + .Select(subDir => new + { + SourceSubDir = subDir, + RelativePath = Path.GetRelativePath(baseSourceDir, subDir).Replace("\\", "/"), + DestSubDir = Path.Combine(destDir, Path.GetFileName(subDir)) + }) + .Where(d => !ShouldExcludeDirectory(d.RelativePath, exclusionPatterns)) + .Where(d => !ResourceDirectoriesToRelocate.Contains(Path.GetFileName(d.SourceSubDir))) + .ToList(); + + // Recursively process subdirectories + await Parallel.ForEachAsync(subDirectories, async (dirInfo, ct) => + { + await CopyDirectoryWithRewritingAsync( + dirInfo.SourceSubDir, + dirInfo.DestSubDir, + baseSourceDir, + destinationPath, + exclusionPatterns); + }); + } + + /// + /// Finds all fenced code block ranges in the content. + /// + /// The content to analyze. + /// A list of tuples representing (start, end) positions of code blocks. + private List<(int Start, int End)> FindCodeBlockRangesInternal(string content) + { + var ranges = new List<(int Start, int End)>(); + var lines = content.Split('\n'); + var currentPosition = 0; + var inCodeBlock = false; + var codeBlockStart = 0; + var currentFence = ""; + + foreach (var line in lines) + { + var trimmedLine = line.TrimStart(); + if (trimmedLine.StartsWith("```") || trimmedLine.StartsWith("~~~")) + { + var fenceChar = trimmedLine[0]; + if (!inCodeBlock) + { + inCodeBlock = true; + codeBlockStart = currentPosition; + currentFence = fenceChar.ToString(); + } + else if (trimmedLine.StartsWith(currentFence + currentFence + currentFence) || + (trimmedLine.Length >= 3 && trimmedLine.Substring(0, 3) == new string(fenceChar, 3))) + { + inCodeBlock = false; + ranges.Add((codeBlockStart, currentPosition + line.Length)); + currentFence = ""; + } + } + + currentPosition += line.Length + 1; + } + + if (inCodeBlock) + { + ranges.Add((codeBlockStart, content.Length)); + } + + return ranges; + } + + #endregion + + } + +} diff --git a/src/CloudNimble.DotNetDocs.Mintlify/MintlifyRenderer.cs b/src/CloudNimble.DotNetDocs.Mintlify/MintlifyRenderer.cs index a38e265..5dabfc5 100644 --- a/src/CloudNimble.DotNetDocs.Mintlify/MintlifyRenderer.cs +++ b/src/CloudNimble.DotNetDocs.Mintlify/MintlifyRenderer.cs @@ -69,59 +69,67 @@ public MintlifyRenderer( /// /// Renders the documentation assembly to MDX files with optional docs.json generation. /// - /// The documentation assembly to render. + /// The documentation assembly to render, or null for documentation-only mode. /// A task representing the asynchronous rendering operation. - public async Task RenderAsync(DocAssembly model) + public async Task RenderAsync(DocAssembly? model) { - ArgumentNullException.ThrowIfNull(model); - - var apiOutputPath = Path.Combine(Context.DocumentationRootPath, Context.ApiReferencePath); - Console.WriteLine($"📝 Rendering documentation to: {apiOutputPath}"); - - // Initialize DocsJsonManager if enabled (only on first call) - DocsJsonConfig? docsConfig = null; - if (_options.GenerateDocsJson && _docsJsonManager is not null) + // If model is not null, generate API reference files + if (model is not null) { - // Only initialize if not already configured - if (_docsJsonManager.Configuration is null) - { - docsConfig = _options.Template ?? DocsJsonManager.CreateDefault( - model.AssemblyName ?? "API Documentation", - "mint" - ); - // Load configuration directly without JSON round-trip - _docsJsonManager.Load(docsConfig); - } - else + var apiOutputPath = Path.Combine(Context.DocumentationRootPath, Context.ApiReferencePath); + Console.WriteLine($"📝 Rendering documentation to: {apiOutputPath}"); + + // Initialize DocsJsonManager if enabled (only on first call) + if (_options.GenerateDocsJson && _docsJsonManager is not null) { - docsConfig = _docsJsonManager.Configuration; + // Only initialize if not already configured + if (_docsJsonManager.Configuration is null) + { + var docsConfig = _options.Template ?? DocsJsonManager.CreateDefault( + model.AssemblyName ?? "API Documentation", + "mint" + ); + // Load configuration directly without JSON round-trip + _docsJsonManager.Load(docsConfig); + } } - } - // Ensure all necessary directories exist based on the file naming mode - Context.EnsureOutputDirectoryStructure(model, apiOutputPath); + // Ensure all necessary directories exist based on the file naming mode + Context.EnsureOutputDirectoryStructure(model, apiOutputPath); - // Create DocsBadge component snippet for Mintlify (used by inherited/extension member badges) - await CreateDocsBadgeSnippetAsync(); + // Create DocsBadge component snippet for Mintlify (used by inherited/extension member badges) + // RWM: This returns a no-op for now but the code is commented out in case we want to do other snippets. + await CreateDocsBadgeSnippetAsync(); - // Render assembly overview - await RenderAssemblyAsync(model, apiOutputPath); - - // Render each namespace - foreach (var ns in model.Namespaces) - { - await RenderNamespaceAsync(ns, apiOutputPath); + // Render assembly overview + await RenderAssemblyAsync(model, apiOutputPath); - // Render each type in the namespace - foreach (var type in ns.Types) + // Render each namespace + foreach (var ns in model.Namespaces) { - await RenderTypeAsync(type, ns, apiOutputPath); + await RenderNamespaceAsync(ns, apiOutputPath); + + // Render each type in the namespace + foreach (var type in ns.Types) + { + await RenderTypeAsync(type, ns, apiOutputPath); + } } } - // Generate docs.json if enabled - if (_options.GenerateDocsJson && _docsJsonManager is not null && _docsJsonManager.Configuration is not null) + // Generate docs.json if enabled - runs even without a model for documentation-only mode + if (_options.GenerateDocsJson && _docsJsonManager is not null) { + // Initialize from template if not already configured + if (_docsJsonManager.Configuration is null) + { + var docsConfig = _options.Template ?? DocsJsonManager.CreateDefault( + model?.AssemblyName ?? "Documentation", + "mint" + ); + _docsJsonManager.Load(docsConfig); + } + // Build exclusion list from DocumentationReference DestinationPaths to prevent scanning output directories var excludeDirectories = Context.DocumentationReferences .Select(r => Path.GetFileName(r.DestinationPath)) @@ -132,8 +140,11 @@ public async Task RenderAsync(DocAssembly model) // Exclude DocumentationReference output directories to prevent them from being treated as conceptual docs _docsJsonManager.PopulateNavigationFromPath(Context.DocumentationRootPath, new[] { ".mdx" }, includeApiReference: false, preserveExisting: true, excludeDirectories: excludeDirectories); - // Second: Add API reference content to existing navigation - BuildNavigationStructure(_docsJsonManager.Configuration, model); + // Second: Add API reference content to existing navigation ONLY if model exists + if (model is not null) + { + BuildNavigationStructure(_docsJsonManager.Configuration!, model); + } // Third: Apply NavigationType from template to move root content to Tabs/Products if configured ApplyNavigationType(); @@ -635,11 +646,12 @@ internal string GenerateFrontmatter(DocEntity entity, DocNamespace? parentNamesp sb.AppendLine(); // Add snippet import for DocType pages to support DocsBadge component - if (entity is DocType) - { - sb.AppendLine("import { DocsBadge } from '/snippets/DocsBadge.jsx';"); - sb.AppendLine(); - } + // RWM: Commenting this out for now but leaving it in case we want to use other snippets + //if (entity is DocType) + //{ + // sb.AppendLine("import { DocsBadge } from '/snippets/DocsBadge.jsx';"); + // sb.AppendLine(); + //} return sb.ToString(); } @@ -1271,33 +1283,33 @@ internal void RenderMember(StringBuilder sb, DocMember member) if (member.IsExtensionMethod) { - badges.Add(""); + badges.Add("Extension"); } if (member.IsInherited && !member.IsOverride) { - badges.Add(""); + badges.Add("Inherited"); } if (member.IsOverride) { - badges.Add(""); + badges.Add("Override"); } if (member.IsVirtual && !member.IsOverride) { - badges.Add(""); + badges.Add("Virtual"); } if (member.IsAbstract) { - badges.Add(""); + badges.Add("Abstract"); } var badgeString = badges.Any() ? " " + string.Join(" ", badges) : ""; // Add the member header with icon including iconType, color, size, and margin - sb.AppendLine($"### {member.Name}{badgeString}"); + sb.AppendLine($"### {member.Name}{badgeString}"); sb.AppendLine(); // Add provenance note if inherited or extension @@ -1548,50 +1560,51 @@ private GroupConfig FindOrCreateAssemblyGroup(DocsJsonConfig config, string asse /// A task representing the asynchronous file write operation. internal async Task CreateDocsBadgeSnippetAsync() { - var snippetsPath = Path.Combine(Context.DocumentationRootPath, "snippets"); - Directory.CreateDirectory(snippetsPath); - - var badgeFilePath = Path.Combine(snippetsPath, "DocsBadge.jsx"); - - var badgeComponent = """ -/** - * DocsBadge Component for Mintlify Documentation - * - * A customizable badge component that matches Mintlify's design system. - * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). - * - * Usage: - * - * - * - * - * - */ - -export function DocsBadge({ text, variant = 'neutral' }) { - // Tailwind color classes for consistent theming - // Using standard Tailwind colors that work in both light and dark modes - const variantClasses = { - success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', - neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', - info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', - warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', - danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' - }; - - const classes = variantClasses[variant] || variantClasses.neutral; - - return ( - - {text} - - ); -} -"""; - - await File.WriteAllTextAsync(badgeFilePath, badgeComponent); + // var snippetsPath = Path.Combine(Context.DocumentationRootPath, "snippets"); + // Directory.CreateDirectory(snippetsPath); + + // var badgeFilePath = Path.Combine(snippetsPath, "DocsBadge.jsx"); + + // var badgeComponent = """ + //** + // * DocsBadge Component for Mintlify Documentation + // * + // * A customizable badge component that matches Mintlify's design system. + // * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). + // * + // * Usage: + // * + // * + // * + // * + // * + // */ + + //export function DocsBadge({ text, variant = 'neutral' }) { + // // Tailwind color classes for consistent theming + // // Using standard Tailwind colors that work in both light and dark modes + // const variantClasses = { + // success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', + // neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', + // info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', + // warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', + // danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' + // }; + + // const classes = variantClasses[variant] || variantClasses.neutral; + + // return ( + // + // {text} + // + // ); + //} + //"""; + + // await File.WriteAllTextAsync(badgeFilePath, badgeComponent + await Task.CompletedTask; } #endregion diff --git a/src/CloudNimble.DotNetDocs.Reference.Mintlify/CloudNimble.DotNetDocs.Reference.Mintlify.docsproj b/src/CloudNimble.DotNetDocs.Reference.Mintlify/CloudNimble.DotNetDocs.Reference.Mintlify.docsproj index 128bd30..a4091d8 100644 --- a/src/CloudNimble.DotNetDocs.Reference.Mintlify/CloudNimble.DotNetDocs.Reference.Mintlify.docsproj +++ b/src/CloudNimble.DotNetDocs.Reference.Mintlify/CloudNimble.DotNetDocs.Reference.Mintlify.docsproj @@ -1,4 +1,4 @@ - + Mintlify true diff --git a/src/CloudNimble.DotNetDocs.Sdk.Tasks/CloudNimble.DotNetDocs.Sdk.Tasks.csproj b/src/CloudNimble.DotNetDocs.Sdk.Tasks/CloudNimble.DotNetDocs.Sdk.Tasks.csproj index b834fb6..85a1283 100644 --- a/src/CloudNimble.DotNetDocs.Sdk.Tasks/CloudNimble.DotNetDocs.Sdk.Tasks.csproj +++ b/src/CloudNimble.DotNetDocs.Sdk.Tasks/CloudNimble.DotNetDocs.Sdk.Tasks.csproj @@ -5,25 +5,24 @@ net10.0;net9.0;net8.0;net472 false MSBuild tasks for CloudNimble.DotNetDocs.Sdk - + false false - + $(NoWarn);CS2008;NU1701 - + true + true - - - + - + diff --git a/src/CloudNimble.DotNetDocs.Sdk.Tasks/GenerateDocumentationTask.cs b/src/CloudNimble.DotNetDocs.Sdk.Tasks/GenerateDocumentationTask.cs index 336cd1f..7516bc3 100644 --- a/src/CloudNimble.DotNetDocs.Sdk.Tasks/GenerateDocumentationTask.cs +++ b/src/CloudNimble.DotNetDocs.Sdk.Tasks/GenerateDocumentationTask.cs @@ -302,11 +302,24 @@ public override bool Execute() var serviceProvider = services.BuildServiceProvider(); var manager = serviceProvider.GetRequiredService(); - // Collect all valid assembly paths + // Check if we have DocumentationReferences + var hasReferences = documentationReferences.Count > 0; + + // Collect all valid assembly paths, skipping malformed paths from empty MSBuild batching var assemblyPairs = new List<(string assemblyPath, string xmlPath)>(); foreach (var assembly in Assemblies) { var assemblyPath = assembly.ItemSpec; + + // Skip malformed paths from empty ItemGroup batching (e.g., "bin\Debug\\.dll") + if (string.IsNullOrWhiteSpace(assemblyPath) || + assemblyPath.EndsWith("\\.dll", StringComparison.OrdinalIgnoreCase) || + assemblyPath.EndsWith("/.dll", StringComparison.OrdinalIgnoreCase)) + { + Log.LogMessage(MessageImportance.Low, $"Skipping malformed assembly path: {assemblyPath}"); + continue; + } + var xmlPath = Path.ChangeExtension(assemblyPath, ".xml"); if (!File.Exists(assemblyPath)) @@ -319,12 +332,18 @@ public override bool Execute() assemblyPairs.Add((assemblyPath, xmlPath)); } - if (assemblyPairs.Count == 0) + // Handle different scenarios based on what we have + if (assemblyPairs.Count == 0 && !hasReferences) { - Log.LogWarning("No valid assemblies found to process"); + Log.LogMessage(MessageImportance.High, "No assemblies or documentation references found. Nothing to process."); return true; } + if (assemblyPairs.Count == 0 && hasReferences) + { + Log.LogMessage(MessageImportance.High, "📚 Documentation-only mode: Processing DocumentationReferences without local assemblies"); + } + // Process all assemblies together to properly merge navigation Log.LogMessage(MessageImportance.High, $" 📚 Processing {assemblyPairs.Count} assemblies together for merged output..."); diff --git a/src/CloudNimble.DotNetDocs.Sdk/CloudNimble.DotNetDocs.Sdk.csproj b/src/CloudNimble.DotNetDocs.Sdk/CloudNimble.DotNetDocs.Sdk.csproj index 2a6f12c..8991847 100644 --- a/src/CloudNimble.DotNetDocs.Sdk/CloudNimble.DotNetDocs.Sdk.csproj +++ b/src/CloudNimble.DotNetDocs.Sdk/CloudNimble.DotNetDocs.Sdk.csproj @@ -1,4 +1,4 @@ - + @@ -17,14 +17,17 @@ false - + true + + + $(TargetsForTfmSpecificContentInPackage);IncludeNoTargetsInPackage - + @@ -103,18 +106,20 @@ - - + + $(PkgMicrosoft_Build_NoTargets)\Sdk - + - + + Sdk\NoTargets\%(RecursiveDir)%(Filename)%(Extension) + - - + + \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Sdk/Sdk/Sdk.props b/src/CloudNimble.DotNetDocs.Sdk/Sdk/Sdk.props index c1cdb5a..13e8d63 100644 --- a/src/CloudNimble.DotNetDocs.Sdk/Sdk/Sdk.props +++ b/src/CloudNimble.DotNetDocs.Sdk/Sdk/Sdk.props @@ -65,31 +65,17 @@ <_SolutionName Condition="'$(SolutionName)' == '' AND '$(SolutionFileName)' != ''">$([System.IO.Path]::GetFileNameWithoutExtension('$(SolutionFileName)')) <_SolutionName Condition="'$(_SolutionName)' == ''">Documentation - - $([System.IO.Path]::GetTempPath())$(_SolutionName)\$(MSBuildProjectName)\obj\ - $([System.IO.Path]::GetTempPath())$(_SolutionName)\$(MSBuildProjectName)\bin\ + + $([System.IO.Path]::GetTempPath())$(_SolutionName)\$(MSBuildProjectName)\obj\ + $([System.IO.Path]::GetTempPath())$(_SolutionName)\$(MSBuildProjectName)\bin\ $(BaseIntermediateOutputPath) $(BaseOutputPath) $(BaseIntermediateOutputPath) - - - - - - - - - <_NoTargetsFallbackPath>$(UserProfile)\.nuget\packages\microsoft.build.notargets\3.7.0\Sdk\Sdk.props - - <_NoTargetsFallbackPath Condition="!Exists('$(_NoTargetsFallbackPath)')">$(NuGetPackageRoot)microsoft.build.notargets\3.7.0\Sdk\Sdk.props - - - - + + + diff --git a/src/CloudNimble.DotNetDocs.Sdk/Sdk/Sdk.targets b/src/CloudNimble.DotNetDocs.Sdk/Sdk/Sdk.targets index afe107b..b4f6a69 100644 --- a/src/CloudNimble.DotNetDocs.Sdk/Sdk/Sdk.targets +++ b/src/CloudNimble.DotNetDocs.Sdk/Sdk/Sdk.targets @@ -6,23 +6,9 @@ Includes validation, generation, and integration targets. ============================================================================ --> - - - - - - - - - <_NoTargetsTargetsFallbackPath>$(UserProfile)\.nuget\packages\microsoft.build.notargets\3.7.0\Sdk\Sdk.targets - - <_NoTargetsTargetsFallbackPath Condition="!Exists('$(_NoTargetsTargetsFallbackPath)')">$(NuGetPackageRoot)microsoft.build.notargets\3.7.0\Sdk\Sdk.targets - - - - + + + @@ -107,7 +93,8 @@ - + + diff --git a/src/CloudNimble.DotNetDocs.Sdk/readme.md b/src/CloudNimble.DotNetDocs.Sdk/readme.md index 737ea74..98ab92b 100644 --- a/src/CloudNimble.DotNetDocs.Sdk/readme.md +++ b/src/CloudNimble.DotNetDocs.Sdk/readme.md @@ -16,7 +16,7 @@ The MSBuild SDK for documentation projects (`.docsproj`) that provides a clean w - 📁 **Clean Folders** - No `bin/obj` folders cluttering your documentation directories - 🔍 **Auto-Detection** - Automatically detects documentation type (Mintlify, DocFX, MkDocs, Jekyll, Hugo) - 📝 **Smart Includes** - Automatically includes relevant files based on documentation type -- 🛠️ **Integration** - Optional build targets for linting, preview, and deployment +- 🛠️ **API Generation** - Generate API documentation from XML comments on build - 🎯 **Visual Studio** - Full IntelliSense and editing support in Visual Studio ## Quick Start @@ -34,7 +34,7 @@ The MSBuild SDK for documentation projects (`.docsproj`) that provides a clean w ### 1. Create a .docsproj file ```xml - + ``` @@ -70,31 +70,42 @@ The SDK automatically detects your documentation type based on configuration fil ### Basic Options ```xml - + Mintlify - - true - true + + true + + true + + + Folder ``` -### Advanced Options +### Mintlify Options ```xml - + - - true - true - - - true - true + + Unified + + + **/*.Tests.csproj;**/*Benchmark*.csproj + + + + My Project + maple + + #419AC5 + + ``` @@ -104,13 +115,13 @@ The SDK automatically detects your documentation type based on configuration fil If your `.docsproj` file is in a different location than your documentation files (e.g., project in `src/` but docs in `docs/`), use the `DocumentationRoot` property: ```xml - + $(MSBuildThisFileDirectory)..\..\docs\ - + - true + true true @@ -127,16 +138,11 @@ This is particularly useful when you want to: |--------|-------------| | `DocumentationHelp` | Show available options and current configuration | | `DocumentationStats` | Display statistics about your documentation | -| `GenerateMintlifyDocs` | Generate Mintlify documentation (requires EasyAF.Tools) | -| `LintMarkdown` | Lint markdown files for issues | -| `PreviewDocumentation` | Start local preview server | -| `ValidateLinks` | Check for broken links | -| `GeneratePdf` | Generate PDF output | -| `DeployDocumentation` | Deploy to hosting platform | +| `GenerateDocumentation` | Generate API documentation from assemblies | ### DotNetDocs Integration -The SDK automatically generates documentation when `GenerateMintlifyDocs` is enabled. Documentation is built from your project's assemblies and XML documentation files. +The SDK automatically generates documentation when `GenerateDocumentation` is enabled. Documentation is built from your project's assemblies and XML documentation files. ### Usage Examples @@ -144,14 +150,11 @@ The SDK automatically generates documentation when `GenerateMintlifyDocs` is ena # Show help and current configuration dotnet build -t:DocumentationHelp -# Show documentation statistics +# Show documentation statistics dotnet build -t:DocumentationStats -# Generate Mintlify docs manually -dotnet build -t:GenerateMintlifyDocs - -# Start preview server -dotnet build -t:PreviewDocumentation +# Generate documentation (runs automatically on build when enabled) +dotnet build -t:GenerateDocumentation ``` ## Integration Examples @@ -159,14 +162,16 @@ dotnet build -t:PreviewDocumentation ### Mintlify Project ```xml - + - - true - - - true + + true + + true + + + Folder ``` @@ -174,7 +179,7 @@ dotnet build -t:PreviewDocumentation ### Multi-Format Project ```xml - + Generic @@ -193,7 +198,7 @@ dotnet build -t:PreviewDocumentation ```yaml # GitHub Actions example - name: Build Documentation - run: dotnet build docs/MyProject.Docs.docsproj -p:DeployDocumentation=true + run: dotnet build docs/MyProject.Docs.docsproj --configuration Release ``` ## Benefits Over Manual Configuration diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManagerTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManagerTests.cs index 4df722a..e41eedb 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManagerTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManagerTests.cs @@ -315,12 +315,12 @@ public async Task DocumentAsync_ProducesConsistentBaseline() var json = SerializeToJson(result); // Compare against baseline - var baselinePath = Path.Combine("..", "..", "..", "Baselines", "AssemblyManager", "BasicAssembly.json"); + var baselinePath = Path.Combine(projectPath, "Baselines", framework, "AssemblyManager", "BasicAssembly.json"); var fullPath = Path.GetFullPath(baselinePath); if (File.Exists(baselinePath)) { - var baseline = await File.ReadAllTextAsync(baselinePath); + var baseline = await File.ReadAllTextAsync(baselinePath, TestContext.CancellationToken); // Normalize line endings for cross-platform compatibility var normalizedJson = json.ReplaceLineEndings(Environment.NewLine); @@ -345,8 +345,8 @@ public async Task GenerateAssemblyBaseline(string projectPath) var xmlPath = Path.ChangeExtension(assemblyPath, ".xml"); var manager = new AssemblyManager(assemblyPath, xmlPath); - var directory = Path.Combine(projectPath, "Baselines", "AssemblyManager"); - + var directory = Path.Combine(projectPath, "Baselines", framework, "AssemblyManager"); + if (!Directory.Exists(directory)) { Directory.CreateDirectory(directory); diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_CreateExternalTypeReference_DetailedTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_CreateExternalTypeReference_DetailedTests.cs index 5dcb09b..498ea3d 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_CreateExternalTypeReference_DetailedTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_CreateExternalTypeReference_DetailedTests.cs @@ -240,7 +240,7 @@ public async Task CreateExternalTypeReference_ReusesExistingType_WhenKeyExists() .Where(t => t.Name == "List" && t.IsExternalReference) .ToList(); - listTypes.Should().HaveCount(1, "Should reuse existing external type instead of creating duplicates"); + listTypes.Should().ContainSingle("Should reuse existing external type instead of creating duplicates"); // And it should have all the extension methods var listType = listTypes.First(); diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_ExtensionMethodsTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_ExtensionMethodsTests.cs index e557c73..bbe4308 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_ExtensionMethodsTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_ExtensionMethodsTests.cs @@ -282,7 +282,7 @@ public async Task CreateExternalTypeReference_ReusesSameExternalType_ForMultiple // Should only have ONE List type even though multiple extensions target it var listTypes = systemNamespace!.Types.Where(t => t.Name == "List").ToList(); - listTypes.Should().HaveCount(1, "Should reuse same external type for multiple extensions"); + listTypes.Should().ContainSingle("Should reuse same external type for multiple extensions"); // But it should have all three extension methods var listType = listTypes.First(); diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_HelperMethodsTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_HelperMethodsTests.cs index f2af716..1877c2d 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_HelperMethodsTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_HelperMethodsTests.cs @@ -33,10 +33,11 @@ private CSharpCompilation CreateCompilation(string source, string assemblyName = private System.Collections.Generic.IEnumerable GetMetadataReferences() { - var refs = new System.Collections.Generic.List(); - - // Add reference to mscorlib/System.Private.CoreLib - refs.Add(MetadataReference.CreateFromFile(typeof(object).Assembly.Location)); + var refs = new System.Collections.Generic.List + { + // Add reference to mscorlib/System.Private.CoreLib + MetadataReference.CreateFromFile(typeof(object).Assembly.Location) + }; // Add reference to System.Runtime var systemRuntimePath = System.IO.Path.Combine( @@ -185,7 +186,7 @@ public class Derived : Base { } var baseReference = baseCompilation.ToMetadataReference(); var derivedCompilation = CSharpCompilation.Create( "DerivedAssembly", - new[] { CSharpSyntaxTree.ParseText(derivedSource) }, + new[] { CSharpSyntaxTree.ParseText(derivedSource, cancellationToken: TestContext.CancellationToken) }, new[] { baseReference }.Concat(GetMetadataReferences()), new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)); @@ -272,7 +273,7 @@ public class Derived : Base { } var baseReference = baseCompilation.ToMetadataReference(); var derivedCompilation = CSharpCompilation.Create( "DerivedAssembly", - new[] { CSharpSyntaxTree.ParseText(derivedSource) }, + new[] { CSharpSyntaxTree.ParseText(derivedSource, cancellationToken: TestContext.CancellationToken) }, new[] { baseReference }.Concat(GetMetadataReferences()), new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)); diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_RelocateExtensionMethods_DetailedTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_RelocateExtensionMethods_DetailedTests.cs index f34fce4..4feae98 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_RelocateExtensionMethods_DetailedTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/AssemblyManager_RelocateExtensionMethods_DetailedTests.cs @@ -147,7 +147,7 @@ public async Task RelocateExtensionMethods_ReusesExternalType_WhenMultipleExtens .Where(t => t.Name == "List" && t.IsExternalReference) .ToList(); - listTypes.Should().HaveCount(1, "Should only create one external reference even with multiple extensions"); + listTypes.Should().ContainSingle("Should only create one external reference even with multiple extensions"); // Should have multiple extension methods on the single List type if (listTypes.Any()) diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/AssemblyManager/BasicAssembly.json b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/AssemblyManager/BasicAssembly.json index 7c58518..c716447 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/AssemblyManager/BasicAssembly.json +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/AssemblyManager/BasicAssembly.json @@ -22,6 +22,83 @@ "isExtensionMethod": false, "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.projectPath" }, + { + "accessibility": "public", + "memberKind": "field", + "name": "framework", + "parameters": [], + "returnTypeName": "string", + "signature": "public const string framework", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_TestContext", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "MSTest.TestFramework.Extensions", + "fullName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "name": "TestContext", + "signature": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "typeKind": "error", + "isExternalReference": true, + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext" + }, + "returnTypeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "signature": "public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_TestContext", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "MSTest.TestFramework.Extensions", + "fullName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "name": "TestContext", + "signature": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "typeKind": "error", + "isExternalReference": true, + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext" + }, + "typeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void TestContext.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set" + }, { "accessibility": "public", "memberKind": "method", @@ -63,6 +140,21 @@ "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", "isExtensionMethod": false, "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "TestContext", + "parameters": [], + "returnTypeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "signature": "public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext" } ], "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", @@ -8286,7 +8378,8 @@ "typeKind": "error", "isExternalReference": true, "displayName": "System.Collections.Generic.List", - "summary": "This type is defined in System.Collections. See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.collections.generic.list{t}) for complete API reference." + "remarks": "See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.collections.generic.list{t}) for more information about the rest of the API.", + "summary": "This type is defined in System.Collections." } ], "displayName": "System.Collections.Generic" @@ -8423,7 +8516,8 @@ "typeKind": "class", "isExternalReference": true, "displayName": "string", - "summary": "This type is defined in System.Private.CoreLib. See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.string) for complete API reference." + "remarks": "See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.string) for more information about the rest of the API.", + "summary": "This type is defined in System.Private.CoreLib." } ], "displayName": "System" diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md index b0c42be..aeef0ea 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md @@ -24,6 +24,20 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase public DotNetDocsTestBase() ``` +## Properties + +### TestContext + +#### Syntax + +```csharp +public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } +``` + +#### Property Value + +Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` + ## Methods ### GetTestsDotSharedAssembly diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md index b0c42be..aeef0ea 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md @@ -24,6 +24,20 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase public DotNetDocsTestBase() ``` +## Properties + +### TestContext + +#### Syntax + +```csharp +public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } +``` + +#### Property Value + +Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` + ## Methods ### GetTestsDotSharedAssembly diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml index 2fb33bc..9e9d880 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml @@ -16,6 +16,42 @@ types: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -40,6 +76,13 @@ types: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FileMode/documentation.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FileMode/documentation.yaml index cf653fb..5ecab20 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FileMode/documentation.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FileMode/documentation.yaml @@ -18,6 +18,42 @@ namespaces: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -42,6 +78,13 @@ namespaces: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml index 2fb33bc..9e9d880 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml @@ -16,6 +16,42 @@ types: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -40,6 +76,13 @@ types: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FolderMode/documentation.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FolderMode/documentation.yaml index cf653fb..5ecab20 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FolderMode/documentation.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net10.0/YamlRenderer/FolderMode/documentation.yaml @@ -18,6 +18,42 @@ namespaces: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -42,6 +78,13 @@ namespaces: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/AssemblyManager/BasicAssembly.json b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/AssemblyManager/BasicAssembly.json new file mode 100644 index 0000000..f99c89f --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/AssemblyManager/BasicAssembly.json @@ -0,0 +1,8528 @@ +{ + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "namespaces": [ + { + "name": "CloudNimble.DotNetDocs.Tests.Shared", + "types": [ + { + "baseType": "CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "projectPath", + "parameters": [], + "returnTypeName": "string", + "signature": "public const string projectPath", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.projectPath" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "framework", + "parameters": [], + "returnTypeName": "string", + "signature": "public const string framework", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_TestContext", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "MSTest.TestFramework.Extensions", + "fullName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "name": "TestContext", + "signature": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "typeKind": "error", + "isExternalReference": true, + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext" + }, + "returnTypeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "signature": "public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_TestContext", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "MSTest.TestFramework.Extensions", + "fullName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "name": "TestContext", + "signature": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "typeKind": "error", + "isExternalReference": true, + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext" + }, + "typeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void TestContext.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetTestsDotSharedAssembly", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Core", + "fullName": "CloudNimble.DotNetDocs.Core.DocAssembly", + "name": "DocAssembly", + "signature": "CloudNimble.DotNetDocs.Core.DocAssembly", + "typeKind": "error", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Core.DocAssembly" + }, + "returnTypeName": "CloudNimble.DotNetDocs.Core.DocAssembly", + "signature": "public CloudNimble.DotNetDocs.Core.DocAssembly GetTestsDotSharedAssembly()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.GetTestsDotSharedAssembly()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public DotNetDocsTestBase()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "TestContext", + "parameters": [], + "returnTypeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "signature": "public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "name": "DotNetDocsTestBase", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "relatedApis": [] + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Name", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Name.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Name.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Name", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Name.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Name.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Value", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int Value.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Value.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Value", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Value.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Value.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "DoSomething", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "input", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string input", + "usage": "The input parameter." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string DoSomething(string input)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.DoSomething(string)", + "returns": "The result of the operation.", + "summary": "Performs a sample operation." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetDisplay", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string GetDisplay()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.GetDisplay()", + "returns": "A formatted string containing the name and value.", + "summary": "Gets the display value." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithOptional", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "required", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string required", + "usage": "Required parameter." + }, + { + "defaultValue": "42", + "hasDefaultValue": true, + "isOptional": true, + "isParams": false, + "name": "optional", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int optional", + "usage": "Optional parameter with default value." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithOptional(string required, int optional = 42)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.MethodWithOptional(string, int)", + "returns": "Combined result.", + "summary": "Method with optional parameter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithParams", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": true, + "name": "values", + "parameterType": { + "members": [], + "fullName": "int[]", + "name": "", + "signature": "int[]", + "typeKind": "array", + "isExternalReference": true, + "displayName": "int[]" + }, + "typeName": "int[]", + "displayName": "params int[] values", + "usage": "Variable number of values." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int MethodWithParams(params int[] values)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.MethodWithParams(params int[])", + "returns": "Sum of values.", + "summary": "Method with params array." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public SampleClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.SampleClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Name", + "parameters": [], + "returnTypeName": "string", + "signature": "public string Name { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Name", + "summary": "Gets or sets the name." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Value", + "parameters": [], + "returnTypeName": "int", + "signature": "public int Value { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Value", + "summary": "Gets or sets the value." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "name": "SampleClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "relatedApis": [], + "summary": "A sample class for testing documentation generation." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers", + "types": [ + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "PublicField", + "parameters": [], + "returnTypeName": "string", + "signature": "public string PublicField", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicField", + "summary": "A public field." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_PublicProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string PublicProperty.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_PublicProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void PublicProperty.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "PublicMethod", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string PublicMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicMethod()", + "returns": "A string indicating this is a public method.", + "summary": "A public method." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public MixedAccessClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.MixedAccessClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "PublicProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public string PublicProperty { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicProperty", + "summary": "Gets or sets the public property." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "name": "MixedAccessClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "relatedApis": [], + "remarks": "This class tests the IncludedMembers filtering functionality.", + "summary": "A class with members of various access modifiers for testing filtering." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios", + "types": [ + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_BaseProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public virtual string BaseProperty.get", + "isInherited": false, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_BaseProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public virtual void BaseProperty.set", + "isInherited": false, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "VirtualMethod", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public virtual string VirtualMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.VirtualMethod()", + "returns": "A string value.", + "summary": "A virtual method that can be overridden." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "BaseMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void BaseMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseMethod()", + "summary": "A method in the base class." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public BaseClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "BaseProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public virtual string BaseProperty { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty", + "summary": "Gets or sets the base property." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "name": "BaseClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "relatedApis": [], + "remarks": "This class serves as the base for DerivedClass.", + "summary": "A base class for testing inheritance documentation." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Calculate", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "a", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int a", + "usage": "The first number." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "b", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int b", + "usage": "The second number." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int Calculate(int a, int b)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.Calculate(int, int)", + "examples": "\r\n var result = Calculate(3, 4); // Returns 7\r\n ", + "returns": "The sum of a and b.", + "summary": "Calculates the sum of two numbers." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Process", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "input", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string input", + "usage": "The string to process." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Process(string input)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.Process(string)", + "exceptions": [ + { + "description": "Thrown when input is null.", + "type": "ArgumentNullException" + } + ], + "remarks": "This method performs a simple transformation for testing purposes.", + "returns": "The processed string in uppercase.", + "summary": "Processes the input string." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "PerformAction", + "parameters": [], + "returnTypeName": "void", + "signature": "public void PerformAction()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.PerformAction()", + "remarks": "This method doesn't return anything.", + "summary": "A void method that performs an action." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetConditionalValue", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "condition", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "typeName": "bool", + "displayName": "bool condition", + "usage": "The condition to evaluate." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string GetConditionalValue(bool condition)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.GetConditionalValue(bool)", + "returns": "Returns \"Yes\" if condition is true, \"No\" otherwise.", + "summary": "Gets a value based on a condition." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithMethods()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.ClassWithMethods()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "name": "ClassWithMethods", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "examples": "\r\n var obj = new ClassWithMethods();\r\n var result = obj.Calculate(5, 10);\r\n ", + "relatedApis": [], + "remarks": "Contains methods with different signatures, parameters, and return types.", + "summary": "A class demonstrating various method documentation scenarios." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Name", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Name.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Name.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Name", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Name.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Name.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Id", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int Id.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Id.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Value", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "double", + "name": "Double", + "signature": "double", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "double" + }, + "returnTypeName": "double", + "signature": "public double Value.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Value.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "UpdateValue", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "newValue", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "double", + "name": "Double", + "signature": "double", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "double" + }, + "typeName": "double", + "displayName": "double newValue", + "usage": "The new value to set." + } + ], + "returnTypeName": "void", + "signature": "public void UpdateValue(double newValue)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.UpdateValue(double)", + "summary": "Updates the value property." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithProperties()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.ClassWithProperties()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Name", + "parameters": [], + "returnTypeName": "string", + "signature": "public string Name { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Name", + "remarks": "This is a standard public property with get and set accessors.", + "summary": "Gets or sets the name." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Id", + "parameters": [], + "returnTypeName": "int", + "signature": "public int Id { get; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Id", + "remarks": "This property can only be read, not written to.", + "summary": "Gets the read-only identifier." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Value", + "parameters": [], + "returnTypeName": "double", + "signature": "public double Value { get; private set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Value", + "remarks": "This property can be read publicly but only set within the class.", + "summary": "Gets or sets the value with a private setter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "name": "ClassWithProperties", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "relatedApis": [], + "remarks": "This class contains properties with different access modifiers and documentation styles.", + "summary": "A class demonstrating various property documentation scenarios." + }, + { + "baseType": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_DerivedProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string DerivedProperty.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_DerivedProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void DerivedProperty.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_BaseProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public override string BaseProperty.get", + "isInherited": false, + "isOverride": true, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "overriddenMember": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.get", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.BaseProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_BaseProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public override void BaseProperty.set", + "isInherited": false, + "isOverride": true, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "overriddenMember": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.set", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.BaseProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "VirtualMethod", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public override string VirtualMethod()", + "isInherited": false, + "isOverride": true, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "overriddenMember": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.VirtualMethod()", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.VirtualMethod()", + "remarks": "This method provides custom behavior for the derived class.", + "returns": "A string indicating the derived implementation.", + "summary": "Overrides the virtual method from the base class." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "DerivedMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void DerivedMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedMethod()", + "summary": "An additional method in the derived class." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public DerivedClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "DerivedProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public string DerivedProperty { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedProperty", + "summary": "Gets or sets the derived property." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "BaseProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public override string BaseProperty { get; set; }", + "isInherited": false, + "isOverride": true, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "overriddenMember": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.BaseProperty", + "remarks": "This property overrides the base implementation.", + "summary": "Gets or sets the base property with overridden behavior." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_BaseProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public virtual string BaseProperty.get", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_BaseProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public virtual void BaseProperty.set", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "VirtualMethod", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public virtual string VirtualMethod()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.VirtualMethod()", + "returns": "A string value.", + "summary": "A virtual method that can be overridden." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "BaseMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void BaseMethod()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseMethod()", + "summary": "A method in the base class." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public BaseClass()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "BaseProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public virtual string BaseProperty { get; set; }", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty", + "summary": "Gets or sets the base property." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "name": "DerivedClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "examples": "\r\n var derived = new DerivedClass();\r\n var result = derived.VirtualMethod();\r\n ", + "relatedApis": [], + "remarks": "This class inherits from BaseClass and overrides some members.", + "summary": "A derived class for testing inheritance documentation." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_ResourceName", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string ResourceName.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.ResourceName.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_ResourceName", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void ResourceName.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.ResourceName.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Dispose", + "parameters": [], + "returnTypeName": "void", + "signature": "public void Dispose()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.Dispose()", + "remarks": "Implements the IDisposable pattern.", + "summary": "Disposes the resources used by this instance." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "UseResource", + "parameters": [], + "returnTypeName": "void", + "signature": "public void UseResource()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.UseResource()", + "exceptions": [ + { + "description": "Thrown if the object has been disposed.", + "type": "ObjectDisposedException" + } + ], + "summary": "Uses the resource." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public DisposableClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.DisposableClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "ResourceName", + "parameters": [], + "returnTypeName": "string", + "signature": "public string ResourceName { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.ResourceName", + "summary": "Gets or sets the resource name." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "name": "DisposableClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "examples": "\r\n using (var disposable = new DisposableClass())\r\n {\r\n disposable.UseResource();\r\n }\r\n ", + "relatedApis": [ + "System.IDisposable" + ], + "remarks": "This class demonstrates how interface implementation is documented.", + "summary": "A class that implements IDisposable for testing interface documentation." + }, + { + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_TestValue", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "string TestValue.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": true, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface.TestValue.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "TestMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "void TestMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": true, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface.TestMethod()", + "returns": "The result of the test operation.", + "summary": "Performs a test operation." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "TestValue", + "parameters": [], + "returnTypeName": "string", + "signature": "string TestValue { get; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": true, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface.TestValue", + "summary": "Gets the test value." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetFormattedValue", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "instance", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "name": "ITestInterface", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "typeKind": "interface", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface" + }, + "typeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface instance", + "usage": "The interface instance." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public static string GetFormattedValue(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface instance)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions", + "isExtensionMethod": true, + "extendedTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions.GetFormattedValue(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface)", + "examples": "\r\n ITestInterface test = new TestImplementation();\r\n var formatted = test.GetFormattedValue();\r\n ", + "returns": "A formatted string containing the test value.", + "summary": "Gets a formatted string from the interface." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Validate", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "instance", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "name": "ITestInterface", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "typeKind": "interface", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface" + }, + "typeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface instance", + "usage": "The interface instance." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Validate(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface instance)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions", + "isExtensionMethod": true, + "extendedTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions.Validate(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface)", + "remarks": "This extension provides common validation logic for all ITestInterface implementers.", + "returns": "True if the instance is valid, otherwise false.", + "summary": "Validates the interface instance." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "name": "ITestInterface", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "typeKind": "interface", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "relatedApis": [], + "remarks": "This interface is used to test extension methods on interfaces and to verify\r\n that inherited members from interfaces are properly documented.", + "summary": "A test interface for demonstrating interface inheritance and extension methods." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "DoWork", + "parameters": [], + "returnTypeName": "void", + "signature": "public void DoWork()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass.DoWork()", + "remarks": "This method doesn't actually do anything, but it has documentation.", + "summary": "Performs some work." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public SimpleClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass.SimpleClass()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToDisplayString", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "instance", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "name": "SimpleClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "typeKind": "class", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass" + }, + "typeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass instance", + "usage": "The SimpleClass instance." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public static string ToDisplayString(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass instance)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions", + "isExtensionMethod": true, + "extendedTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions.ToDisplayString(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass)", + "examples": "\r\n var simple = new SimpleClass();\r\n var display = simple.ToDisplayString();\r\n ", + "returns": "A formatted string representation.", + "summary": "Converts a SimpleClass instance to a display string." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "IsValid", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "instance", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "name": "SimpleClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "typeKind": "class", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass" + }, + "typeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass instance", + "usage": "The SimpleClass instance." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool IsValid(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass instance)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions", + "isExtensionMethod": true, + "extendedTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions.IsValid(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass)", + "remarks": "This is a simple validation extension for demonstration purposes.", + "returns": "True if valid, otherwise false.", + "summary": "Checks if a SimpleClass instance is valid." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "name": "SimpleClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "examples": "\r\n var simple = new SimpleClass();\r\n simple.DoWork();\r\n ", + "relatedApis": [], + "remarks": "These are remarks about the SimpleClass. They provide additional context\r\n and information beyond what's in the summary.", + "summary": "A simple class for testing basic documentation extraction." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_TestValue", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string TestValue.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.TestValue.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "TestMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void TestMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.TestMethod()", + "summary": "Performs a test operation." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "AdditionalMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void AdditionalMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.AdditionalMethod()", + "summary": "An additional method specific to the implementation." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public TestImplementation()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.TestImplementation()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "TestValue", + "parameters": [], + "returnTypeName": "string", + "signature": "public string TestValue { get; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.TestValue", + "summary": "Gets the test value." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "name": "TestImplementation", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "relatedApis": [ + "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface" + ], + "remarks": "This class implements ITestInterface to demonstrate interface member inheritance\r\n in documentation generation.", + "summary": "A test implementation of ITestInterface." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases", + "types": [ + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Name", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Name.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.Name.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Name", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Name.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.Name.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "DoSomething", + "parameters": [], + "returnTypeName": "void", + "signature": "public void DoSomething()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.DoSomething()", + "summary": "Does something." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithMinimalDocs()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.ClassWithMinimalDocs()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Name", + "parameters": [], + "returnTypeName": "string", + "signature": "public string Name { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.Name", + "summary": "Gets or sets the name." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "name": "ClassWithMinimalDocs", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "relatedApis": [], + "summary": "A class with minimal documentation." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_UndocumentedProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string UndocumentedProperty.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.UndocumentedProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_UndocumentedProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void UndocumentedProperty.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.UndocumentedProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "UndocumentedMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void UndocumentedMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.UndocumentedMethod()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithNoDocs()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.ClassWithNoDocs()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "UndocumentedProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public string UndocumentedProperty { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.UndocumentedProperty" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "name": "ClassWithNoDocs", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "relatedApis": [] + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithSpecialChars", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "input", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string input", + "usage": "An input with \"quotes\" and 'apostrophes'." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithSpecialChars(string input)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters.MethodWithSpecialChars(string)", + "remarks": "This method handles <, >, & characters properly.", + "returns": "A string with & ampersands.", + "summary": "A method with special characters in docs: <T> generics." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithSpecialCharacters()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters.ClassWithSpecialCharacters()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "name": "ClassWithSpecialCharacters", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "examples": "\r\n // Using generics: List<string>\r\n var list = new List<string>();\r\n if (x > 0 && y < 10) { }\r\n ", + "relatedApis": [], + "remarks": "This tests handling of XML special characters like <tag> and &entity;.\r\n Also tests \"quotes\" and 'apostrophes'.", + "summary": "A class with special characters in documentation: <, >, &, \", '." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Value", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Value.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.Value.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Value", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Value.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.Value.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ComplexMethod", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "text", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string text", + "usage": "The text parameter to process." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "number", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int number", + "usage": "The number to use in processing." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string ComplexMethod(string text, int number)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.ComplexMethod(string, int)", + "exceptions": [ + { + "description": "Thrown when text is null.", + "type": "ArgumentNullException" + }, + { + "description": "Thrown when number is negative.", + "type": "ArgumentOutOfRangeException" + } + ], + "examples": "\r\n var result = ComplexMethod(\"hello\", 5);\r\n Console.WriteLine(result);\r\n ", + "remarks": "This method performs complex processing.\r\n \r\n First, it validates the input.\r\n \r\n \r\n Then, it processes the data.\r\n \r\n \r\n Finally, it returns the result.\r\n \r\n", + "returns": "A processed result string.", + "seeAlso": [ + { + "isResolved": false, + "rawReference": "M:System.String.Format(System.String,System.Object[])", + "referenceType": "method" + } + ], + "summary": "A complex method with full documentation." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ProcessNumbers", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Runtime", + "fullName": "System.Collections.Generic.IEnumerable", + "name": "IEnumerable", + "signature": "System.Collections.Generic.IEnumerable", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.IEnumerable" + }, + "returnTypeName": "System.Collections.Generic.IEnumerable", + "signature": "public System.Collections.Generic.IEnumerable ProcessNumbers()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.ProcessNumbers()", + "examples": "\r\n var numbers = Enumerable.Range(1, 10)\r\n .Where(x => x % 2 == 0)\r\n .Select(x => new\r\n {\r\n Number = x,\r\n Square = x * x,\r\n Cube = x * x * x\r\n })\r\n .ToList();\r\n ", + "returns": "A collection of transformed numbers.", + "summary": "Filters and transforms a collection of numbers." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithFullDocs()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.ClassWithFullDocs()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Value", + "parameters": [], + "returnTypeName": "string", + "signature": "public string Value { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.Value", + "remarks": "This property stores important data.", + "summary": "Gets or sets the value property.", + "value": "The current value as a string." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "name": "ClassWithFullDocs", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "examples": "\r\n var fullDocs = new ClassWithFullDocs();\r\n fullDocs.ComplexMethod(\"test\", 42);\r\n ", + "relatedApis": [], + "remarks": "This class demonstrates all available XML documentation tags.It includes multiple paragraphs in the remarks section.", + "seeAlso": [ + { + "isResolved": false, + "rawReference": "T:CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "referenceType": "type" + }, + { + "isResolved": false, + "rawReference": "T:System.String", + "referenceType": "type" + } + ], + "summary": "A class with comprehensive XML documentation tags." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.Enums", + "types": [ + { + "baseType": "System.Enum", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "value__", + "parameters": [], + "returnTypeName": "byte", + "signature": "public byte value__", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.value__" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Min", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum Min", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.Min", + "summary": "Minimum value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Low", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum Low", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.Low", + "summary": "Low value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Medium", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum Medium", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.Medium", + "summary": "Medium value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "High", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum High", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.High", + "summary": "High value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Max", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum Max", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.Max", + "summary": "Maximum value for byte." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "name": "ByteEnum", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "relatedApis": [], + "remarks": "This enum uses a byte as its underlying type to save memory.\r\n Values are limited to 0-255.", + "summary": "An enum with byte underlying type." + }, + { + "baseType": "System.Enum", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "value__", + "parameters": [], + "returnTypeName": "int", + "signature": "public int value__", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.value__" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "None", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum None", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.None", + "summary": "No permissions." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Read", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum Read", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.Read", + "summary": "Read permission." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Write", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum Write", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.Write", + "summary": "Write permission." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Execute", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum Execute", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.Execute", + "summary": "Execute permission." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Delete", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum Delete", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.Delete", + "summary": "Delete permission." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "All", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum All", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.All", + "summary": "All permissions combined." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "name": "FlagsEnum", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "relatedApis": [], + "summary": "A flags enum for bitwise operations." + }, + { + "baseType": "System.Enum", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "value__", + "parameters": [], + "returnTypeName": "long", + "signature": "public long value__", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.value__" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Small", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum Small", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.Small", + "summary": "Small value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Million", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum Million", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.Million", + "summary": "Large value in millions." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Billion", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum Billion", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.Billion", + "summary": "Large value in billions." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "VeryLarge", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum VeryLarge", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.VeryLarge", + "summary": "Very large value." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "name": "LongEnum", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "relatedApis": [], + "summary": "An enum with long underlying type for large values." + }, + { + "baseType": "System.Enum", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "value__", + "parameters": [], + "returnTypeName": "int", + "signature": "public int value__", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.value__" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "None", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum None", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.None", + "summary": "No value specified." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "First", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum First", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.First", + "summary": "First option." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Second", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum Second", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.Second", + "summary": "Second option." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Third", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum Third", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.Third", + "summary": "Third option with explicit value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Fourth", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum Fourth", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.Fourth", + "summary": "Fourth option continues from Third." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "name": "SimpleEnum", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "relatedApis": [], + "summary": "A simple enum with default int underlying type." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.Parameters", + "types": [ + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithOptionalParam", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "required", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string required", + "usage": "The required string parameter." + }, + { + "defaultValue": "42", + "hasDefaultValue": true, + "isOptional": true, + "isParams": false, + "name": "optional", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int optional", + "usage": "The optional integer parameter with a default value." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithOptionalParam(string required, int optional = 42)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithOptionalParam(string, int)", + "examples": "\r\n var result1 = MethodWithOptionalParam(\"test\"); // Uses default value 42\r\n var result2 = MethodWithOptionalParam(\"test\", 100); // Uses provided value\r\n ", + "returns": "A formatted string combining both parameters.", + "summary": "A method with an optional parameter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithParams", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": true, + "name": "values", + "parameterType": { + "members": [], + "fullName": "int[]", + "name": "", + "signature": "int[]", + "typeKind": "array", + "isExternalReference": true, + "displayName": "int[]" + }, + "typeName": "int[]", + "displayName": "params int[] values", + "usage": "Variable number of integer values." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int MethodWithParams(params int[] values)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithParams(params int[])", + "examples": "\r\n var sum1 = MethodWithParams(1, 2, 3); // Returns 6\r\n var sum2 = MethodWithParams(new[] { 1, 2 }); // Returns 3\r\n ", + "returns": "The sum of all provided values.", + "summary": "A method with a params array." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithRef", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "ref int value", + "usage": "The value to be modified by reference." + } + ], + "returnTypeName": "void", + "signature": "public void MethodWithRef(ref int value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithRef(ref int)", + "remarks": "This method doubles the input value.", + "summary": "A method with a ref parameter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithOut", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "input", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string input", + "usage": "The input string to parse." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "out int value", + "usage": "The output integer value if parsing succeeds." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public bool MethodWithOut(string input, out int value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithOut(string, out int)", + "returns": "true if the parsing was successful; otherwise, false.", + "summary": "A method with an out parameter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GenericMethod", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "T", + "name": "T", + "signature": "T", + "typeKind": "typeParameter", + "isExternalReference": true, + "displayName": "T" + }, + "typeName": "T", + "displayName": "T value", + "usage": "The value to process." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string GenericMethod(T value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.GenericMethod(T)", + "examples": "\r\n var result1 = GenericMethod<int>(42);\r\n var result2 = GenericMethod(\"hello\");\r\n ", + "returns": "The string representation of the value.", + "summary": "A generic method with a type parameter.", + "typeParameters": [ + { + "description": "The type of the value.", + "name": "T" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GenericMethodWithMultipleTypes", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "key", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "TKey", + "name": "TKey", + "signature": "TKey", + "typeKind": "typeParameter", + "isExternalReference": true, + "displayName": "TKey" + }, + "typeName": "TKey", + "displayName": "TKey key", + "usage": "The key." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "TValue", + "name": "TValue", + "signature": "TValue", + "typeKind": "typeParameter", + "isExternalReference": true, + "displayName": "TValue" + }, + "typeName": "TValue", + "displayName": "TValue value", + "usage": "The value." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Runtime", + "fullName": "System.Collections.Generic.KeyValuePair", + "name": "KeyValuePair", + "signature": "System.Collections.Generic.KeyValuePair", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.KeyValuePair" + }, + "returnTypeName": "System.Collections.Generic.KeyValuePair", + "signature": "public System.Collections.Generic.KeyValuePair GenericMethodWithMultipleTypes(TKey key, TValue value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.GenericMethodWithMultipleTypes(TKey, TValue)", + "returns": "A key-value pair.", + "summary": "A method with multiple generic type parameters.", + "typeParameters": [ + { + "description": "The type of the key.", + "name": "TKey" + }, + { + "description": "The type of the value.", + "name": "TValue" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithNullables", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "nullableInt", + "parameterType": { + "members": [], + "assemblyName": "System.Runtime", + "fullName": "System.Nullable", + "name": "Nullable", + "signature": "System.Nullable", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Nullable" + }, + "typeName": "System.Nullable", + "displayName": "System.Nullable nullableInt", + "usage": "An optional nullable integer." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "nullableString", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "typeName": "string?", + "displayName": "string? nullableString", + "usage": "An optional nullable string." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithNullables(System.Nullable nullableInt, string nullableString)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithNullables(System.Nullable, string?)", + "returns": "A description of the provided values.", + "summary": "A method with nullable parameters." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithConstraints", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "item", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "T", + "name": "T", + "signature": "T", + "typeKind": "typeParameter", + "isExternalReference": true, + "displayName": "T" + }, + "typeName": "T", + "displayName": "T item", + "usage": "The item to process." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithConstraints(T item) where T : class", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithConstraints(T)", + "returns": "The type name of the item.", + "summary": "A method demonstrating parameter constraints.", + "typeParameters": [ + { + "description": "The type parameter constrained to class types.", + "name": "T" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ParameterVariations()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.ParameterVariations()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "name": "ParameterVariations", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "relatedApis": [], + "remarks": "This class contains methods with different parameter modifiers and types.", + "summary": "A class demonstrating various parameter types and patterns." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters" + }, + { + "name": "System.Collections.Generic", + "types": [ + { + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "IsNullOrEmpty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "list", + "parameterType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "typeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.List list", + "usage": "The list to check." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool IsNullOrEmpty(System.Collections.Generic.List list)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "System.Collections.Generic.TestsShared_ListExtensions", + "isExtensionMethod": true, + "extendedTypeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.TestsShared_ListExtensions.IsNullOrEmpty(System.Collections.Generic.List)", + "examples": "\r\n var numbers = new List<int>();\r\n if (numbers.IsNullOrEmpty())\r\n {\r\n // Handle empty list\r\n }\r\n ", + "returns": "True if the list is null or empty, otherwise false.", + "summary": "Checks if a list is null or empty.", + "typeParameters": [ + { + "description": "The type of elements in the list.", + "name": "T" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "AddMultiple", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "list", + "parameterType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "typeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.List list", + "usage": "The list to add items to." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": true, + "name": "items", + "parameterType": { + "members": [], + "fullName": "T[]", + "name": "", + "signature": "T[]", + "typeKind": "array", + "isExternalReference": true, + "displayName": "T[]" + }, + "typeName": "T[]", + "displayName": "params T[] items", + "usage": "The items to add." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "returnTypeName": "System.Collections.Generic.List", + "signature": "public static System.Collections.Generic.List AddMultiple(System.Collections.Generic.List list, params T[] items)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "System.Collections.Generic.TestsShared_ListExtensions", + "isExtensionMethod": true, + "extendedTypeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.TestsShared_ListExtensions.AddMultiple(System.Collections.Generic.List, params T[])", + "examples": "\r\n var numbers = new List<int>()\r\n .AddMultiple(1, 2, 3, 4, 5);\r\n ", + "returns": "The list for fluent chaining.", + "summary": "Adds multiple items to a list in one call.", + "typeParameters": [ + { + "description": "The type of elements in the list.", + "name": "T" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Shuffle", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "list", + "parameterType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "typeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.List list", + "usage": "The list to shuffle." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "returnTypeName": "System.Collections.Generic.List", + "signature": "public static System.Collections.Generic.List Shuffle(System.Collections.Generic.List list)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "System.Collections.Generic.TestsShared_ListExtensions", + "isExtensionMethod": true, + "extendedTypeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.TestsShared_ListExtensions.Shuffle(System.Collections.Generic.List)", + "remarks": "This uses the Fisher-Yates shuffle algorithm for randomization.", + "returns": "The shuffled list.", + "summary": "Shuffles the elements in a list randomly.", + "typeParameters": [ + { + "description": "The type of elements in the list.", + "name": "T" + } + ] + } + ], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List", + "remarks": "See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.collections.generic.list{t}) for more information about the rest of the API.", + "summary": "This type is defined in System.Collections." + } + ], + "displayName": "System.Collections.Generic" + }, + { + "name": "System", + "types": [ + { + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Reverse", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "The string to reverse." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public static string Reverse(string value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions", + "isExtensionMethod": true, + "extendedTypeName": "string", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions.Reverse(string)", + "examples": "\r\n using CloudNimble.DotNetDocs.Tests.Shared.Extensions;\r\n \r\n var result = \"hello\".Reverse();\r\n // result = \"olleh\"\r\n ", + "returns": "The reversed string.", + "summary": "Reverses the characters in a string." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Repeat", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "The string to repeat." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "count", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int count", + "usage": "The number of times to repeat the string." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public static string Repeat(string value, int count)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions", + "isExtensionMethod": true, + "extendedTypeName": "string", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions.Repeat(string, int)", + "examples": "\r\n var result = \"ha\".Repeat(3);\r\n // result = \"hahaha\"\r\n ", + "returns": "The repeated string.", + "summary": "Repeats a string a specified number of times." + } + ], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string", + "remarks": "See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.string) for more information about the rest of the API.", + "summary": "This type is defined in System.Private.CoreLib." + } + ], + "displayName": "System" + } + ], + "version": "1.1.0.0", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared, Version=1.1.0.0, Culture=neutral, PublicKeyToken=null" +} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md index b0c42be..aeef0ea 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md @@ -24,6 +24,20 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase public DotNetDocsTestBase() ``` +## Properties + +### TestContext + +#### Syntax + +```csharp +public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } +``` + +#### Property Value + +Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` + ## Methods ### GetTestsDotSharedAssembly diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md index b0c42be..aeef0ea 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md @@ -24,6 +24,20 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase public DotNetDocsTestBase() ``` +## Properties + +### TestContext + +#### Syntax + +```csharp +public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } +``` + +#### Property Value + +Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` + ## Methods ### GetTestsDotSharedAssembly diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml index 9ae91fc..40625b8 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml @@ -16,6 +16,42 @@ types: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -40,6 +76,13 @@ types: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FileMode/documentation.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FileMode/documentation.yaml index 22773f3..c48477e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FileMode/documentation.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FileMode/documentation.yaml @@ -18,6 +18,42 @@ namespaces: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -42,6 +78,13 @@ namespaces: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml index 9ae91fc..40625b8 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml @@ -16,6 +16,42 @@ types: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -40,6 +76,13 @@ types: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FolderMode/documentation.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FolderMode/documentation.yaml index 22773f3..c48477e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FolderMode/documentation.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net8.0/YamlRenderer/FolderMode/documentation.yaml @@ -18,6 +18,42 @@ namespaces: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -42,6 +78,13 @@ namespaces: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/AssemblyManager/BasicAssembly.json b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/AssemblyManager/BasicAssembly.json new file mode 100644 index 0000000..c716447 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/AssemblyManager/BasicAssembly.json @@ -0,0 +1,8528 @@ +{ + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "namespaces": [ + { + "name": "CloudNimble.DotNetDocs.Tests.Shared", + "types": [ + { + "baseType": "CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "projectPath", + "parameters": [], + "returnTypeName": "string", + "signature": "public const string projectPath", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.projectPath" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "framework", + "parameters": [], + "returnTypeName": "string", + "signature": "public const string framework", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_TestContext", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "MSTest.TestFramework.Extensions", + "fullName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "name": "TestContext", + "signature": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "typeKind": "error", + "isExternalReference": true, + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext" + }, + "returnTypeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "signature": "public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_TestContext", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "MSTest.TestFramework.Extensions", + "fullName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "name": "TestContext", + "signature": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "typeKind": "error", + "isExternalReference": true, + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext" + }, + "typeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "displayName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void TestContext.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetTestsDotSharedAssembly", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Core", + "fullName": "CloudNimble.DotNetDocs.Core.DocAssembly", + "name": "DocAssembly", + "signature": "CloudNimble.DotNetDocs.Core.DocAssembly", + "typeKind": "error", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Core.DocAssembly" + }, + "returnTypeName": "CloudNimble.DotNetDocs.Core.DocAssembly", + "signature": "public CloudNimble.DotNetDocs.Core.DocAssembly GetTestsDotSharedAssembly()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.GetTestsDotSharedAssembly()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public DotNetDocsTestBase()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "TestContext", + "parameters": [], + "returnTypeName": "Microsoft.VisualStudio.TestTools.UnitTesting.TestContext", + "signature": "public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "name": "DotNetDocsTestBase", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase", + "relatedApis": [] + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Name", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Name.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Name.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Name", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Name.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Name.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Value", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int Value.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Value.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Value", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Value.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Value.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "DoSomething", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "input", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string input", + "usage": "The input parameter." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string DoSomething(string input)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.DoSomething(string)", + "returns": "The result of the operation.", + "summary": "Performs a sample operation." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetDisplay", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string GetDisplay()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.GetDisplay()", + "returns": "A formatted string containing the name and value.", + "summary": "Gets the display value." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithOptional", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "required", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string required", + "usage": "Required parameter." + }, + { + "defaultValue": "42", + "hasDefaultValue": true, + "isOptional": true, + "isParams": false, + "name": "optional", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int optional", + "usage": "Optional parameter with default value." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithOptional(string required, int optional = 42)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.MethodWithOptional(string, int)", + "returns": "Combined result.", + "summary": "Method with optional parameter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithParams", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": true, + "name": "values", + "parameterType": { + "members": [], + "fullName": "int[]", + "name": "", + "signature": "int[]", + "typeKind": "array", + "isExternalReference": true, + "displayName": "int[]" + }, + "typeName": "int[]", + "displayName": "params int[] values", + "usage": "Variable number of values." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int MethodWithParams(params int[] values)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.MethodWithParams(params int[])", + "returns": "Sum of values.", + "summary": "Method with params array." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public SampleClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.SampleClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Name", + "parameters": [], + "returnTypeName": "string", + "signature": "public string Name { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Name", + "summary": "Gets or sets the name." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Value", + "parameters": [], + "returnTypeName": "int", + "signature": "public int Value { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass.Value", + "summary": "Gets or sets the value." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "name": "SampleClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.SampleClass", + "relatedApis": [], + "summary": "A sample class for testing documentation generation." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers", + "types": [ + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "PublicField", + "parameters": [], + "returnTypeName": "string", + "signature": "public string PublicField", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicField", + "summary": "A public field." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_PublicProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string PublicProperty.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_PublicProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void PublicProperty.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "PublicMethod", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string PublicMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicMethod()", + "returns": "A string indicating this is a public method.", + "summary": "A public method." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public MixedAccessClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.MixedAccessClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "PublicProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public string PublicProperty { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass.PublicProperty", + "summary": "Gets or sets the public property." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "name": "MixedAccessClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass", + "relatedApis": [], + "remarks": "This class tests the IncludedMembers filtering functionality.", + "summary": "A class with members of various access modifiers for testing filtering." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios", + "types": [ + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_BaseProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public virtual string BaseProperty.get", + "isInherited": false, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_BaseProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public virtual void BaseProperty.set", + "isInherited": false, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "VirtualMethod", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public virtual string VirtualMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.VirtualMethod()", + "returns": "A string value.", + "summary": "A virtual method that can be overridden." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "BaseMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void BaseMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseMethod()", + "summary": "A method in the base class." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public BaseClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "BaseProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public virtual string BaseProperty { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty", + "summary": "Gets or sets the base property." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "name": "BaseClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "relatedApis": [], + "remarks": "This class serves as the base for DerivedClass.", + "summary": "A base class for testing inheritance documentation." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Calculate", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "a", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int a", + "usage": "The first number." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "b", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int b", + "usage": "The second number." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int Calculate(int a, int b)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.Calculate(int, int)", + "examples": "\r\n var result = Calculate(3, 4); // Returns 7\r\n ", + "returns": "The sum of a and b.", + "summary": "Calculates the sum of two numbers." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Process", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "input", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string input", + "usage": "The string to process." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Process(string input)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.Process(string)", + "exceptions": [ + { + "description": "Thrown when input is null.", + "type": "ArgumentNullException" + } + ], + "remarks": "This method performs a simple transformation for testing purposes.", + "returns": "The processed string in uppercase.", + "summary": "Processes the input string." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "PerformAction", + "parameters": [], + "returnTypeName": "void", + "signature": "public void PerformAction()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.PerformAction()", + "remarks": "This method doesn't return anything.", + "summary": "A void method that performs an action." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetConditionalValue", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "condition", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "typeName": "bool", + "displayName": "bool condition", + "usage": "The condition to evaluate." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string GetConditionalValue(bool condition)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.GetConditionalValue(bool)", + "returns": "Returns \"Yes\" if condition is true, \"No\" otherwise.", + "summary": "Gets a value based on a condition." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithMethods()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods.ClassWithMethods()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "name": "ClassWithMethods", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods", + "examples": "\r\n var obj = new ClassWithMethods();\r\n var result = obj.Calculate(5, 10);\r\n ", + "relatedApis": [], + "remarks": "Contains methods with different signatures, parameters, and return types.", + "summary": "A class demonstrating various method documentation scenarios." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Name", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Name.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Name.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Name", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Name.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Name.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Id", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int Id.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Id.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Value", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "double", + "name": "Double", + "signature": "double", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "double" + }, + "returnTypeName": "double", + "signature": "public double Value.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Value.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "UpdateValue", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "newValue", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "double", + "name": "Double", + "signature": "double", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "double" + }, + "typeName": "double", + "displayName": "double newValue", + "usage": "The new value to set." + } + ], + "returnTypeName": "void", + "signature": "public void UpdateValue(double newValue)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.UpdateValue(double)", + "summary": "Updates the value property." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithProperties()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.ClassWithProperties()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Name", + "parameters": [], + "returnTypeName": "string", + "signature": "public string Name { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Name", + "remarks": "This is a standard public property with get and set accessors.", + "summary": "Gets or sets the name." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Id", + "parameters": [], + "returnTypeName": "int", + "signature": "public int Id { get; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Id", + "remarks": "This property can only be read, not written to.", + "summary": "Gets the read-only identifier." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Value", + "parameters": [], + "returnTypeName": "double", + "signature": "public double Value { get; private set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties.Value", + "remarks": "This property can be read publicly but only set within the class.", + "summary": "Gets or sets the value with a private setter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "name": "ClassWithProperties", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties", + "relatedApis": [], + "remarks": "This class contains properties with different access modifiers and documentation styles.", + "summary": "A class demonstrating various property documentation scenarios." + }, + { + "baseType": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_DerivedProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string DerivedProperty.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_DerivedProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void DerivedProperty.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_BaseProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public override string BaseProperty.get", + "isInherited": false, + "isOverride": true, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "overriddenMember": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.get", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.BaseProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_BaseProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public override void BaseProperty.set", + "isInherited": false, + "isOverride": true, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "overriddenMember": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.set", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.BaseProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "VirtualMethod", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public override string VirtualMethod()", + "isInherited": false, + "isOverride": true, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "overriddenMember": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.VirtualMethod()", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.VirtualMethod()", + "remarks": "This method provides custom behavior for the derived class.", + "returns": "A string indicating the derived implementation.", + "summary": "Overrides the virtual method from the base class." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "DerivedMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void DerivedMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedMethod()", + "summary": "An additional method in the derived class." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public DerivedClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "DerivedProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public string DerivedProperty { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.DerivedProperty", + "summary": "Gets or sets the derived property." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "BaseProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public override string BaseProperty { get; set; }", + "isInherited": false, + "isOverride": true, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "overriddenMember": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass.BaseProperty", + "remarks": "This property overrides the base implementation.", + "summary": "Gets or sets the base property with overridden behavior." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_BaseProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public virtual string BaseProperty.get", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_BaseProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public virtual void BaseProperty.set", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "VirtualMethod", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public virtual string VirtualMethod()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.VirtualMethod()", + "returns": "A string value.", + "summary": "A virtual method that can be overridden." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "BaseMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void BaseMethod()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseMethod()", + "summary": "A method in the base class." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public BaseClass()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "BaseProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public virtual string BaseProperty { get; set; }", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass.BaseProperty", + "summary": "Gets or sets the base property." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "name": "DerivedClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass", + "examples": "\r\n var derived = new DerivedClass();\r\n var result = derived.VirtualMethod();\r\n ", + "relatedApis": [], + "remarks": "This class inherits from BaseClass and overrides some members.", + "summary": "A derived class for testing inheritance documentation." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_ResourceName", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string ResourceName.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.ResourceName.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_ResourceName", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void ResourceName.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.ResourceName.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Dispose", + "parameters": [], + "returnTypeName": "void", + "signature": "public void Dispose()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.Dispose()", + "remarks": "Implements the IDisposable pattern.", + "summary": "Disposes the resources used by this instance." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "UseResource", + "parameters": [], + "returnTypeName": "void", + "signature": "public void UseResource()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.UseResource()", + "exceptions": [ + { + "description": "Thrown if the object has been disposed.", + "type": "ObjectDisposedException" + } + ], + "summary": "Uses the resource." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public DisposableClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.DisposableClass()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "ResourceName", + "parameters": [], + "returnTypeName": "string", + "signature": "public string ResourceName { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass.ResourceName", + "summary": "Gets or sets the resource name." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "name": "DisposableClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass", + "examples": "\r\n using (var disposable = new DisposableClass())\r\n {\r\n disposable.UseResource();\r\n }\r\n ", + "relatedApis": [ + "System.IDisposable" + ], + "remarks": "This class demonstrates how interface implementation is documented.", + "summary": "A class that implements IDisposable for testing interface documentation." + }, + { + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_TestValue", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "string TestValue.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": true, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface.TestValue.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "TestMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "void TestMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": true, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface.TestMethod()", + "returns": "The result of the test operation.", + "summary": "Performs a test operation." + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "TestValue", + "parameters": [], + "returnTypeName": "string", + "signature": "string TestValue { get; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": true, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface.TestValue", + "summary": "Gets the test value." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetFormattedValue", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "instance", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "name": "ITestInterface", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "typeKind": "interface", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface" + }, + "typeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface instance", + "usage": "The interface instance." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public static string GetFormattedValue(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface instance)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions", + "isExtensionMethod": true, + "extendedTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions.GetFormattedValue(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface)", + "examples": "\r\n ITestInterface test = new TestImplementation();\r\n var formatted = test.GetFormattedValue();\r\n ", + "returns": "A formatted string containing the test value.", + "summary": "Gets a formatted string from the interface." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Validate", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "instance", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "name": "ITestInterface", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "typeKind": "interface", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface" + }, + "typeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface instance", + "usage": "The interface instance." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Validate(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface instance)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions", + "isExtensionMethod": true, + "extendedTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions.Validate(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface)", + "remarks": "This extension provides common validation logic for all ITestInterface implementers.", + "returns": "True if the instance is valid, otherwise false.", + "summary": "Validates the interface instance." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "name": "ITestInterface", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "typeKind": "interface", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface", + "relatedApis": [], + "remarks": "This interface is used to test extension methods on interfaces and to verify\r\n that inherited members from interfaces are properly documented.", + "summary": "A test interface for demonstrating interface inheritance and extension methods." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "DoWork", + "parameters": [], + "returnTypeName": "void", + "signature": "public void DoWork()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass.DoWork()", + "remarks": "This method doesn't actually do anything, but it has documentation.", + "summary": "Performs some work." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public SimpleClass()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass.SimpleClass()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToDisplayString", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "instance", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "name": "SimpleClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "typeKind": "class", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass" + }, + "typeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass instance", + "usage": "The SimpleClass instance." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public static string ToDisplayString(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass instance)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions", + "isExtensionMethod": true, + "extendedTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions.ToDisplayString(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass)", + "examples": "\r\n var simple = new SimpleClass();\r\n var display = simple.ToDisplayString();\r\n ", + "returns": "A formatted string representation.", + "summary": "Converts a SimpleClass instance to a display string." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "IsValid", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "instance", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "name": "SimpleClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "typeKind": "class", + "isExternalReference": true, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass" + }, + "typeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass instance", + "usage": "The SimpleClass instance." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool IsValid(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass instance)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions", + "isExtensionMethod": true, + "extendedTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions.IsValid(CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass)", + "remarks": "This is a simple validation extension for demonstration purposes.", + "returns": "True if valid, otherwise false.", + "summary": "Checks if a SimpleClass instance is valid." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "name": "SimpleClass", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass", + "examples": "\r\n var simple = new SimpleClass();\r\n simple.DoWork();\r\n ", + "relatedApis": [], + "remarks": "These are remarks about the SimpleClass. They provide additional context\r\n and information beyond what's in the summary.", + "summary": "A simple class for testing basic documentation extraction." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_TestValue", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string TestValue.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.TestValue.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "TestMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void TestMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.TestMethod()", + "summary": "Performs a test operation." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "AdditionalMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void AdditionalMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.AdditionalMethod()", + "summary": "An additional method specific to the implementation." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public TestImplementation()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.TestImplementation()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "TestValue", + "parameters": [], + "returnTypeName": "string", + "signature": "public string TestValue { get; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation.TestValue", + "summary": "Gets the test value." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "name": "TestImplementation", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation", + "relatedApis": [ + "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface" + ], + "remarks": "This class implements ITestInterface to demonstrate interface member inheritance\r\n in documentation generation.", + "summary": "A test implementation of ITestInterface." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases", + "types": [ + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Name", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Name.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.Name.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Name", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Name.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.Name.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "DoSomething", + "parameters": [], + "returnTypeName": "void", + "signature": "public void DoSomething()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.DoSomething()", + "summary": "Does something." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithMinimalDocs()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.ClassWithMinimalDocs()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Name", + "parameters": [], + "returnTypeName": "string", + "signature": "public string Name { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs.Name", + "summary": "Gets or sets the name." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "name": "ClassWithMinimalDocs", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "relatedApis": [], + "summary": "A class with minimal documentation." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_UndocumentedProperty", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string UndocumentedProperty.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.UndocumentedProperty.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_UndocumentedProperty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void UndocumentedProperty.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.UndocumentedProperty.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "UndocumentedMethod", + "parameters": [], + "returnTypeName": "void", + "signature": "public void UndocumentedMethod()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.UndocumentedMethod()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithNoDocs()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.ClassWithNoDocs()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "UndocumentedProperty", + "parameters": [], + "returnTypeName": "string", + "signature": "public string UndocumentedProperty { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs.UndocumentedProperty" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "name": "ClassWithNoDocs", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs", + "relatedApis": [] + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithSpecialChars", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "input", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string input", + "usage": "An input with \"quotes\" and 'apostrophes'." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithSpecialChars(string input)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters.MethodWithSpecialChars(string)", + "remarks": "This method handles <, >, & characters properly.", + "returns": "A string with & ampersands.", + "summary": "A method with special characters in docs: <T> generics." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithSpecialCharacters()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters.ClassWithSpecialCharacters()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "name": "ClassWithSpecialCharacters", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters", + "examples": "\r\n // Using generics: List<string>\r\n var list = new List<string>();\r\n if (x > 0 && y < 10) { }\r\n ", + "relatedApis": [], + "remarks": "This tests handling of XML special characters like <tag> and &entity;.\r\n Also tests \"quotes\" and 'apostrophes'.", + "summary": "A class with special characters in documentation: <, >, &, \", '." + }, + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertyGet", + "name": "get_Value", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string Value.get", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.Value.get" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "propertySet", + "name": "set_Value", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "" + } + ], + "returnTypeName": "void", + "signature": "public void Value.set", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.Value.set" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ComplexMethod", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "text", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string text", + "usage": "The text parameter to process." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "number", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int number", + "usage": "The number to use in processing." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string ComplexMethod(string text, int number)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.ComplexMethod(string, int)", + "exceptions": [ + { + "description": "Thrown when text is null.", + "type": "ArgumentNullException" + }, + { + "description": "Thrown when number is negative.", + "type": "ArgumentOutOfRangeException" + } + ], + "examples": "\r\n var result = ComplexMethod(\"hello\", 5);\r\n Console.WriteLine(result);\r\n ", + "remarks": "This method performs complex processing.\r\n \r\n First, it validates the input.\r\n \r\n \r\n Then, it processes the data.\r\n \r\n \r\n Finally, it returns the result.\r\n \r\n", + "returns": "A processed result string.", + "seeAlso": [ + { + "isResolved": false, + "rawReference": "M:System.String.Format(System.String,System.Object[])", + "referenceType": "method" + } + ], + "summary": "A complex method with full documentation." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ProcessNumbers", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Runtime", + "fullName": "System.Collections.Generic.IEnumerable", + "name": "IEnumerable", + "signature": "System.Collections.Generic.IEnumerable", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.IEnumerable" + }, + "returnTypeName": "System.Collections.Generic.IEnumerable", + "signature": "public System.Collections.Generic.IEnumerable ProcessNumbers()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.ProcessNumbers()", + "examples": "\r\n var numbers = Enumerable.Range(1, 10)\r\n .Where(x => x % 2 == 0)\r\n .Select(x => new\r\n {\r\n Number = x,\r\n Square = x * x,\r\n Cube = x * x * x\r\n })\r\n .ToList();\r\n ", + "returns": "A collection of transformed numbers.", + "summary": "Filters and transforms a collection of numbers." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ClassWithFullDocs()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.ClassWithFullDocs()" + }, + { + "accessibility": "public", + "memberKind": "property", + "name": "Value", + "parameters": [], + "returnTypeName": "string", + "signature": "public string Value { get; set; }", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs.Value", + "remarks": "This property stores important data.", + "summary": "Gets or sets the value property.", + "value": "The current value as a string." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "name": "ClassWithFullDocs", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs", + "examples": "\r\n var fullDocs = new ClassWithFullDocs();\r\n fullDocs.ComplexMethod(\"test\", 42);\r\n ", + "relatedApis": [], + "remarks": "This class demonstrates all available XML documentation tags.It includes multiple paragraphs in the remarks section.", + "seeAlso": [ + { + "isResolved": false, + "rawReference": "T:CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs", + "referenceType": "type" + }, + { + "isResolved": false, + "rawReference": "T:System.String", + "referenceType": "type" + } + ], + "summary": "A class with comprehensive XML documentation tags." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.EdgeCases" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.Enums", + "types": [ + { + "baseType": "System.Enum", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "value__", + "parameters": [], + "returnTypeName": "byte", + "signature": "public byte value__", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.value__" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Min", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum Min", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.Min", + "summary": "Minimum value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Low", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum Low", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.Low", + "summary": "Low value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Medium", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum Medium", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.Medium", + "summary": "Medium value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "High", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum High", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.High", + "summary": "High value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Max", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum Max", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum.Max", + "summary": "Maximum value for byte." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "name": "ByteEnum", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum", + "relatedApis": [], + "remarks": "This enum uses a byte as its underlying type to save memory.\r\n Values are limited to 0-255.", + "summary": "An enum with byte underlying type." + }, + { + "baseType": "System.Enum", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "value__", + "parameters": [], + "returnTypeName": "int", + "signature": "public int value__", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.value__" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "None", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum None", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.None", + "summary": "No permissions." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Read", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum Read", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.Read", + "summary": "Read permission." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Write", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum Write", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.Write", + "summary": "Write permission." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Execute", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum Execute", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.Execute", + "summary": "Execute permission." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Delete", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum Delete", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.Delete", + "summary": "Delete permission." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "All", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum All", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum.All", + "summary": "All permissions combined." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "name": "FlagsEnum", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum", + "relatedApis": [], + "summary": "A flags enum for bitwise operations." + }, + { + "baseType": "System.Enum", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "value__", + "parameters": [], + "returnTypeName": "long", + "signature": "public long value__", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.value__" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Small", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum Small", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.Small", + "summary": "Small value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Million", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum Million", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.Million", + "summary": "Large value in millions." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Billion", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum Billion", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.Billion", + "summary": "Large value in billions." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "VeryLarge", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum VeryLarge", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum.VeryLarge", + "summary": "Very large value." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "name": "LongEnum", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum", + "relatedApis": [], + "summary": "An enum with long underlying type for large values." + }, + { + "baseType": "System.Enum", + "members": [ + { + "accessibility": "public", + "memberKind": "field", + "name": "value__", + "parameters": [], + "returnTypeName": "int", + "signature": "public int value__", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.value__" + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "None", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum None", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.None", + "summary": "No value specified." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "First", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum First", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.First", + "summary": "First option." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Second", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum Second", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.Second", + "summary": "Second option." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Third", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum Third", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.Third", + "summary": "Third option with explicit value." + }, + { + "accessibility": "public", + "memberKind": "field", + "name": "Fourth", + "parameters": [], + "returnTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "signature": "public const CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum Fourth", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum.Fourth", + "summary": "Fourth option continues from Third." + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "name": "SimpleEnum", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum", + "relatedApis": [], + "summary": "A simple enum with default int underlying type." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Enums" + }, + { + "name": "CloudNimble.DotNetDocs.Tests.Shared.Parameters", + "types": [ + { + "baseType": "System.Object", + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithOptionalParam", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "required", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string required", + "usage": "The required string parameter." + }, + { + "defaultValue": "42", + "hasDefaultValue": true, + "isOptional": true, + "isParams": false, + "name": "optional", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int optional", + "usage": "The optional integer parameter with a default value." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithOptionalParam(string required, int optional = 42)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithOptionalParam(string, int)", + "examples": "\r\n var result1 = MethodWithOptionalParam(\"test\"); // Uses default value 42\r\n var result2 = MethodWithOptionalParam(\"test\", 100); // Uses provided value\r\n ", + "returns": "A formatted string combining both parameters.", + "summary": "A method with an optional parameter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithParams", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": true, + "name": "values", + "parameterType": { + "members": [], + "fullName": "int[]", + "name": "", + "signature": "int[]", + "typeKind": "array", + "isExternalReference": true, + "displayName": "int[]" + }, + "typeName": "int[]", + "displayName": "params int[] values", + "usage": "Variable number of integer values." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public int MethodWithParams(params int[] values)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithParams(params int[])", + "examples": "\r\n var sum1 = MethodWithParams(1, 2, 3); // Returns 6\r\n var sum2 = MethodWithParams(new[] { 1, 2 }); // Returns 3\r\n ", + "returns": "The sum of all provided values.", + "summary": "A method with a params array." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithRef", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "ref int value", + "usage": "The value to be modified by reference." + } + ], + "returnTypeName": "void", + "signature": "public void MethodWithRef(ref int value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithRef(ref int)", + "remarks": "This method doubles the input value.", + "summary": "A method with a ref parameter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithOut", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "input", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string input", + "usage": "The input string to parse." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "out int value", + "usage": "The output integer value if parsing succeeds." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public bool MethodWithOut(string input, out int value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithOut(string, out int)", + "returns": "true if the parsing was successful; otherwise, false.", + "summary": "A method with an out parameter." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GenericMethod", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "T", + "name": "T", + "signature": "T", + "typeKind": "typeParameter", + "isExternalReference": true, + "displayName": "T" + }, + "typeName": "T", + "displayName": "T value", + "usage": "The value to process." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string GenericMethod(T value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.GenericMethod(T)", + "examples": "\r\n var result1 = GenericMethod<int>(42);\r\n var result2 = GenericMethod(\"hello\");\r\n ", + "returns": "The string representation of the value.", + "summary": "A generic method with a type parameter.", + "typeParameters": [ + { + "description": "The type of the value.", + "name": "T" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GenericMethodWithMultipleTypes", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "key", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "TKey", + "name": "TKey", + "signature": "TKey", + "typeKind": "typeParameter", + "isExternalReference": true, + "displayName": "TKey" + }, + "typeName": "TKey", + "displayName": "TKey key", + "usage": "The key." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "TValue", + "name": "TValue", + "signature": "TValue", + "typeKind": "typeParameter", + "isExternalReference": true, + "displayName": "TValue" + }, + "typeName": "TValue", + "displayName": "TValue value", + "usage": "The value." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Runtime", + "fullName": "System.Collections.Generic.KeyValuePair", + "name": "KeyValuePair", + "signature": "System.Collections.Generic.KeyValuePair", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.KeyValuePair" + }, + "returnTypeName": "System.Collections.Generic.KeyValuePair", + "signature": "public System.Collections.Generic.KeyValuePair GenericMethodWithMultipleTypes(TKey key, TValue value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.GenericMethodWithMultipleTypes(TKey, TValue)", + "returns": "A key-value pair.", + "summary": "A method with multiple generic type parameters.", + "typeParameters": [ + { + "description": "The type of the key.", + "name": "TKey" + }, + { + "description": "The type of the value.", + "name": "TValue" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithNullables", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "nullableInt", + "parameterType": { + "members": [], + "assemblyName": "System.Runtime", + "fullName": "System.Nullable", + "name": "Nullable", + "signature": "System.Nullable", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Nullable" + }, + "typeName": "System.Nullable", + "displayName": "System.Nullable nullableInt", + "usage": "An optional nullable integer." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "nullableString", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "typeName": "string?", + "displayName": "string? nullableString", + "usage": "An optional nullable string." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithNullables(System.Nullable nullableInt, string nullableString)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithNullables(System.Nullable, string?)", + "returns": "A description of the provided values.", + "summary": "A method with nullable parameters." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MethodWithConstraints", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "item", + "parameterType": { + "members": [], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "T", + "name": "T", + "signature": "T", + "typeKind": "typeParameter", + "isExternalReference": true, + "displayName": "T" + }, + "typeName": "T", + "displayName": "T item", + "usage": "The item to process." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public string MethodWithConstraints(T item) where T : class", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.MethodWithConstraints(T)", + "returns": "The type name of the item.", + "summary": "A method demonstrating parameter constraints.", + "typeParameters": [ + { + "description": "The type parameter constrained to class types.", + "name": "T" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public ParameterVariations()", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "isExtensionMethod": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations.ParameterVariations()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetType", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "System.Type", + "name": "Type", + "signature": "System.Type", + "typeKind": "class", + "isExternalReference": true, + "displayName": "System.Type" + }, + "returnTypeName": "System.Type", + "signature": "public System.Type GetType()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetType()" + }, + { + "accessibility": "protectedOrInternal", + "memberKind": "method", + "methodKind": "ordinary", + "name": "MemberwiseClone", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object", + "name": "Object", + "signature": "object", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object" + }, + "returnTypeName": "object", + "signature": "protected internal object MemberwiseClone()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.MemberwiseClone()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "constructor", + "name": ".ctor", + "parameters": [], + "returnTypeName": "void", + "signature": "public Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Object()" + }, + { + "accessibility": "protected", + "memberKind": "method", + "methodKind": "destructor", + "name": "Finalize", + "parameters": [], + "returnTypeName": "void", + "signature": "protected ~Object()", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.~Object()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ToString", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string?", + "name": "String", + "signature": "string?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string?" + }, + "returnTypeName": "string?", + "signature": "public virtual string ToString()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ToString()" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "obj", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? obj", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public virtual bool Equals(object obj)", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Equals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool Equals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.Equals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "ReferenceEquals", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objA", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objA", + "usage": "" + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "objB", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "object?", + "name": "Object", + "signature": "object?", + "typeKind": "class", + "isExternalReference": true, + "displayName": "object?" + }, + "typeName": "object?", + "displayName": "object? objB", + "usage": "" + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool ReferenceEquals(object objA, object objB)", + "isInherited": true, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.ReferenceEquals(object?, object?)" + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "GetHashCode", + "parameters": [], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "returnTypeName": "int", + "signature": "public virtual int GetHashCode()", + "isInherited": true, + "isOverride": false, + "isVirtual": true, + "isAbstract": false, + "declaringTypeName": "object", + "isExtensionMethod": false, + "displayName": "object.GetHashCode()" + } + ], + "assemblyName": "CloudNimble.DotNetDocs.Tests.Shared", + "fullName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "name": "ParameterVariations", + "signature": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "typeKind": "class", + "isExternalReference": false, + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations", + "relatedApis": [], + "remarks": "This class contains methods with different parameter modifiers and types.", + "summary": "A class demonstrating various parameter types and patterns." + } + ], + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Parameters" + }, + { + "name": "System.Collections.Generic", + "types": [ + { + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "IsNullOrEmpty", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "list", + "parameterType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "typeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.List list", + "usage": "The list to check." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "bool", + "name": "Boolean", + "signature": "bool", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "bool" + }, + "returnTypeName": "bool", + "signature": "public static bool IsNullOrEmpty(System.Collections.Generic.List list)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "System.Collections.Generic.TestsShared_ListExtensions", + "isExtensionMethod": true, + "extendedTypeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.TestsShared_ListExtensions.IsNullOrEmpty(System.Collections.Generic.List)", + "examples": "\r\n var numbers = new List<int>();\r\n if (numbers.IsNullOrEmpty())\r\n {\r\n // Handle empty list\r\n }\r\n ", + "returns": "True if the list is null or empty, otherwise false.", + "summary": "Checks if a list is null or empty.", + "typeParameters": [ + { + "description": "The type of elements in the list.", + "name": "T" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "AddMultiple", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "list", + "parameterType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "typeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.List list", + "usage": "The list to add items to." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": true, + "name": "items", + "parameterType": { + "members": [], + "fullName": "T[]", + "name": "", + "signature": "T[]", + "typeKind": "array", + "isExternalReference": true, + "displayName": "T[]" + }, + "typeName": "T[]", + "displayName": "params T[] items", + "usage": "The items to add." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "returnTypeName": "System.Collections.Generic.List", + "signature": "public static System.Collections.Generic.List AddMultiple(System.Collections.Generic.List list, params T[] items)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "System.Collections.Generic.TestsShared_ListExtensions", + "isExtensionMethod": true, + "extendedTypeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.TestsShared_ListExtensions.AddMultiple(System.Collections.Generic.List, params T[])", + "examples": "\r\n var numbers = new List<int>()\r\n .AddMultiple(1, 2, 3, 4, 5);\r\n ", + "returns": "The list for fluent chaining.", + "summary": "Adds multiple items to a list in one call.", + "typeParameters": [ + { + "description": "The type of elements in the list.", + "name": "T" + } + ] + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Shuffle", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "list", + "parameterType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "typeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.List list", + "usage": "The list to shuffle." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List" + }, + "returnTypeName": "System.Collections.Generic.List", + "signature": "public static System.Collections.Generic.List Shuffle(System.Collections.Generic.List list)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "System.Collections.Generic.TestsShared_ListExtensions", + "isExtensionMethod": true, + "extendedTypeName": "System.Collections.Generic.List", + "displayName": "System.Collections.Generic.TestsShared_ListExtensions.Shuffle(System.Collections.Generic.List)", + "remarks": "This uses the Fisher-Yates shuffle algorithm for randomization.", + "returns": "The shuffled list.", + "summary": "Shuffles the elements in a list randomly.", + "typeParameters": [ + { + "description": "The type of elements in the list.", + "name": "T" + } + ] + } + ], + "assemblyName": "System.Collections", + "fullName": "System.Collections.Generic.List", + "name": "List", + "signature": "System.Collections.Generic.List", + "typeKind": "error", + "isExternalReference": true, + "displayName": "System.Collections.Generic.List", + "remarks": "See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.collections.generic.list{t}) for more information about the rest of the API.", + "summary": "This type is defined in System.Collections." + } + ], + "displayName": "System.Collections.Generic" + }, + { + "name": "System", + "types": [ + { + "members": [ + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Reverse", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "The string to reverse." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public static string Reverse(string value)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions", + "isExtensionMethod": true, + "extendedTypeName": "string", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions.Reverse(string)", + "examples": "\r\n using CloudNimble.DotNetDocs.Tests.Shared.Extensions;\r\n \r\n var result = \"hello\".Reverse();\r\n // result = \"olleh\"\r\n ", + "returns": "The reversed string.", + "summary": "Reverses the characters in a string." + }, + { + "accessibility": "public", + "memberKind": "method", + "methodKind": "ordinary", + "name": "Repeat", + "parameters": [ + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "value", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "typeName": "string", + "displayName": "string value", + "usage": "The string to repeat." + }, + { + "hasDefaultValue": false, + "isOptional": false, + "isParams": false, + "name": "count", + "parameterType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "int", + "name": "Int32", + "signature": "int", + "typeKind": "struct", + "isExternalReference": true, + "displayName": "int" + }, + "typeName": "int", + "displayName": "int count", + "usage": "The number of times to repeat the string." + } + ], + "returnType": { + "members": [], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string" + }, + "returnTypeName": "string", + "signature": "public static string Repeat(string value, int count)", + "isInherited": false, + "isOverride": false, + "isVirtual": false, + "isAbstract": false, + "declaringTypeName": "CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions", + "isExtensionMethod": true, + "extendedTypeName": "string", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions.Repeat(string, int)", + "examples": "\r\n var result = \"ha\".Repeat(3);\r\n // result = \"hahaha\"\r\n ", + "returns": "The repeated string.", + "summary": "Repeats a string a specified number of times." + } + ], + "assemblyName": "System.Private.CoreLib", + "fullName": "string", + "name": "String", + "signature": "string", + "typeKind": "class", + "isExternalReference": true, + "displayName": "string", + "remarks": "See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.string) for more information about the rest of the API.", + "summary": "This type is defined in System.Private.CoreLib." + } + ], + "displayName": "System" + } + ], + "version": "1.1.0.0", + "displayName": "CloudNimble.DotNetDocs.Tests.Shared, Version=1.1.0.0, Culture=neutral, PublicKeyToken=null" +} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md index b0c42be..aeef0ea 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/MarkdownRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.md @@ -24,6 +24,20 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase public DotNetDocsTestBase() ``` +## Properties + +### TestContext + +#### Syntax + +```csharp +public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } +``` + +#### Property Value + +Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` + ## Methods ### GetTestsDotSharedAssembly diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md index b0c42be..aeef0ea 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/MarkdownRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.md @@ -24,6 +24,20 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase public DotNetDocsTestBase() ``` +## Properties + +### TestContext + +#### Syntax + +```csharp +public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } +``` + +#### Property Value + +Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` + ## Methods ### GetTestsDotSharedAssembly diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml index 2fb33bc..9e9d880 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.yaml @@ -16,6 +16,42 @@ types: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -40,6 +76,13 @@ types: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FileMode/documentation.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FileMode/documentation.yaml index cf653fb..5ecab20 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FileMode/documentation.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FileMode/documentation.yaml @@ -18,6 +18,42 @@ namespaces: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -42,6 +78,13 @@ namespaces: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml index 2fb33bc..9e9d880 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/index.yaml @@ -16,6 +16,42 @@ types: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -40,6 +76,13 @@ types: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FolderMode/documentation.yaml b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FolderMode/documentation.yaml index cf653fb..5ecab20 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FolderMode/documentation.yaml +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Baselines/net9.0/YamlRenderer/FolderMode/documentation.yaml @@ -18,6 +18,42 @@ namespaces: signature: public const string framework declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.framework + - accessibility: Public + memberKind: Method + methodKind: PropertyGet + name: get_TestContext + returnType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext.get + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.get + - accessibility: Public + memberKind: Method + methodKind: PropertySet + name: set_TestContext + parameters: + - name: value + parameterType: + assemblyName: MSTest.TestFramework.Extensions + fullName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + name: TestContext + signature: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeKind: Error + isExternalReference: true + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + typeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + displayName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext value + returnTypeName: void + signature: public void TestContext.set + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext.set - accessibility: Public memberKind: Method methodKind: Ordinary @@ -42,6 +78,13 @@ namespaces: signature: public DotNetDocsTestBase() declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.DotNetDocsTestBase() + - accessibility: Public + memberKind: Property + name: TestContext + returnTypeName: Microsoft.VisualStudio.TestTools.UnitTesting.TestContext + signature: public required Microsoft.VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; } + declaringTypeName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase + displayName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase.TestContext assemblyName: CloudNimble.DotNetDocs.Tests.Shared fullName: CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase name: DotNetDocsTestBase diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Configuration/DotNetDocsBuilderTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/Configuration/DotNetDocsBuilderTests.cs index 44de6d9..1b2d8b3 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Configuration/DotNetDocsBuilderTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Configuration/DotNetDocsBuilderTests.cs @@ -54,7 +54,7 @@ public void AddDotNetDocsPipeline_ConfiguresBasicPipeline() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); + renderers.Should().ContainSingle(); renderers.Should().AllBeOfType(); var manager = TestHost.Services.GetService(); @@ -152,15 +152,15 @@ public void AddDotNetDocsPipeline_AddsCustomComponents() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); + renderers.Should().ContainSingle(); renderers.Should().AllBeOfType(); var enrichers = TestHost.Services.GetServices().ToList(); - enrichers.Should().HaveCount(1); + enrichers.Should().ContainSingle(); enrichers.Should().AllBeOfType(); var transformers = TestHost.Services.GetServices().ToList(); - transformers.Should().HaveCount(1); + transformers.Should().ContainSingle(); transformers.Should().AllBeOfType(); } @@ -189,7 +189,7 @@ public void AddDotNetDocsPipeline_ComplexConfiguration() renderers.Should().HaveCount(2); var enrichers = TestHost.Services.GetServices().ToList(); - enrichers.Should().HaveCount(1); + enrichers.Should().ContainSingle(); var transformers = TestHost.Services.GetServices().ToList(); transformers.Should().HaveCount(2, "UseMarkdownRenderer now adds MarkdownXmlTransformer plus our TestTransformer"); @@ -233,9 +233,9 @@ public void DotNetDocsPipeline_MultipleRenderers_NoDuplicates() // Assert var renderers = TestHost.Services.GetServices().ToList(); renderers.Should().HaveCount(3, "each renderer should only be registered once"); - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); } [TestMethod] @@ -257,15 +257,15 @@ public void DotNetDocsPipeline_MultipleCustomComponents_NoDuplicates() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); + renderers.Should().ContainSingle(); renderers.Should().AllBeOfType(); var enrichers = TestHost.Services.GetServices().ToList(); - enrichers.Should().HaveCount(1); + enrichers.Should().ContainSingle(); enrichers.Should().AllBeOfType(); var transformers = TestHost.Services.GetServices().ToList(); - transformers.Should().HaveCount(1); + transformers.Should().ContainSingle(); transformers.Should().AllBeOfType(); } @@ -365,7 +365,7 @@ public void DotNetDocsBuilder_SupportsMethodChaining() private class TestRenderer : IDocRenderer { public string OutputFormat => "Test"; - public Task RenderAsync(DocAssembly model) => Task.CompletedTask; + public Task RenderAsync(DocAssembly? model) => Task.CompletedTask; public Task RenderPlaceholdersAsync(DocAssembly model) => Task.CompletedTask; } diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/DocAssemblyTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/DocAssemblyTests.cs index 957a493..ec6c05a 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/DocAssemblyTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/DocAssemblyTests.cs @@ -55,7 +55,7 @@ public void Namespaces_CanBeAdded() docAssembly.Namespaces.Add(docNamespace); - docAssembly.Namespaces.Should().HaveCount(1); + docAssembly.Namespaces.Should().ContainSingle(); docAssembly.Namespaces.Should().Contain(docNamespace); } diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/DocEntityTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/DocEntityTests.cs index 83217f4..d5e32b3 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/DocEntityTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/DocEntityTests.cs @@ -3,7 +3,6 @@ using FluentAssertions; using Microsoft.CodeAnalysis; using Microsoft.VisualStudio.TestTools.UnitTesting; -using System.Collections.Generic; using System.Linq; namespace CloudNimble.DotNetDocs.Tests.Core @@ -49,7 +48,7 @@ public void DocEntity_Properties_CanBeSetAndRetrieved() Considerations = "Important notes" }; - entity.RelatedApis ??= new List(); + entity.RelatedApis ??= []; entity.RelatedApis.Add("System.String"); entity.RelatedApis.Add("System.Object"); @@ -67,7 +66,7 @@ public void DocEntity_RelatedApis_SupportsMultipleEntries() { var entity = new TestDocEntity(); - entity.RelatedApis ??= new List(); + entity.RelatedApis ??= []; entity.RelatedApis.Add("https://docs.microsoft.com/api1"); entity.RelatedApis.Add("System.Collections.Generic.List"); entity.RelatedApis.Add("MyNamespace.MyClass.MyMethod"); @@ -85,7 +84,7 @@ public void DocEntity_IncludedMembers_DefaultsToPublic() var entity = new TestDocEntity(); entity.IncludedMembers.Should().NotBeNull(); - entity.IncludedMembers.Should().HaveCount(1); + entity.IncludedMembers.Should().ContainSingle(); entity.IncludedMembers.Should().Contain(Accessibility.Public); } @@ -114,29 +113,29 @@ public void DocEntity_AllXmlDocProperties_CanBeSet() DisplayName = "Full.Display.Name" }; - entity.Exceptions = new List - { + entity.Exceptions = + [ new() { Type = "ArgumentException", Description = "Invalid argument" } - }; + ]; - entity.TypeParameters = new List - { + entity.TypeParameters = + [ new() { Name = "T", Description = "Type parameter" } - }; + ]; - entity.SeeAlso = new List - { + entity.SeeAlso = + [ new DocReference("T:RelatedType"), new DocReference("T:AnotherType") - }; + ]; entity.Summary.Should().Be("Brief description"); entity.Remarks.Should().Be("Additional remarks"); entity.Returns.Should().Be("Return value description"); entity.Value.Should().Be("Property value description"); entity.DisplayName.Should().Be("Full.Display.Name"); - entity.Exceptions.Should().HaveCount(1); - entity.TypeParameters.Should().HaveCount(1); + entity.Exceptions.Should().ContainSingle(); + entity.TypeParameters.Should().ContainSingle(); entity.SeeAlso.Should().HaveCount(2); } diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/DocMemberTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/DocMemberTests.cs index 0dcdf78..3b414c4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/DocMemberTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/DocMemberTests.cs @@ -97,7 +97,7 @@ public void Parameters_CanBeAdded() newDocMember.Parameters.Add(docParam); - newDocMember.Parameters.Should().HaveCount(1); + newDocMember.Parameters.Should().ContainSingle(); newDocMember.Parameters.Should().Contain(docParam); } diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/DocReferenceHandlerBaseTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/DocReferenceHandlerBaseTests.cs new file mode 100644 index 0000000..7336644 --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Tests.Core/DocReferenceHandlerBaseTests.cs @@ -0,0 +1,416 @@ +using CloudNimble.DotNetDocs.Core; +using CloudNimble.DotNetDocs.Core.Configuration; +using CloudNimble.DotNetDocs.Tests.Shared; +using FluentAssertions; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using System; +using System.Collections.Generic; +using System.IO; +using System.Threading.Tasks; + +namespace CloudNimble.DotNetDocs.Tests.Core +{ + + /// + /// Tests for , covering the base file copying + /// and exclusion pattern matching functionality. + /// + [TestClass] + public class DocReferenceHandlerBaseTests : DotNetDocsTestBase + { + + #region Private Fields + + private string? _tempDirectory; + + #endregion + + #region Test Lifecycle + + [TestInitialize] + public void TestInitialize() + { + _tempDirectory = Path.Combine(Path.GetTempPath(), $"DocRefHandlerTests_{Guid.NewGuid()}"); + Directory.CreateDirectory(_tempDirectory); + } + + [TestCleanup] + public void TestCleanup() + { + if (_tempDirectory is not null && Directory.Exists(_tempDirectory)) + { + try + { + Directory.Delete(_tempDirectory, recursive: true); + } + catch + { + // Ignore cleanup errors in tests + } + } + } + + #endregion + + #region GetExclusionPatternsForDocumentationType Tests + + [TestMethod] + public void GetExclusionPatternsForDocumentationType_Mintlify_ReturnsCorrectPatterns() + { + var handler = new TestDocReferenceHandler(); + + var patterns = handler.TestGetExclusionPatternsForDocumentationType(SupportedDocumentationType.Mintlify); + + patterns.Should().NotBeNull(); + patterns.Should().Contain("**/*.mdz"); + patterns.Should().Contain("conceptual/**/*"); + patterns.Should().Contain("**/*.css"); + patterns.Should().Contain("docs.json"); + patterns.Should().Contain("assembly-list.txt"); + patterns.Should().Contain("*.docsproj"); + } + + [TestMethod] + public void GetExclusionPatternsForDocumentationType_DocFX_ReturnsCorrectPatterns() + { + var handler = new TestDocReferenceHandler(); + + var patterns = handler.TestGetExclusionPatternsForDocumentationType(SupportedDocumentationType.DocFX); + + patterns.Should().NotBeNull(); + patterns.Should().Contain("toc.yml"); + patterns.Should().Contain("toc.yaml"); + patterns.Should().Contain("docfx.json"); + } + + [TestMethod] + public void GetExclusionPatternsForDocumentationType_MkDocs_ReturnsCorrectPatterns() + { + var handler = new TestDocReferenceHandler(); + + var patterns = handler.TestGetExclusionPatternsForDocumentationType(SupportedDocumentationType.MkDocs); + + patterns.Should().NotBeNull(); + patterns.Should().Contain("mkdocs.yml"); + } + + [TestMethod] + public void GetExclusionPatternsForDocumentationType_Jekyll_ReturnsCorrectPatterns() + { + var handler = new TestDocReferenceHandler(); + + var patterns = handler.TestGetExclusionPatternsForDocumentationType(SupportedDocumentationType.Jekyll); + + patterns.Should().NotBeNull(); + patterns.Should().Contain("_config.yml"); + patterns.Should().Contain("_config.yaml"); + } + + [TestMethod] + public void GetExclusionPatternsForDocumentationType_Hugo_ReturnsCorrectPatterns() + { + var handler = new TestDocReferenceHandler(); + + var patterns = handler.TestGetExclusionPatternsForDocumentationType(SupportedDocumentationType.Hugo); + + patterns.Should().NotBeNull(); + patterns.Should().Contain("hugo.toml"); + patterns.Should().Contain("hugo.yaml"); + patterns.Should().Contain("hugo.json"); + patterns.Should().Contain("config.*"); + } + + [TestMethod] + public void GetExclusionPatternsForDocumentationType_UnknownType_ReturnsEmptyList() + { + var handler = new TestDocReferenceHandler(); + + var patterns = handler.TestGetExclusionPatternsForDocumentationType(SupportedDocumentationType.Generic); + + patterns.Should().NotBeNull(); + patterns.Should().BeEmpty(); + } + + #endregion + + #region ShouldExcludeFile Tests + + [TestMethod] + public void ShouldExcludeFile_WithMdzPattern_ExcludesMdzFiles() + { + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "**/*.mdz" }; + + handler.TestShouldExcludeFile("file.mdz", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("api-reference/test.mdz", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("deeply/nested/path/file.mdz", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("file.md", exclusionPatterns).Should().BeFalse(); + handler.TestShouldExcludeFile("file.mdx", exclusionPatterns).Should().BeFalse(); + } + + [TestMethod] + public void ShouldExcludeFile_WithConceptualPattern_ExcludesConceptualFolder() + { + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "conceptual/**/*" }; + + handler.TestShouldExcludeFile("conceptual/guide.md", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("conceptual/nested/file.mdx", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("api-reference/file.md", exclusionPatterns).Should().BeFalse(); + handler.TestShouldExcludeFile("guide.md", exclusionPatterns).Should().BeFalse(); + } + + [TestMethod] + public void ShouldExcludeFile_WithCssPattern_ExcludesCssFiles() + { + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "**/*.css" }; + + handler.TestShouldExcludeFile("style.css", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("assets/main.css", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("deeply/nested/theme.css", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("style.scss", exclusionPatterns).Should().BeFalse(); + handler.TestShouldExcludeFile("file.css.map", exclusionPatterns).Should().BeFalse(); + } + + [TestMethod] + public void ShouldExcludeFile_WithDocsJsonPattern_ExcludesDocsJson() + { + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "docs.json" }; + + handler.TestShouldExcludeFile("docs.json", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("nested/docs.json", exclusionPatterns).Should().BeFalse(); // Exact match only + handler.TestShouldExcludeFile("docs-template.json", exclusionPatterns).Should().BeFalse(); + } + + [TestMethod] + public void ShouldExcludeFile_WithAssemblyListPattern_ExcludesAssemblyList() + { + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "assembly-list.txt" }; + + handler.TestShouldExcludeFile("assembly-list.txt", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("nested/assembly-list.txt", exclusionPatterns).Should().BeFalse(); // Exact match only + handler.TestShouldExcludeFile("assembly-list-backup.txt", exclusionPatterns).Should().BeFalse(); + } + + [TestMethod] + public void ShouldExcludeFile_WithDocsprojPattern_ExcludesDocsprojFiles() + { + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "*.docsproj" }; + + handler.TestShouldExcludeFile("MyProject.docsproj", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("Documentation.docsproj", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("nested/Project.docsproj", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeFile("MyProject.csproj", exclusionPatterns).Should().BeFalse(); + } + + [TestMethod] + public void ShouldExcludeFile_NonMatchingFile_DoesNotExclude() + { + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "**/*.mdz", "conceptual/**/*", "**/*.css", "docs.json", "assembly-list.txt", "*.docsproj" }; + + handler.TestShouldExcludeFile("index.mdx", exclusionPatterns).Should().BeFalse(); + handler.TestShouldExcludeFile("api-reference/class.md", exclusionPatterns).Should().BeFalse(); + handler.TestShouldExcludeFile("snippets/example.jsx", exclusionPatterns).Should().BeFalse(); + handler.TestShouldExcludeFile("images/logo.png", exclusionPatterns).Should().BeFalse(); + } + + #endregion + + #region ShouldExcludeDirectory Tests + + [TestMethod] + public void ShouldExcludeDirectory_WithConceptualPattern_ExcludesConceptualDirectory() + { + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "conceptual/**/*" }; + + handler.TestShouldExcludeDirectory("conceptual", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeDirectory("conceptual/guides", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeDirectory("conceptual/guides/nested", exclusionPatterns).Should().BeTrue(); + handler.TestShouldExcludeDirectory("api-reference", exclusionPatterns).Should().BeFalse(); + handler.TestShouldExcludeDirectory("guides", exclusionPatterns).Should().BeFalse(); + } + + #endregion + + #region MatchesGlobPattern Tests + + [TestMethod] + public void MatchesGlobPattern_WithVariousPatterns_MatchesCorrectly() + { + var handler = new TestDocReferenceHandler(); + + // Test **/*.ext pattern + handler.TestMatchesGlobPattern("file.mdz", "**/*.mdz").Should().BeTrue(); + handler.TestMatchesGlobPattern("path/file.mdz", "**/*.mdz").Should().BeTrue(); + handler.TestMatchesGlobPattern("deep/nested/file.mdz", "**/*.mdz").Should().BeTrue(); + handler.TestMatchesGlobPattern("file.md", "**/*.mdz").Should().BeFalse(); + + // Test directory/**/* pattern + handler.TestMatchesGlobPattern("conceptual/file.md", "conceptual/**/*").Should().BeTrue(); + handler.TestMatchesGlobPattern("conceptual/nested/file.md", "conceptual/**/*").Should().BeTrue(); + handler.TestMatchesGlobPattern("api-reference/file.md", "conceptual/**/*").Should().BeFalse(); + + // Test exact match + handler.TestMatchesGlobPattern("docs.json", "docs.json").Should().BeTrue(); + handler.TestMatchesGlobPattern("nested/docs.json", "docs.json").Should().BeFalse(); + + // Test *.ext pattern + handler.TestMatchesGlobPattern("file.css", "*.css").Should().BeTrue(); + handler.TestMatchesGlobPattern("path/file.css", "*.css").Should().BeTrue(); + handler.TestMatchesGlobPattern("file.scss", "*.css").Should().BeFalse(); + } + + #endregion + + #region CopyDirectoryWithExclusionsAsync Tests + + [TestMethod] + public async Task CopyDirectoryWithExclusionsAsync_SkipsExcludedFiles() + { + var sourceDir = Path.Combine(_tempDirectory!, "source"); + var destDir = Path.Combine(_tempDirectory!, "dest"); + Directory.CreateDirectory(sourceDir); + + File.WriteAllText(Path.Combine(sourceDir, "index.mdx"), "content"); + File.WriteAllText(Path.Combine(sourceDir, "test.mdz"), "content"); + File.WriteAllText(Path.Combine(sourceDir, "style.css"), "content"); + File.WriteAllText(Path.Combine(sourceDir, "docs.json"), "content"); + + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "**/*.mdz", "**/*.css", "docs.json" }; + + await handler.TestCopyDirectoryWithExclusionsAsync(sourceDir, destDir, exclusionPatterns); + + File.Exists(Path.Combine(destDir, "index.mdx")).Should().BeTrue("index.mdx should be copied"); + File.Exists(Path.Combine(destDir, "test.mdz")).Should().BeFalse("test.mdz should be excluded"); + File.Exists(Path.Combine(destDir, "style.css")).Should().BeFalse("style.css should be excluded"); + File.Exists(Path.Combine(destDir, "docs.json")).Should().BeFalse("docs.json should be excluded"); + } + + [TestMethod] + public async Task CopyDirectoryWithExclusionsAsync_CopiesNestedDirectories() + { + var sourceDir = Path.Combine(_tempDirectory!, "source2"); + var destDir = Path.Combine(_tempDirectory!, "dest2"); + Directory.CreateDirectory(sourceDir); + Directory.CreateDirectory(Path.Combine(sourceDir, "api-reference")); + Directory.CreateDirectory(Path.Combine(sourceDir, "conceptual")); + + File.WriteAllText(Path.Combine(sourceDir, "index.mdx"), "content"); + File.WriteAllText(Path.Combine(sourceDir, "api-reference", "class.md"), "content"); + File.WriteAllText(Path.Combine(sourceDir, "conceptual", "guide.md"), "content"); + + var handler = new TestDocReferenceHandler(); + var exclusionPatterns = new List { "conceptual/**/*" }; + + await handler.TestCopyDirectoryWithExclusionsAsync(sourceDir, destDir, exclusionPatterns); + + File.Exists(Path.Combine(destDir, "index.mdx")).Should().BeTrue("index.mdx should be copied"); + File.Exists(Path.Combine(destDir, "api-reference", "class.md")).Should().BeTrue("api-reference/class.md should be copied"); + Directory.Exists(Path.Combine(destDir, "conceptual")).Should().BeFalse("conceptual directory should not be copied"); + File.Exists(Path.Combine(destDir, "conceptual", "guide.md")).Should().BeFalse("conceptual/guide.md should be excluded"); + } + + [TestMethod] + public async Task CopyDirectoryWithExclusionsAsync_SkipsExistingFiles_WhenSkipExistingTrue() + { + var sourceDir = Path.Combine(_tempDirectory!, "source3"); + var destDir = Path.Combine(_tempDirectory!, "dest3"); + Directory.CreateDirectory(sourceDir); + Directory.CreateDirectory(destDir); + + File.WriteAllText(Path.Combine(sourceDir, "file.txt"), "new content"); + File.WriteAllText(Path.Combine(destDir, "file.txt"), "existing content"); + + var handler = new TestDocReferenceHandler(); + + await handler.TestCopyDirectoryWithExclusionsAsync(sourceDir, destDir, [], skipExisting: true); + + File.ReadAllText(Path.Combine(destDir, "file.txt")).Should().Be("existing content", "existing file should not be overwritten"); + } + + [TestMethod] + public async Task CopyDirectoryWithExclusionsAsync_OverwritesFiles_WhenSkipExistingFalse() + { + var sourceDir = Path.Combine(_tempDirectory!, "source4"); + var destDir = Path.Combine(_tempDirectory!, "dest4"); + Directory.CreateDirectory(sourceDir); + Directory.CreateDirectory(destDir); + + File.WriteAllText(Path.Combine(sourceDir, "file.txt"), "new content"); + File.WriteAllText(Path.Combine(destDir, "file.txt"), "existing content"); + + var handler = new TestDocReferenceHandler(); + + await handler.TestCopyDirectoryWithExclusionsAsync(sourceDir, destDir, [], skipExisting: false); + + File.ReadAllText(Path.Combine(destDir, "file.txt")).Should().Be("new content", "existing file should be overwritten"); + } + + [TestMethod] + public async Task CopyDirectoryWithExclusionsAsync_SourceDirectoryMissing_ReturnsWithoutError() + { + var sourceDir = Path.Combine(_tempDirectory!, "nonexistent"); + var destDir = Path.Combine(_tempDirectory!, "dest5"); + + var handler = new TestDocReferenceHandler(); + + await handler.TestCopyDirectoryWithExclusionsAsync(sourceDir, destDir, []); + + Directory.Exists(destDir).Should().BeFalse("destination should not be created when source doesn't exist"); + } + + #endregion + + #region Test Helper Class + + /// + /// Concrete implementation of for testing. + /// Exposes protected methods as public for test access. + /// + private class TestDocReferenceHandler : DocReferenceHandlerBase + { + public override SupportedDocumentationType DocumentationType => SupportedDocumentationType.Generic; + + public override Task ProcessAsync(DocumentationReference reference, string documentationRootPath) + { + return Task.CompletedTask; + } + + public List TestGetExclusionPatternsForDocumentationType(SupportedDocumentationType documentationType) + { + return GetExclusionPatternsForDocumentationType(documentationType); + } + + public bool TestShouldExcludeFile(string relativePath, List exclusionPatterns) + { + return ShouldExcludeFile(relativePath, exclusionPatterns); + } + + public bool TestShouldExcludeDirectory(string relativePath, List exclusionPatterns) + { + return ShouldExcludeDirectory(relativePath, exclusionPatterns); + } + + public bool TestMatchesGlobPattern(string path, string pattern) + { + return MatchesGlobPattern(path, pattern); + } + + public Task TestCopyDirectoryWithExclusionsAsync(string sourceDir, string destDir, List exclusionPatterns, bool skipExisting = true) + { + return CopyDirectoryWithExclusionsAsync(sourceDir, destDir, exclusionPatterns, skipExisting); + } + } + + #endregion + + } + +} diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/DocTypeTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/DocTypeTests.cs index 9db676b..ed924aa 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/DocTypeTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/DocTypeTests.cs @@ -1,5 +1,4 @@ using System; -using System.Collections.Generic; using System.Linq; using CloudNimble.DotNetDocs.Core; using CloudNimble.DotNetDocs.Tests.Shared; @@ -67,7 +66,7 @@ public void Properties_CanBeSetAndRetrieved() Considerations = "Important considerations" }; - docType.RelatedApis ??= new List(); + docType.RelatedApis ??= []; docType.RelatedApis.Add("System.String"); docType.RelatedApis.Add("System.Object"); diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/DocumentationManagerTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/DocumentationManagerTests.cs index 5e8f8fa..7595d54 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/DocumentationManagerTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/DocumentationManagerTests.cs @@ -27,185 +27,21 @@ public class DocumentationManagerTests : DotNetDocsTestBase private string? _testAssemblyPath; private string? _testXmlPath; - [TestMethod] - public void GetFilePatternsForDocumentationType_Mintlify_ReturnsCorrectPatterns() - { - // Arrange - var manager = GetDocumentationManager(); - - // Act - var patterns = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.Mintlify); - - // Assert - patterns.Should().NotBeNull(); - patterns.Should().Contain("*.md"); - patterns.Should().Contain("*.mdx"); - patterns.Should().Contain("*.mdz"); - patterns.Should().Contain("docs.json"); - patterns.Should().Contain("images/**/*"); - patterns.Should().Contain("favicon.*"); - patterns.Should().Contain("snippets/**/*"); - } - - [TestMethod] - public void GetFilePatternsForDocumentationType_DocFX_ReturnsCorrectPatterns() - { - // Arrange - var manager = GetDocumentationManager(); - - // Act - var patterns = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.DocFX); - - // Assert - patterns.Should().NotBeNull(); - patterns.Should().Contain("*.md"); - patterns.Should().Contain("*.yml"); - patterns.Should().Contain("toc.yml"); - patterns.Should().Contain("docfx.json"); - patterns.Should().Contain("images/**/*"); - } - - [TestMethod] - public void GetFilePatternsForDocumentationType_MkDocs_ReturnsCorrectPatterns() - { - // Arrange - var manager = GetDocumentationManager(); - - // Act - var patterns = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.MkDocs); - - // Assert - patterns.Should().NotBeNull(); - patterns.Should().Contain("*.md"); - patterns.Should().Contain("mkdocs.yml"); - patterns.Should().Contain("docs/**/*"); - } - - [TestMethod] - public void GetFilePatternsForDocumentationType_Unknown_ReturnsDefaultPatterns() - { - // Arrange - var manager = GetDocumentationManager(); - - // Act - var patterns = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.Generic); - - // Assert - patterns.Should().NotBeNull(); - patterns.Should().Contain("*.md"); - patterns.Should().Contain("*.html"); - patterns.Should().Contain("images/**/*"); - patterns.Should().Contain("assets/**/*"); - } - - [TestMethod] - public async Task CopyFilesAsync_SimplePattern_CopiesMatchingFiles() - { - // Arrange - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test1.md"), "Test content 1"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test2.md"), "Test content 2"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.txt"), "Not copied"); - - // Act - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); - - // Assert - File.Exists(Path.Combine(destDir, "test1.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "test2.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "test.txt")).Should().BeFalse(); - } - - [TestMethod] - public async Task CopyFilesAsync_SkipExisting_PreservesExistingFiles() - { - // Arrange - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(sourceDir); - Directory.CreateDirectory(destDir); - - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), "New content"); - await File.WriteAllTextAsync(Path.Combine(destDir, "test.md"), "Original content"); - - // Act - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); - - // Assert - var content = await File.ReadAllTextAsync(Path.Combine(destDir, "test.md")); - content.Should().Be("Original content", "existing files should not be overwritten when skipExisting is true"); - } - - [TestMethod] - public async Task CopyDirectoryRecursiveAsync_PreservesStructure() - { - // Arrange - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(Path.Combine(sourceDir, "subdir1")); - Directory.CreateDirectory(Path.Combine(sourceDir, "subdir2")); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "root.md"), "Root file"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "subdir1", "file1.md"), "File 1"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "subdir2", "file2.md"), "File 2"); - - // Act - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*", skipExisting: true); - - // Assert - File.Exists(Path.Combine(destDir, "root.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "subdir1", "file1.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "subdir2", "file2.md")).Should().BeTrue(); - } - - [TestMethod] - public async Task CopyReferencedDocumentationAsync_ProcessesAllReferences() - { - // Arrange - var manager = GetDocumentationManager(); - var context = GetService(); - - var sourceDir1 = Path.Combine(_tempDirectory!, "ref1"); - var sourceDir2 = Path.Combine(_tempDirectory!, "ref2"); - Directory.CreateDirectory(sourceDir1); - Directory.CreateDirectory(sourceDir2); - - await File.WriteAllTextAsync(Path.Combine(sourceDir1, "test1.md"), "Content 1"); - await File.WriteAllTextAsync(Path.Combine(sourceDir2, "test2.md"), "Content 2"); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = sourceDir1, - DestinationPath = "ref1", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = sourceDir2, - DestinationPath = "ref2", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - // Act - await manager.CopyReferencedDocumentationAsync(); - - // Assert - File.Exists(Path.Combine(context.DocumentationRootPath, "ref1", "test1.md")).Should().BeTrue(); - File.Exists(Path.Combine(context.DocumentationRootPath, "ref2", "test2.md")).Should().BeTrue(); - } - #endregion #region IsTodoPlaceholderFile Tests + // NOTE: The following tests for deleted/moved methods have been removed: + // - GetFilePatternsForDocumentationType_* tests (method deleted - dead code) + // - CopyFilesAsync_* tests (method deleted - dead code) + // - CopyDirectoryRecursiveAsync_* tests (method deleted - dead code) + // - CopyReferencedDocumentationAsync_* tests (method replaced with ProcessDocumentationReferencesAsync) + // - GetExclusionPatternsForDocumentationType_* tests (moved to DocReferenceHandlerBaseTests) + // - ShouldExcludeFile_* tests (moved to DocReferenceHandlerBaseTests) + // - ShouldExcludeDirectory_* tests (moved to DocReferenceHandlerBaseTests) + // - CopyDirectoryWithExclusionsAsync_* tests (moved to DocReferenceHandlerBaseTests) + // - MatchesGlobPattern_* tests (moved to DocReferenceHandlerBaseTests) + [TestMethod] public void IsTodoPlaceholderFile_ValidTodoComment_ReturnsTrue() { @@ -391,14 +227,17 @@ public void IsTodoPlaceholderFile_Lowercase_ReturnsTrue() #region Merge Tests - MergeDocAssembliesAsync [TestMethod] - public async Task MergeDocAssembliesAsync_EmptyList_ThrowsArgumentException() + public async Task MergeDocAssembliesAsync_EmptyList_ReturnsNull() { + // Arrange var manager = GetDocumentationManager(); var emptyList = new List(); - Func act = async () => await manager.MergeDocAssembliesAsync(emptyList); + // Act - In documentation-only mode, an empty list is valid and returns null + var result = await manager.MergeDocAssembliesAsync(emptyList); - await act.Should().ThrowAsync(); + // Assert - Empty lists now return null to support documentation-only scenarios + result.Should().BeNull(); } [TestMethod] @@ -430,7 +269,8 @@ public async Task MergeDocAssembliesAsync_TwoAssembliesDistinctNamespaces_Contai var result = await manager.MergeDocAssembliesAsync([assembly1, assembly2]); - result.Namespaces.Should().HaveCount(2); + result.Should().NotBeNull(); + result!.Namespaces.Should().HaveCount(2); result.Namespaces.Should().Contain(ns => ns.Symbol.ToDisplayString() == ns1.Symbol.ToDisplayString()); result.Namespaces.Should().Contain(ns => ns.Symbol.ToDisplayString() == ns2.Symbol.ToDisplayString()); } @@ -457,8 +297,9 @@ public async Task MergeDocAssembliesAsync_AssembliesWithNoNamespaces_ReturnsFirs var result = await manager.MergeDocAssembliesAsync([assembly1, assembly2]); + result.Should().NotBeNull(); result.Should().BeSameAs(assembly1); - result.Namespaces.Should().BeEmpty(); + result!.Namespaces.Should().BeEmpty(); } #endregion @@ -591,7 +432,7 @@ public async Task MergeTypeAsync_NewType_AddsToNamespace() await manager.MergeTypeAsync(ns, typeToAdd); - ns.Types.Should().HaveCount(1); + ns.Types.Should().ContainSingle(); ns.Types.Should().Contain(t => t.Symbol.ToDisplayString() == typeToAdd.Symbol.ToDisplayString()); } @@ -723,7 +564,7 @@ public async Task MergeMemberAsync_NewMember_AddsToType() await manager.MergeMemberAsync(type, memberToAdd); - type.Members.Should().HaveCount(1); + type.Members.Should().ContainSingle(); type.Members.Should().Contain(m => m.Symbol.ToDisplayString() == memberToAdd.Symbol.ToDisplayString()); } @@ -742,7 +583,7 @@ public async Task MergeMemberAsync_DuplicateMember_SkipsAddition() await manager.MergeMemberAsync(type, member); - type.Members.Should().HaveCount(1, "duplicate member should not be added"); + type.Members.Should().ContainSingle("duplicate member should not be added"); } [TestMethod] @@ -842,7 +683,7 @@ public async Task ProcessAsync_WithDocumentationReferences_CopiesReferenceFiles( var sourceDir = Path.Combine(_tempDirectory!, "refSource"); Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), "Reference content"); + await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), "Reference content", TestContext.CancellationToken); context.DocumentationReferences.Add(new DocumentationReference { @@ -853,7 +694,7 @@ public async Task ProcessAsync_WithDocumentationReferences_CopiesReferenceFiles( await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - context.DocumentationReferences.Should().HaveCount(1); + context.DocumentationReferences.Should().ContainSingle(); } [TestMethod] @@ -903,7 +744,7 @@ public async Task ProcessAsync_EmptyAssemblyList_CompletesWithoutError() Func act = async () => await manager.ProcessAsync(emptyAssemblies); - await act.Should().ThrowAsync("empty assembly list should throw"); + await act.Should().NotThrowAsync("empty assembly list should not throw"); } #endregion @@ -932,7 +773,7 @@ public async Task LoadConceptualAsync_GlobalNamespace_LoadsContentCorrectly() context.ConceptualPath = Path.Combine(_tempDirectory!, "conceptual"); Directory.CreateDirectory(context.ConceptualPath); - await File.WriteAllTextAsync(Path.Combine(context.ConceptualPath, "summary.mdz"), "Global namespace summary"); + await File.WriteAllTextAsync(Path.Combine(context.ConceptualPath, "summary.mdz"), "Global namespace summary", TestContext.CancellationToken); var assembly = await GetSingleTestAssembly(); @@ -959,7 +800,7 @@ public async Task LoadConceptualAsync_NamespaceRelatedApis_ParsesCorrectly() System.Linq.Enumerable System.String"; - await File.WriteAllTextAsync(Path.Combine(nsPath, "related-apis.mdz"), relatedApisContent); + await File.WriteAllTextAsync(Path.Combine(nsPath, "related-apis.mdz"), relatedApisContent, TestContext.CancellationToken); var assembly = await GetSingleTestAssembly(); @@ -987,7 +828,7 @@ public async Task LoadConceptualAsync_TypeRelatedApis_ParsesCorrectly() var relatedApisContent = @"CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass"; - await File.WriteAllTextAsync(Path.Combine(typePath, "related-apis.mdz"), relatedApisContent); + await File.WriteAllTextAsync(Path.Combine(typePath, "related-apis.mdz"), relatedApisContent, TestContext.CancellationToken); var assembly = await GetSingleTestAssembly(); @@ -1023,7 +864,7 @@ public async Task LoadConceptualAsync_MemberRelatedApis_ParsesCorrectly() Directory.CreateDirectory(memberDir); var relatedApisContent = "System.String.Empty\nSystem.String.IsNullOrWhiteSpace"; - await File.WriteAllTextAsync(Path.Combine(memberDir, "related-apis.mdz"), relatedApisContent); + await File.WriteAllTextAsync(Path.Combine(memberDir, "related-apis.mdz"), relatedApisContent, TestContext.CancellationToken); await manager.LoadConceptualAsync(assembly); @@ -1044,7 +885,7 @@ public async Task LoadConceptualAsync_RelatedApisPlaceholder_SkipsWhenShowPlaceh Directory.CreateDirectory(nsPath); var placeholderContent = ""; - await File.WriteAllTextAsync(Path.Combine(nsPath, "related-apis.mdz"), placeholderContent); + await File.WriteAllTextAsync(Path.Combine(nsPath, "related-apis.mdz"), placeholderContent, TestContext.CancellationToken); var assembly = await GetSingleTestAssembly(); @@ -1065,12 +906,12 @@ public async Task LoadConceptualAsync_AllConceptualFileTypes_LoadsAll() var nsPath = Path.Combine(context.ConceptualPath, "CloudNimble", "DotNetDocs", "Tests", "Shared", "BasicScenarios"); Directory.CreateDirectory(nsPath); - await File.WriteAllTextAsync(Path.Combine(nsPath, "summary.mdz"), "Summary content"); - await File.WriteAllTextAsync(Path.Combine(nsPath, "usage.mdz"), "Usage content"); - await File.WriteAllTextAsync(Path.Combine(nsPath, "examples.mdz"), "Examples content"); - await File.WriteAllTextAsync(Path.Combine(nsPath, "best-practices.mdz"), "Best practices content"); - await File.WriteAllTextAsync(Path.Combine(nsPath, "patterns.mdz"), "Patterns content"); - await File.WriteAllTextAsync(Path.Combine(nsPath, "considerations.mdz"), "Considerations content"); + await File.WriteAllTextAsync(Path.Combine(nsPath, "summary.mdz"), "Summary content", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(nsPath, "usage.mdz"), "Usage content", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(nsPath, "examples.mdz"), "Examples content", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(nsPath, "best-practices.mdz"), "Best practices content", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(nsPath, "patterns.mdz"), "Patterns content", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(nsPath, "considerations.mdz"), "Considerations content", TestContext.CancellationToken); var assembly = await GetSingleTestAssembly(); @@ -1096,11 +937,11 @@ public async Task LoadConceptualAsync_TypeConceptualFiles_LoadsAll() var typePath = Path.Combine(context.ConceptualPath, "CloudNimble", "DotNetDocs", "Tests", "Shared", "BasicScenarios", "SimpleClass"); Directory.CreateDirectory(typePath); - await File.WriteAllTextAsync(Path.Combine(typePath, "usage.mdz"), "Type usage"); - await File.WriteAllTextAsync(Path.Combine(typePath, "examples.mdz"), "Type examples"); - await File.WriteAllTextAsync(Path.Combine(typePath, "best-practices.mdz"), "Type best practices"); - await File.WriteAllTextAsync(Path.Combine(typePath, "patterns.mdz"), "Type patterns"); - await File.WriteAllTextAsync(Path.Combine(typePath, "considerations.mdz"), "Type considerations"); + await File.WriteAllTextAsync(Path.Combine(typePath, "usage.mdz"), "Type usage", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(typePath, "examples.mdz"), "Type examples", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(typePath, "best-practices.mdz"), "Type best practices", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(typePath, "patterns.mdz"), "Type patterns", TestContext.CancellationToken); + await File.WriteAllTextAsync(Path.Combine(typePath, "considerations.mdz"), "Type considerations", TestContext.CancellationToken); var assembly = await GetSingleTestAssembly(); @@ -1131,7 +972,7 @@ public async Task LoadConceptualFileAsync_FileWithBOM_RemovesBOM() Directory.CreateDirectory(testDir); var contentWithBom = "\uFEFFTest content with BOM"; - await File.WriteAllTextAsync(Path.Combine(testDir, "test.md"), contentWithBom); + await File.WriteAllTextAsync(Path.Combine(testDir, "test.md"), contentWithBom, TestContext.CancellationToken); string? loadedContent = null; await manager.LoadConceptualFileAsync(testDir, "test.md", content => loadedContent = content); @@ -1148,7 +989,7 @@ public async Task LoadConceptualFileAsync_PlaceholderFile_SkipsWhenShowPlacehold Directory.CreateDirectory(testDir); var placeholderContent = ""; - await File.WriteAllTextAsync(Path.Combine(testDir, "test.md"), placeholderContent); + await File.WriteAllTextAsync(Path.Combine(testDir, "test.md"), placeholderContent, TestContext.CancellationToken); string? loadedContent = null; await manager.LoadConceptualFileAsync(testDir, "test.md", content => loadedContent = content, showPlaceholders: false); @@ -1164,7 +1005,7 @@ public async Task LoadConceptualFileAsync_PlaceholderFile_LoadsWhenShowPlacehold Directory.CreateDirectory(testDir); var placeholderContent = ""; - await File.WriteAllTextAsync(Path.Combine(testDir, "test.md"), placeholderContent); + await File.WriteAllTextAsync(Path.Combine(testDir, "test.md"), placeholderContent, TestContext.CancellationToken); string? loadedContent = null; await manager.LoadConceptualFileAsync(testDir, "test.md", content => loadedContent = content, showPlaceholders: true); @@ -1179,7 +1020,7 @@ public async Task LoadConceptualFileAsync_EmptyFile_DoesNotCallSetter() var testDir = Path.Combine(_tempDirectory!, "emptyTest"); Directory.CreateDirectory(testDir); - await File.WriteAllTextAsync(Path.Combine(testDir, "empty.md"), ""); + await File.WriteAllTextAsync(Path.Combine(testDir, "empty.md"), "", TestContext.CancellationToken); bool setterCalled = false; await manager.LoadConceptualFileAsync(testDir, "empty.md", content => setterCalled = true); @@ -1194,7 +1035,7 @@ public async Task LoadConceptualFileAsync_WhitespaceOnlyFile_DoesNotCallSetter() var testDir = Path.Combine(_tempDirectory!, "whitespaceTest"); Directory.CreateDirectory(testDir); - await File.WriteAllTextAsync(Path.Combine(testDir, "whitespace.md"), " \n\t\r\n "); + await File.WriteAllTextAsync(Path.Combine(testDir, "whitespace.md"), " \n\t\r\n ", TestContext.CancellationToken); bool setterCalled = false; await manager.LoadConceptualFileAsync(testDir, "whitespace.md", content => setterCalled = true); @@ -1223,7 +1064,7 @@ public async Task LoadConceptualFileAsync_ValidContent_TrimsWhitespace() Directory.CreateDirectory(testDir); var contentWithWhitespace = "\n\n Content with whitespace \n\n"; - await File.WriteAllTextAsync(Path.Combine(testDir, "trim.md"), contentWithWhitespace); + await File.WriteAllTextAsync(Path.Combine(testDir, "trim.md"), contentWithWhitespace, TestContext.CancellationToken); string? loadedContent = null; await manager.LoadConceptualFileAsync(testDir, "trim.md", content => loadedContent = content); @@ -1239,7 +1080,7 @@ public async Task LoadConceptualFileAsync_ContentWithBOMAndWhitespace_RemovesBot Directory.CreateDirectory(testDir); var contentWithBomAndWhitespace = "\uFEFF \n\nActual content\n\n "; - await File.WriteAllTextAsync(Path.Combine(testDir, "combined.md"), contentWithBomAndWhitespace); + await File.WriteAllTextAsync(Path.Combine(testDir, "combined.md"), contentWithBomAndWhitespace, TestContext.CancellationToken); string? loadedContent = null; await manager.LoadConceptualFileAsync(testDir, "combined.md", content => loadedContent = content); @@ -1258,7 +1099,7 @@ public async Task LoadConceptualFileAsync_PlaceholderWithLeadingWhitespace_Detec Directory.CreateDirectory(testDir); var placeholderWithWhitespace = " \n \n"; - await File.WriteAllTextAsync(Path.Combine(testDir, "placeholder.md"), placeholderWithWhitespace); + await File.WriteAllTextAsync(Path.Combine(testDir, "placeholder.md"), placeholderWithWhitespace, TestContext.CancellationToken); string? loadedContent = null; await manager.LoadConceptualFileAsync(testDir, "placeholder.md", content => loadedContent = content, showPlaceholders: false); @@ -1274,7 +1115,7 @@ public async Task LoadConceptualFileAsync_NonPlaceholderContent_LoadsNormally() Directory.CreateDirectory(testDir); var normalContent = "This is normal content\nWith multiple lines\nAnd no placeholder"; - await File.WriteAllTextAsync(Path.Combine(testDir, "normal.md"), normalContent); + await File.WriteAllTextAsync(Path.Combine(testDir, "normal.md"), normalContent, TestContext.CancellationToken); string? loadedContent = null; await manager.LoadConceptualFileAsync(testDir, "normal.md", content => loadedContent = content, showPlaceholders: false); @@ -1501,876 +1342,279 @@ public async Task CreateConceptualFilesAsync_ParallelExecution_CompletesSuccessf #endregion - #region CopyFilesAsync Additional Tests + // NOTE: The following test regions were removed because the methods they tested were deleted: + // - CopyFilesAsync Additional Tests (tests for deleted CopyFilesAsync method) + // - CopyDirectoryRecursiveAsync Additional Tests (tests for deleted CopyDirectoryRecursiveAsync method) + // - CopyReferencedDocumentationAsync Additional Tests (tests for deleted CopyReferencedDocumentationAsync method) + // - GetFilePatternsForDocumentationType Additional Tests (tests for deleted GetFilePatternsForDocumentationType method) + + #region Dispose Tests [TestMethod] - public async Task CopyFilesAsync_RecursivePattern_CopiesNestedFiles() + public void Dispose_WithCachedAssemblyManagers_DisposesAll() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - Directory.CreateDirectory(Path.Combine(sourceDir, "images", "icons")); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "images", "logo.png"), "logo"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "images", "icons", "check.png"), "check"); + manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); + var tempAssemblyPath = Path.Combine(_tempDirectory!, "temp.dll"); + File.Copy(_testAssemblyPath!, tempAssemblyPath, overwrite: true); + manager.GetOrCreateAssemblyManager(tempAssemblyPath, _testXmlPath!); - await manager.CopyFilesAsync(sourceDir, destDir, "images/**/*", skipExisting: true); + manager.Dispose(); - File.Exists(Path.Combine(destDir, "images", "logo.png")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "images", "icons", "check.png")).Should().BeTrue(); + manager.Should().NotBeNull("Dispose should complete without error"); } [TestMethod] - public async Task CopyFilesAsync_SourceDirectoryMissing_ReturnsWithoutError() + public void Dispose_CalledMultipleTimes_DoesNotThrow() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "nonexistent"); - var destDir = Path.Combine(_tempDirectory!, "dest"); + manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); + manager.Dispose(); - Directory.Exists(destDir).Should().BeFalse("destination should not be created when source doesn't exist"); + var act = () => manager.Dispose(); + act.Should().NotThrow("Dispose should be idempotent"); } [TestMethod] - public async Task CopyFilesAsync_SkipExistingFalse_OverwritesFiles() + public void Dispose_WithEmptyCache_CompletesSuccessfully() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(sourceDir); - Directory.CreateDirectory(destDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), "New content"); - await File.WriteAllTextAsync(Path.Combine(destDir, "test.md"), "Original content"); - - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: false); + var act = () => manager.Dispose(); - var content = await File.ReadAllTextAsync(Path.Combine(destDir, "test.md")); - content.Should().Be("New content", "file should be overwritten when skipExisting is false"); + act.Should().NotThrow("Dispose should handle empty cache gracefully"); } [TestMethod] - public async Task CopyFilesAsync_MultiplePatternMatches_CopiesAll() + public void Dispose_ClearsAssemblyManagerCache() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file1.md"), "content1"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file2.md"), "content2"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file3.md"), "content3"); + manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); + manager.Dispose(); - Directory.GetFiles(destDir, "*.md").Should().HaveCount(3); + var secondManager = manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); + secondManager.Should().NotBeNull("GetOrCreateAssemblyManager should work after Dispose"); } [TestMethod] - public async Task CopyFilesAsync_SpecificFileName_CopiesSingleFile() + public void Dispose_WithNullManagerInCache_HandlesGracefully() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "docs.json"), "{}"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "other.json"), "{}"); + manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - await manager.CopyFilesAsync(sourceDir, destDir, "docs.json", skipExisting: true); + var act = () => manager.Dispose(); - File.Exists(Path.Combine(destDir, "docs.json")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "other.json")).Should().BeFalse(); + act.Should().NotThrow("Dispose should handle null values in cache gracefully"); } + #endregion + + #region Integration Tests + [TestMethod] - public async Task CopyFilesAsync_NoMatchingFiles_CreatesEmptyDestination() + public async Task ProcessAsync_EndToEndWithConceptual_CompletesSuccessfully() { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); + var context = GetService(); + context.ConceptualDocsEnabled = true; - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.txt"), "content"); + var renderer = new TestRenderer("TestRenderer", context); + var manager = new DocumentationManager(context, renderers: [renderer]); - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); + await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - Directory.Exists(destDir).Should().BeTrue("destination directory should be created"); - Directory.GetFiles(destDir).Should().BeEmpty("no files should match the pattern"); + Directory.Exists(context.DocumentationRootPath).Should().BeTrue(); } [TestMethod] - public async Task CopyFilesAsync_RecursivePatternWithSubdirectory_CopiesCorrectStructure() + public async Task ProcessAsync_MultipleAssembliesWithReferences_MergesCorrectly() { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - var imagesDir = Path.Combine(sourceDir, "images"); - var iconsDir = Path.Combine(imagesDir, "icons"); - var badgesDir = Path.Combine(imagesDir, "badges"); + var context = GetService(); - Directory.CreateDirectory(iconsDir); - Directory.CreateDirectory(badgesDir); + var renderer = new TestRenderer("TestRenderer", context); + var manager = new DocumentationManager(context, renderers: [renderer]); - await File.WriteAllTextAsync(Path.Combine(iconsDir, "icon1.png"), "icon1"); - await File.WriteAllTextAsync(Path.Combine(iconsDir, "icon2.svg"), "icon2"); - await File.WriteAllTextAsync(Path.Combine(badgesDir, "badge.png"), "badge"); + var assemblies = new[] + { + (_testAssemblyPath!, _testXmlPath!), + (_testAssemblyPath!, _testXmlPath!) + }; - await manager.CopyFilesAsync(sourceDir, destDir, "images/**/*", skipExisting: true); + await manager.ProcessAsync(assemblies); - File.Exists(Path.Combine(destDir, "images", "icons", "icon1.png")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "images", "icons", "icon2.svg")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "images", "badges", "badge.png")).Should().BeTrue(); + Directory.Exists(context.DocumentationRootPath).Should().BeTrue(); } [TestMethod] - public async Task CopyFilesAsync_InvalidRecursivePattern_HandlesGracefully() + public async Task ProcessAsync_WithDocumentationReferences_NoHandlerRegistered_CompletesGracefully() { + // Arrange var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); + var context = GetService(); + var sourceDir = Path.Combine(_tempDirectory!, "reference-source"); Directory.CreateDirectory(sourceDir); + await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.mdx"), "# Test", TestContext.CancellationToken); + + context.DocumentationReferences.Add(new DocumentationReference + { + DocumentationRoot = sourceDir, + DestinationPath = "references", + DocumentationType = SupportedDocumentationType.Mintlify + }); - await manager.CopyFilesAsync(sourceDir, destDir, "**/**/**/*", skipExisting: true); + // Act - should complete without throwing even when no handler is registered + var act = async () => await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - Directory.Exists(destDir).Should().BeTrue(); + // Assert + await act.Should().NotThrowAsync("ProcessAsync should handle references gracefully when no handler is registered"); + + // NOTE: Actual file copying behavior is tested in MintlifyDocReferenceHandlerTests.ProcessAsync_CopiesAndRewritesContent + // When no handler is registered, files are not copied - this is expected behavior } [TestMethod] - public async Task CopyFilesAsync_LargeNumberOfFiles_CopiesAll() + public async Task CreateConceptualFilesAsync_ThenProcessAsync_DoesNotDuplicate() { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(sourceDir); + var context = GetService(); + context.ConceptualDocsEnabled = true; - for (int i = 0; i < 50; i++) - { - await File.WriteAllTextAsync(Path.Combine(sourceDir, $"file{i}.md"), $"content{i}"); - } + var renderer = new TestRenderer("TestRenderer", context); + var manager = new DocumentationManager(context, renderers: [renderer]); - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); + await manager.CreateConceptualFilesAsync(_testAssemblyPath!, _testXmlPath!); + await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - Directory.GetFiles(destDir, "*.md").Should().HaveCount(50); + Directory.Exists(context.DocumentationRootPath).Should().BeTrue(); } [TestMethod] - public async Task CopyFilesAsync_MixedExtensions_CopiesOnlyMatching() + public async Task ProcessAsync_WithConceptualDisabled_SkipsConceptual() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file.md"), "md"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file.mdx"), "mdx"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file.txt"), "txt"); + var context = GetService(); + context.ConceptualDocsEnabled = false; - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); + await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - File.Exists(Path.Combine(destDir, "file.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "file.mdx")).Should().BeFalse(); - File.Exists(Path.Combine(destDir, "file.txt")).Should().BeFalse(); + manager.Should().NotBeNull("ProcessAsync should complete even with conceptual disabled"); } #endregion - #region CopyDirectoryRecursiveAsync Additional Tests + #region Edge Case Tests [TestMethod] - public async Task CopyDirectoryRecursiveAsync_SourceDirectoryMissing_ReturnsWithoutError() + public async Task MergeDocAssembliesAsync_WithIdenticalAssemblies_ProducesCorrectMerge() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "nonexistent"); - var destDir = Path.Combine(_tempDirectory!, "dest"); + var assembly1 = await GetSingleTestAssembly(); + var assembly2 = await GetSingleTestAssembly(); - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*", skipExisting: true); + var merged = await manager.MergeDocAssembliesAsync([assembly1, assembly2]); - Directory.Exists(destDir).Should().BeFalse(); + merged.Should().NotBeNull(); + merged!.Namespaces.Should().NotBeEmpty(); + merged.Namespaces.Should().HaveCount(assembly1.Namespaces.Count, "identical assemblies should not duplicate namespaces"); } + // NOTE: Tests for deleted methods removed: CopyFilesAsync_WithSymlinksInSource_HandlesCorrectly, CopyDirectoryRecursiveAsync_WithCircularReferences_DoesNotInfiniteLoop + [TestMethod] - public async Task CopyDirectoryRecursiveAsync_SkipExistingFalse_OverwritesFiles() + public async Task LoadConceptualFileAsync_WithBOMAndWhitespace_ParsesCorrectly() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(Path.Combine(sourceDir, "sub")); - Directory.CreateDirectory(Path.Combine(destDir, "sub")); + var directory = Path.Combine(_tempDirectory!, "bom-test"); + Directory.CreateDirectory(directory); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "sub", "file.md"), "New content"); - await File.WriteAllTextAsync(Path.Combine(destDir, "sub", "file.md"), "Original content"); + var content = "\uFEFF \r\n Test Content \r\n "; + await File.WriteAllTextAsync(Path.Combine(directory, "test.md"), content, new System.Text.UTF8Encoding(true), TestContext.CancellationToken); - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*", skipExisting: false); + string? result = null; + await manager.LoadConceptualFileAsync(directory, "test.md", s => result = s, showPlaceholders: false); - var content = await File.ReadAllTextAsync(Path.Combine(destDir, "sub", "file.md")); - content.Should().Be("New content"); + result.Should().NotBeNullOrWhiteSpace("content should be parsed despite BOM and whitespace"); + result.Should().Be("Test Content", "BOM and surrounding whitespace should be trimmed"); } - [TestMethod] - public async Task CopyDirectoryRecursiveAsync_EmptyDirectory_CreatesStructure() - { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); + // NOTE: Tests for deleted methods removed: GetFilePatternsForDocumentationType_WithUnknownType_ReturnsDefaultPatterns, CopyReferencedDocumentationAsync_WithOverlappingDestinations_HandlesCorrectly - Directory.CreateDirectory(Path.Combine(sourceDir, "empty1")); - Directory.CreateDirectory(Path.Combine(sourceDir, "empty2", "nested")); + #endregion - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*", skipExisting: true); + #region Error Handling Tests - Directory.Exists(Path.Combine(destDir, "empty1")).Should().BeTrue(); - Directory.Exists(Path.Combine(destDir, "empty2", "nested")).Should().BeTrue(); - } + // NOTE: Tests for deleted methods removed: CopyFilesAsync_WithReadOnlyDestinationFile_OverwritesFails, CopyDirectoryRecursiveAsync_WithLockedFile_ContinuesWithOtherFiles [TestMethod] - public async Task CopyDirectoryRecursiveAsync_PatternFilter_CopiesOnlyMatchingFiles() + public async Task ProcessAsync_WithMissingXmlFile_ContinuesWithoutXmlDocs() { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); + var context = GetService(); + var tempXmlPath = Path.Combine(_tempDirectory!, "nonexistent.xml"); - Directory.CreateDirectory(Path.Combine(sourceDir, "sub")); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), "md"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.txt"), "txt"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "sub", "nested.md"), "nested md"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "sub", "nested.txt"), "nested txt"); + var renderer = new TestRenderer("TestRenderer", context); + var manager = new DocumentationManager(context, renderers: [renderer]); - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*.md", skipExisting: true); + await manager.ProcessAsync(_testAssemblyPath!, tempXmlPath); - File.Exists(Path.Combine(destDir, "test.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "test.txt")).Should().BeFalse(); - File.Exists(Path.Combine(destDir, "sub", "nested.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "sub", "nested.txt")).Should().BeFalse(); + Directory.Exists(context.DocumentationRootPath).Should().BeTrue("ProcessAsync should complete even without XML docs"); } + // NOTE: Test for deleted method removed: CopyReferencedDocumentationAsync_WithMissingSource_SkipsGracefully + [TestMethod] - public async Task CopyDirectoryRecursiveAsync_DeepNesting_PreservesStructure() + public async Task LoadConceptualFileAsync_WithCorruptedFile_SetsEmptyContent() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); + var directory = Path.Combine(_tempDirectory!, "corrupted-test"); + Directory.CreateDirectory(directory); - var deepPath = Path.Combine(sourceDir, "level1", "level2", "level3", "level4"); - Directory.CreateDirectory(deepPath); - await File.WriteAllTextAsync(Path.Combine(deepPath, "deep.md"), "deep content"); + var filePath = Path.Combine(directory, "corrupted.md"); + await using (var stream = File.Create(filePath)) + { + stream.WriteByte(0xFF); + stream.WriteByte(0xFE); + stream.WriteByte(0x00); + } - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*", skipExisting: true); + string? result = null; + await manager.LoadConceptualFileAsync(directory, "corrupted.md", s => result = s, showPlaceholders: false); - File.Exists(Path.Combine(destDir, "level1", "level2", "level3", "level4", "deep.md")).Should().BeTrue(); + result.Should().NotBeNull("corrupted file should not crash the loader"); } [TestMethod] - public async Task CopyDirectoryRecursiveAsync_MixedContentTypes_CopiesAll() + public async Task MergeDocAssembliesAsync_WithConflictingTypes_PrefersFirst() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); + var assembly1 = await GetSingleTestAssembly(); + var assembly2 = await GetSingleTestAssembly(); - Directory.CreateDirectory(Path.Combine(sourceDir, "docs")); - Directory.CreateDirectory(Path.Combine(sourceDir, "images")); - Directory.CreateDirectory(Path.Combine(sourceDir, "scripts")); + var merged = await manager.MergeDocAssembliesAsync([assembly1, assembly2]); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "docs", "readme.md"), "readme"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "images", "logo.png"), "logo"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "scripts", "build.js"), "build"); + merged.Should().NotBeNull(); + merged!.Namespaces.Should().NotBeEmpty(); + foreach (var ns in merged.Namespaces) + { + var typeNames = ns.Types.Select(t => t.Name).ToList(); + typeNames.Should().OnlyHaveUniqueItems("conflicting types should be deduplicated"); + } + } - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*", skipExisting: true); + #endregion - File.Exists(Path.Combine(destDir, "docs", "readme.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "images", "logo.png")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "scripts", "build.js")).Should().BeTrue(); - } + #region Concurrency Tests [TestMethod] - public async Task CopyDirectoryRecursiveAsync_OnlyRootFiles_CopiesWithoutSubdirectories() + public async Task GetOrCreateAssemblyManager_ConcurrentCalls_ReturnsSameInstance() { var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file1.md"), "content1"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file2.md"), "content2"); - - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*", skipExisting: true); - - File.Exists(Path.Combine(destDir, "file1.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "file2.md")).Should().BeTrue(); - Directory.GetDirectories(destDir).Should().BeEmpty(); - } - - [TestMethod] - public async Task CopyDirectoryRecursiveAsync_SkipExistingTrue_PreservesExistingSubdirectoryFiles() - { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - - Directory.CreateDirectory(Path.Combine(sourceDir, "sub")); - Directory.CreateDirectory(Path.Combine(destDir, "sub")); - - await File.WriteAllTextAsync(Path.Combine(sourceDir, "sub", "new.md"), "new"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "sub", "existing.md"), "source version"); - await File.WriteAllTextAsync(Path.Combine(destDir, "sub", "existing.md"), "dest version"); - - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*", skipExisting: true); - - var newContent = await File.ReadAllTextAsync(Path.Combine(destDir, "sub", "new.md")); - var existingContent = await File.ReadAllTextAsync(Path.Combine(destDir, "sub", "existing.md")); - - newContent.Should().Be("new"); - existingContent.Should().Be("dest version", "existing file should not be overwritten"); - } - - #endregion - - #region CopyReferencedDocumentationAsync Additional Tests - - [TestMethod] - public async Task CopyReferencedDocumentationAsync_NoReferences_CompletesWithoutError() - { - var manager = GetDocumentationManager(); - var context = GetService(); - context.DocumentationReferences.Clear(); - - await manager.CopyReferencedDocumentationAsync(); - - context.DocumentationReferences.Should().BeEmpty(); - } - - [TestMethod] - public async Task CopyReferencedDocumentationAsync_MultipleReferences_CopiesAll() - { - var manager = GetDocumentationManager(); - var context = GetService(); - context.DocumentationReferences.Clear(); - - var source1 = Path.Combine(_tempDirectory!, "ref1"); - var source2 = Path.Combine(_tempDirectory!, "ref2"); - Directory.CreateDirectory(source1); - Directory.CreateDirectory(source2); - - await File.WriteAllTextAsync(Path.Combine(source1, "test1.md"), "ref1"); - await File.WriteAllTextAsync(Path.Combine(source2, "test2.md"), "ref2"); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = source1, - DestinationPath = "dest1", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = source2, - DestinationPath = "dest2", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - await manager.CopyReferencedDocumentationAsync(); - - File.Exists(Path.Combine(context.DocumentationRootPath, "dest1", "test1.md")).Should().BeTrue(); - File.Exists(Path.Combine(context.DocumentationRootPath, "dest2", "test2.md")).Should().BeTrue(); - } - - [TestMethod] - public async Task CopyReferencedDocumentationAsync_DifferentDocumentationTypes_UsesCorrectPatterns() - { - var manager = GetDocumentationManager(); - var context = GetService(); - context.DocumentationReferences.Clear(); - - var mintlifySource = Path.Combine(_tempDirectory!, "mintlify"); - var docfxSource = Path.Combine(_tempDirectory!, "docfx"); - - Directory.CreateDirectory(mintlifySource); - Directory.CreateDirectory(docfxSource); - - await File.WriteAllTextAsync(Path.Combine(mintlifySource, "test.mdx"), "mintlify"); - await File.WriteAllTextAsync(Path.Combine(docfxSource, "test.yml"), "docfx"); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = mintlifySource, - DestinationPath = "mintlify", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = docfxSource, - DestinationPath = "docfx", - DocumentationType = SupportedDocumentationType.DocFX - }); - - await manager.CopyReferencedDocumentationAsync(); - - context.DocumentationReferences.Should().HaveCount(2); - } - - [TestMethod] - public async Task CopyReferencedDocumentationAsync_MissingSourceDirectory_ContinuesProcessing() - { - var manager = GetDocumentationManager(); - var context = GetService(); - context.DocumentationReferences.Clear(); - - var validSource = Path.Combine(_tempDirectory!, "valid"); - Directory.CreateDirectory(validSource); - await File.WriteAllTextAsync(Path.Combine(validSource, "test.md"), "content"); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = Path.Combine(_tempDirectory!, "nonexistent"), - DestinationPath = "missing", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = validSource, - DestinationPath = "valid", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - await manager.CopyReferencedDocumentationAsync(); - - File.Exists(Path.Combine(context.DocumentationRootPath, "valid", "test.md")).Should().BeTrue(); - } - - #endregion - - #region GetFilePatternsForDocumentationType Additional Tests - - [TestMethod] - public void GetFilePatternsForDocumentationType_CaseSensitive_ReturnsCorrectPatterns() - { - var manager = GetDocumentationManager(); - - var lowerCase = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.Mintlify); - var mixedCase = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.Mintlify); - - lowerCase.Should().NotBeNull(); - mixedCase.Should().NotBeNull(); - } - - [TestMethod] - public void GetFilePatternsForDocumentationType_Generic_ReturnsDefaultPatterns() - { - var manager = GetDocumentationManager(); - - var result = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.Generic); - - result.Should().NotBeNull(); - } - - [TestMethod] - public void GetFilePatternsForDocumentationType_AllKnownTypes_ReturnDistinctPatterns() - { - var manager = GetDocumentationManager(); - - var mintlify = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.Mintlify); - var docfx = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.DocFX); - var mkdocs = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.MkDocs); - - mintlify.Should().Contain("*.mdx"); - docfx.Should().Contain("*.yml"); - mkdocs.Should().Contain("mkdocs.yml"); - - mintlify.Should().NotEqual(docfx); - docfx.Should().NotEqual(mkdocs); - } - - #endregion - - #region Dispose Tests - - [TestMethod] - public void Dispose_WithCachedAssemblyManagers_DisposesAll() - { - var manager = GetDocumentationManager(); - - manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - var tempAssemblyPath = Path.Combine(_tempDirectory!, "temp.dll"); - File.Copy(_testAssemblyPath!, tempAssemblyPath, overwrite: true); - manager.GetOrCreateAssemblyManager(tempAssemblyPath, _testXmlPath!); - - manager.Dispose(); - - manager.Should().NotBeNull("Dispose should complete without error"); - } - - [TestMethod] - public void Dispose_CalledMultipleTimes_DoesNotThrow() - { - var manager = GetDocumentationManager(); - manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - - manager.Dispose(); - - var act = () => manager.Dispose(); - act.Should().NotThrow("Dispose should be idempotent"); - } - - [TestMethod] - public void Dispose_WithEmptyCache_CompletesSuccessfully() - { - var manager = GetDocumentationManager(); - - var act = () => manager.Dispose(); - - act.Should().NotThrow("Dispose should handle empty cache gracefully"); - } - - [TestMethod] - public void Dispose_ClearsAssemblyManagerCache() - { - var manager = GetDocumentationManager(); - manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - - manager.Dispose(); - - var secondManager = manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - secondManager.Should().NotBeNull("GetOrCreateAssemblyManager should work after Dispose"); - } - - [TestMethod] - public void Dispose_WithNullManagerInCache_HandlesGracefully() - { - var manager = GetDocumentationManager(); - manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - - var act = () => manager.Dispose(); - - act.Should().NotThrow("Dispose should handle null values in cache gracefully"); - } - - #endregion - - #region Integration Tests - - [TestMethod] - public async Task ProcessAsync_EndToEndWithConceptual_CompletesSuccessfully() - { - var context = GetService(); - context.ConceptualDocsEnabled = true; - - var renderer = new TestRenderer("TestRenderer", context); - var manager = new DocumentationManager(context, renderers: [renderer]); - - await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - - Directory.Exists(context.DocumentationRootPath).Should().BeTrue(); - } - - [TestMethod] - public async Task ProcessAsync_MultipleAssembliesWithReferences_MergesCorrectly() - { - var context = GetService(); - - var renderer = new TestRenderer("TestRenderer", context); - var manager = new DocumentationManager(context, renderers: [renderer]); - - var assemblies = new[] - { - (_testAssemblyPath!, _testXmlPath!), - (_testAssemblyPath!, _testXmlPath!) - }; - - await manager.ProcessAsync(assemblies); - - Directory.Exists(context.DocumentationRootPath).Should().BeTrue(); - } - - [TestMethod] - public async Task ProcessAsync_WithDocumentationReferences_CopiesFiles() - { - var manager = GetDocumentationManager(); - var context = GetService(); - - var sourceDir = Path.Combine(_tempDirectory!, "reference-source"); - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.mdx"), "# Test"); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = sourceDir, - DestinationPath = "references", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - - var destFile = Path.Combine(context.DocumentationRootPath, "references", "test.mdx"); - File.Exists(destFile).Should().BeTrue("referenced documentation should be copied"); - } - - [TestMethod] - public async Task CreateConceptualFilesAsync_ThenProcessAsync_DoesNotDuplicate() - { - var context = GetService(); - context.ConceptualDocsEnabled = true; - - var renderer = new TestRenderer("TestRenderer", context); - var manager = new DocumentationManager(context, renderers: [renderer]); - - await manager.CreateConceptualFilesAsync(_testAssemblyPath!, _testXmlPath!); - await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - - Directory.Exists(context.DocumentationRootPath).Should().BeTrue(); - } - - [TestMethod] - public async Task ProcessAsync_WithConceptualDisabled_SkipsConceptual() - { - var manager = GetDocumentationManager(); - var context = GetService(); - context.ConceptualDocsEnabled = false; - - await manager.ProcessAsync(_testAssemblyPath!, _testXmlPath!); - - manager.Should().NotBeNull("ProcessAsync should complete even with conceptual disabled"); - } - - #endregion - - #region Edge Case Tests - - [TestMethod] - public async Task MergeDocAssembliesAsync_WithIdenticalAssemblies_ProducesCorrectMerge() - { - var manager = GetDocumentationManager(); - var assembly1 = await GetSingleTestAssembly(); - var assembly2 = await GetSingleTestAssembly(); - - var merged = await manager.MergeDocAssembliesAsync(new List { assembly1, assembly2 }); - - merged.Should().NotBeNull(); - merged.Namespaces.Should().NotBeEmpty(); - merged.Namespaces.Count.Should().Be(assembly1.Namespaces.Count, "identical assemblies should not duplicate namespaces"); - } - - [TestMethod] - public async Task CopyFilesAsync_WithSymlinksInSource_HandlesCorrectly() - { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "symlink-source"); - var destDir = Path.Combine(_tempDirectory!, "symlink-dest"); - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), "content"); - - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); - - File.Exists(Path.Combine(destDir, "test.md")).Should().BeTrue(); - } - - [TestMethod] - public async Task CopyDirectoryRecursiveAsync_WithCircularReferences_DoesNotInfiniteLoop() - { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "circular-source"); - var destDir = Path.Combine(_tempDirectory!, "circular-dest"); - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), "content"); - - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*.md", skipExisting: true); - - File.Exists(Path.Combine(destDir, "test.md")).Should().BeTrue(); - } - - [TestMethod] - public async Task LoadConceptualFileAsync_WithBOMAndWhitespace_ParsesCorrectly() - { - var manager = GetDocumentationManager(); - var directory = Path.Combine(_tempDirectory!, "bom-test"); - Directory.CreateDirectory(directory); - - var content = "\uFEFF \r\n Test Content \r\n "; - await File.WriteAllTextAsync(Path.Combine(directory, "test.md"), content, new System.Text.UTF8Encoding(true)); - - string? result = null; - await manager.LoadConceptualFileAsync(directory, "test.md", s => result = s, showPlaceholders: false); - - result.Should().NotBeNullOrWhiteSpace("content should be parsed despite BOM and whitespace"); - result.Should().Be("Test Content", "BOM and surrounding whitespace should be trimmed"); - } - - [TestMethod] - public void GetFilePatternsForDocumentationType_WithUnknownType_ReturnsDefaultPatterns() - { - var manager = GetDocumentationManager(); - - var patterns = manager.GetFilePatternsForDocumentationType(SupportedDocumentationType.Generic); - - patterns.Should().NotBeEmpty(); - patterns.Should().Contain("*.md", "default patterns should include markdown"); - patterns.Should().Contain("*.html", "default patterns should include html"); - } - - [TestMethod] - public async Task CopyReferencedDocumentationAsync_WithOverlappingDestinations_HandlesCorrectly() - { - var manager = GetDocumentationManager(); - var context = GetService(); - - var source1 = Path.Combine(_tempDirectory!, "ref1"); - var source2 = Path.Combine(_tempDirectory!, "ref2"); - Directory.CreateDirectory(source1); - Directory.CreateDirectory(source2); - await File.WriteAllTextAsync(Path.Combine(source1, "file1.md"), "content1"); - await File.WriteAllTextAsync(Path.Combine(source2, "file2.md"), "content2"); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = source1, - DestinationPath = "shared", - DocumentationType = SupportedDocumentationType.Mintlify - }); - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = source2, - DestinationPath = "shared", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - await manager.CopyReferencedDocumentationAsync(); - - File.Exists(Path.Combine(context.DocumentationRootPath, "shared", "file1.md")).Should().BeTrue(); - File.Exists(Path.Combine(context.DocumentationRootPath, "shared", "file2.md")).Should().BeTrue(); - } - - #endregion - - #region Error Handling Tests - - [TestMethod] - public async Task CopyFilesAsync_WithReadOnlyDestinationFile_OverwritesFails() - { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "readonly-source"); - var destDir = Path.Combine(_tempDirectory!, "readonly-dest"); - Directory.CreateDirectory(sourceDir); - Directory.CreateDirectory(destDir); - - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), "new content"); - var destFile = Path.Combine(destDir, "test.md"); - await File.WriteAllTextAsync(destFile, "old content"); - File.SetAttributes(destFile, FileAttributes.ReadOnly); - - var act = async () => await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: false); - - await act.Should().ThrowAsync("cannot overwrite read-only file"); - - File.SetAttributes(destFile, FileAttributes.Normal); - } - - [TestMethod] - public async Task CopyDirectoryRecursiveAsync_WithLockedFile_ContinuesWithOtherFiles() - { - var manager = GetDocumentationManager(); - var sourceDir = Path.Combine(_tempDirectory!, "locked-source"); - var destDir = Path.Combine(_tempDirectory!, "locked-dest"); - Directory.CreateDirectory(sourceDir); - - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file1.md"), "content1"); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "file2.md"), "content2"); - - await manager.CopyDirectoryRecursiveAsync(sourceDir, destDir, "*.md", skipExisting: true); - - File.Exists(Path.Combine(destDir, "file1.md")).Should().BeTrue(); - File.Exists(Path.Combine(destDir, "file2.md")).Should().BeTrue(); - } - - [TestMethod] - public async Task ProcessAsync_WithMissingXmlFile_ContinuesWithoutXmlDocs() - { - var context = GetService(); - var tempXmlPath = Path.Combine(_tempDirectory!, "nonexistent.xml"); - - var renderer = new TestRenderer("TestRenderer", context); - var manager = new DocumentationManager(context, renderers: [renderer]); - - await manager.ProcessAsync(_testAssemblyPath!, tempXmlPath); - - Directory.Exists(context.DocumentationRootPath).Should().BeTrue("ProcessAsync should complete even without XML docs"); - } - - [TestMethod] - public async Task CopyReferencedDocumentationAsync_WithMissingSource_SkipsGracefully() - { - var manager = GetDocumentationManager(); - var context = GetService(); - - context.DocumentationReferences.Add(new DocumentationReference - { - DocumentationRoot = Path.Combine(_tempDirectory!, "does-not-exist"), - DestinationPath = "missing", - DocumentationType = SupportedDocumentationType.Mintlify - }); - - var act = async () => await manager.CopyReferencedDocumentationAsync(); - - await act.Should().NotThrowAsync("missing source should be handled gracefully"); - } - - [TestMethod] - public async Task LoadConceptualFileAsync_WithCorruptedFile_SetsEmptyContent() - { - var manager = GetDocumentationManager(); - var directory = Path.Combine(_tempDirectory!, "corrupted-test"); - Directory.CreateDirectory(directory); - - var filePath = Path.Combine(directory, "corrupted.md"); - await using (var stream = File.Create(filePath)) - { - stream.WriteByte(0xFF); - stream.WriteByte(0xFE); - stream.WriteByte(0x00); - } - - string? result = null; - await manager.LoadConceptualFileAsync(directory, "corrupted.md", s => result = s, showPlaceholders: false); - - result.Should().NotBeNull("corrupted file should not crash the loader"); - } - - [TestMethod] - public async Task MergeDocAssembliesAsync_WithConflictingTypes_PrefersFirst() - { - var manager = GetDocumentationManager(); - var assembly1 = await GetSingleTestAssembly(); - var assembly2 = await GetSingleTestAssembly(); - - var merged = await manager.MergeDocAssembliesAsync(new List { assembly1, assembly2 }); - - merged.Namespaces.Should().NotBeEmpty(); - foreach (var ns in merged.Namespaces) - { - var typeNames = ns.Types.Select(t => t.Name).ToList(); - typeNames.Should().OnlyHaveUniqueItems("conflicting types should be deduplicated"); - } - } - - #endregion - - #region Concurrency Tests - - [TestMethod] - public async Task GetOrCreateAssemblyManager_ConcurrentCalls_ReturnsSameInstance() - { - var manager = GetDocumentationManager(); - - var tasks = Enumerable.Range(0, 10).Select(_ => Task.Run(() => - { - return manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); - })); + var tasks = Enumerable.Range(0, 10).Select(_ => Task.Run(() => + { + return manager.GetOrCreateAssemblyManager(_testAssemblyPath!, _testXmlPath!); + })); var results = await Task.WhenAll(tasks); @@ -2402,29 +1646,7 @@ public async Task ProcessAsync_ConcurrentCallsMultipleAssemblies_CompletesSucces await act.Should().NotThrowAsync("concurrent ProcessAsync calls should complete successfully"); } - [TestMethod] - public async Task CopyFilesAsync_ConcurrentCalls_AllComplete() - { - var manager = GetDocumentationManager(); - - var tasks = Enumerable.Range(0, 10).Select(async i => - { - var sourceDir = Path.Combine(_tempDirectory!, $"concurrent-source-{i}"); - var destDir = Path.Combine(_tempDirectory!, $"concurrent-dest-{i}"); - Directory.CreateDirectory(sourceDir); - await File.WriteAllTextAsync(Path.Combine(sourceDir, "test.md"), $"content-{i}"); - - await manager.CopyFilesAsync(sourceDir, destDir, "*.md", skipExisting: true); - }); - - await Task.WhenAll(tasks); - - for (int i = 0; i < 10; i++) - { - var destFile = Path.Combine(_tempDirectory!, $"concurrent-dest-{i}", "test.md"); - File.Exists(destFile).Should().BeTrue($"file {i} should be copied"); - } - } + // NOTE: Test for deleted method removed: CopyFilesAsync_ConcurrentCalls_AllComplete [TestMethod] public async Task CreateConceptualFilesAsync_ConcurrentCallsSameAssembly_HandlesCorrectly() @@ -2451,13 +1673,13 @@ public async Task MergeDocAssembliesAsync_ConcurrentMerges_ProduceConsistentResu { var assembly1 = await GetSingleTestAssembly(); var assembly2 = await GetSingleTestAssembly(); - return await manager.MergeDocAssembliesAsync(new List { assembly1, assembly2 }); + return await manager.MergeDocAssembliesAsync([assembly1, assembly2]); }); var results = await Task.WhenAll(tasks); results.Should().AllSatisfy(r => r.Should().NotBeNull()); - results.Should().AllSatisfy(r => r.Namespaces.Should().NotBeEmpty()); + results.Should().AllSatisfy(r => r!.Namespaces.Should().NotBeEmpty()); } [TestMethod] @@ -2816,234 +2038,12 @@ public async Task ProcessAsync_WithParameterPlaceholders_HandlesCorrectly() parameter!.Usage.Should().Be("The first number."); } - [TestMethod] - public void GetExclusionPatternsForDocumentationType_Mintlify_ReturnsCorrectPatterns() - { - // Arrange - var manager = GetDocumentationManager(); - - // Act - var patterns = manager.GetExclusionPatternsForDocumentationType(SupportedDocumentationType.Mintlify); - - // Assert - patterns.Should().NotBeNull(); - patterns.Should().Contain("**/*.mdz"); - patterns.Should().Contain("conceptual/**/*"); - patterns.Should().Contain("**/*.css"); - patterns.Should().Contain("docs.json"); - patterns.Should().Contain("assembly-list.txt"); - patterns.Should().Contain("*.docsproj"); - } - - [TestMethod] - public void GetExclusionPatternsForDocumentationType_UnknownType_ReturnsEmptyList() - { - // Arrange - var manager = GetDocumentationManager(); - - // Act - var patterns = manager.GetExclusionPatternsForDocumentationType(SupportedDocumentationType.Generic); - - // Assert - patterns.Should().NotBeNull(); - patterns.Should().BeEmpty(); - } - - [TestMethod] - public void ShouldExcludeFile_WithMdzPattern_ExcludesMdzFiles() - { - // Arrange - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "**/*.mdz" }; - - // Act & Assert - manager.ShouldExcludeFile("file.mdz", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("api-reference/test.mdz", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("deeply/nested/path/file.mdz", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("file.md", exclusionPatterns).Should().BeFalse(); - manager.ShouldExcludeFile("file.mdx", exclusionPatterns).Should().BeFalse(); - } - - [TestMethod] - public void ShouldExcludeFile_WithConceptualPattern_ExcludesConceptualFolder() - { - // Arrange - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "conceptual/**/*" }; - - // Act & Assert - manager.ShouldExcludeFile("conceptual/guide.md", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("conceptual/nested/file.mdx", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("api-reference/file.md", exclusionPatterns).Should().BeFalse(); - manager.ShouldExcludeFile("guide.md", exclusionPatterns).Should().BeFalse(); - } - - [TestMethod] - public void ShouldExcludeFile_WithCssPattern_ExcludesCssFiles() - { - // Arrange - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "**/*.css" }; - - // Act & Assert - manager.ShouldExcludeFile("style.css", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("assets/main.css", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("deeply/nested/theme.css", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("style.scss", exclusionPatterns).Should().BeFalse(); - manager.ShouldExcludeFile("file.css.map", exclusionPatterns).Should().BeFalse(); - } - - [TestMethod] - public void ShouldExcludeFile_WithDocsJsonPattern_ExcludesDocsJson() - { - // Arrange - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "docs.json" }; - - // Act & Assert - manager.ShouldExcludeFile("docs.json", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("nested/docs.json", exclusionPatterns).Should().BeFalse(); // Exact match only - manager.ShouldExcludeFile("docs-template.json", exclusionPatterns).Should().BeFalse(); - } - - [TestMethod] - public void ShouldExcludeFile_WithAssemblyListPattern_ExcludesAssemblyList() - { - // Arrange - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "assembly-list.txt" }; - - // Act & Assert - manager.ShouldExcludeFile("assembly-list.txt", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("nested/assembly-list.txt", exclusionPatterns).Should().BeFalse(); // Exact match only - manager.ShouldExcludeFile("assembly-list-backup.txt", exclusionPatterns).Should().BeFalse(); - } - - [TestMethod] - public void ShouldExcludeFile_WithDocsprojPattern_ExcludesDocsprojFiles() - { - // Arrange - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "*.docsproj" }; - - // Act & Assert - manager.ShouldExcludeFile("MyProject.docsproj", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("Documentation.docsproj", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("nested/Project.docsproj", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeFile("MyProject.csproj", exclusionPatterns).Should().BeFalse(); - } - - [TestMethod] - public void ShouldExcludeDirectory_WithConceptualPattern_ExcludesConceptualDirectory() - { - // Arrange - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "conceptual/**/*" }; - - // Act & Assert - manager.ShouldExcludeDirectory("conceptual", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeDirectory("conceptual/guides", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeDirectory("conceptual/guides/nested", exclusionPatterns).Should().BeTrue(); - manager.ShouldExcludeDirectory("api-reference", exclusionPatterns).Should().BeFalse(); - manager.ShouldExcludeDirectory("guides", exclusionPatterns).Should().BeFalse(); - } - - [TestMethod] - public void ShouldExcludeFile_NonMatchingFile_DoesNotExclude() - { - // Arrange - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "**/*.mdz", "conceptual/**/*", "**/*.css", "docs.json", "assembly-list.txt", "*.docsproj" }; - - // Act & Assert - These should NOT be excluded - manager.ShouldExcludeFile("index.mdx", exclusionPatterns).Should().BeFalse(); - manager.ShouldExcludeFile("api-reference/class.md", exclusionPatterns).Should().BeFalse(); - manager.ShouldExcludeFile("snippets/example.jsx", exclusionPatterns).Should().BeFalse(); - manager.ShouldExcludeFile("images/logo.png", exclusionPatterns).Should().BeFalse(); - } - - [TestMethod] - public async Task CopyDirectoryWithExclusionsAsync_SkipsExcludedFiles() - { - // Arrange - var sourceDir = Path.Combine(_tempDirectory!, "source"); - var destDir = Path.Combine(_tempDirectory!, "dest"); - Directory.CreateDirectory(sourceDir); - - // Create test files - File.WriteAllText(Path.Combine(sourceDir, "index.mdx"), "content"); - File.WriteAllText(Path.Combine(sourceDir, "test.mdz"), "content"); - File.WriteAllText(Path.Combine(sourceDir, "style.css"), "content"); - File.WriteAllText(Path.Combine(sourceDir, "docs.json"), "content"); - - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "**/*.mdz", "**/*.css", "docs.json" }; - - // Act - await manager.CopyDirectoryWithExclusionsAsync(sourceDir, destDir, exclusionPatterns); - - // Assert - File.Exists(Path.Combine(destDir, "index.mdx")).Should().BeTrue("index.mdx should be copied"); - File.Exists(Path.Combine(destDir, "test.mdz")).Should().BeFalse("test.mdz should be excluded"); - File.Exists(Path.Combine(destDir, "style.css")).Should().BeFalse("style.css should be excluded"); - File.Exists(Path.Combine(destDir, "docs.json")).Should().BeFalse("docs.json should be excluded"); - } - - [TestMethod] - public async Task CopyDirectoryWithExclusionsAsync_CopiesNestedDirectories() - { - // Arrange - var sourceDir = Path.Combine(_tempDirectory!, "source2"); - var destDir = Path.Combine(_tempDirectory!, "dest2"); - Directory.CreateDirectory(sourceDir); - Directory.CreateDirectory(Path.Combine(sourceDir, "api-reference")); - Directory.CreateDirectory(Path.Combine(sourceDir, "conceptual")); - - // Create test files - File.WriteAllText(Path.Combine(sourceDir, "index.mdx"), "content"); - File.WriteAllText(Path.Combine(sourceDir, "api-reference", "class.md"), "content"); - File.WriteAllText(Path.Combine(sourceDir, "conceptual", "guide.md"), "content"); - - var manager = GetDocumentationManager(); - var exclusionPatterns = new List { "conceptual/**/*" }; - - // Act - await manager.CopyDirectoryWithExclusionsAsync(sourceDir, destDir, exclusionPatterns); - - // Assert - File.Exists(Path.Combine(destDir, "index.mdx")).Should().BeTrue("index.mdx should be copied"); - File.Exists(Path.Combine(destDir, "api-reference", "class.md")).Should().BeTrue("api-reference/class.md should be copied"); - Directory.Exists(Path.Combine(destDir, "conceptual")).Should().BeFalse("conceptual directory should not be copied"); - File.Exists(Path.Combine(destDir, "conceptual", "guide.md")).Should().BeFalse("conceptual/guide.md should be excluded"); - } - - [TestMethod] - public void MatchesGlobPattern_WithVariousPatterns_MatchesCorrectly() - { - // Arrange - var manager = GetDocumentationManager(); - - // Act & Assert - // Test **/*.ext pattern - manager.MatchesGlobPattern("file.mdz", "**/*.mdz").Should().BeTrue(); - manager.MatchesGlobPattern("path/file.mdz", "**/*.mdz").Should().BeTrue(); - manager.MatchesGlobPattern("deep/nested/file.mdz", "**/*.mdz").Should().BeTrue(); - manager.MatchesGlobPattern("file.md", "**/*.mdz").Should().BeFalse(); - - // Test directory/**/* pattern - manager.MatchesGlobPattern("conceptual/file.md", "conceptual/**/*").Should().BeTrue(); - manager.MatchesGlobPattern("conceptual/nested/file.md", "conceptual/**/*").Should().BeTrue(); - manager.MatchesGlobPattern("api-reference/file.md", "conceptual/**/*").Should().BeFalse(); - - // Test exact match - manager.MatchesGlobPattern("docs.json", "docs.json").Should().BeTrue(); - manager.MatchesGlobPattern("nested/docs.json", "docs.json").Should().BeFalse(); - - // Test *.ext pattern - manager.MatchesGlobPattern("file.css", "*.css").Should().BeTrue(); - manager.MatchesGlobPattern("path/file.css", "*.css").Should().BeTrue(); - manager.MatchesGlobPattern("file.scss", "*.css").Should().BeFalse(); - } + // NOTE: The following tests were moved to DocReferenceHandlerBaseTests: + // - GetExclusionPatternsForDocumentationType_* tests + // - ShouldExcludeFile_* tests + // - ShouldExcludeDirectory_* tests + // - CopyDirectoryWithExclusionsAsync_* tests + // - MatchesGlobPattern_* tests #endregion @@ -3262,7 +2262,7 @@ public TestRenderer(string name, ProjectContext projectContext) this.projectContext = projectContext; } - public Task RenderAsync(DocAssembly model) + public Task RenderAsync(DocAssembly? model) { Executed = true; diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Extensions/DotNetDocsCore_IServiceCollectionExtensionsTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/Extensions/DotNetDocsCore_IServiceCollectionExtensionsTests.cs index aed8526..5551a0c 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Extensions/DotNetDocsCore_IServiceCollectionExtensionsTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Extensions/DotNetDocsCore_IServiceCollectionExtensionsTests.cs @@ -68,6 +68,19 @@ public void AddDotNetDocs_RegistersAllBuiltInRenderers() renderers.Should().Contain(r => r is YamlRenderer); } + [TestMethod] + public void AddDotNetDocs_RegistersMarkdownDocReferenceHandler() + { + // Arrange & Act + TestHostBuilder.ConfigureServices(services => services.AddDotNetDocs()); + TestSetup(); + + // Assert + var handlers = TestHost.Services.GetServices().ToList(); + handlers.Should().ContainSingle(); + handlers.Should().Contain(h => h is MarkdownDocReferenceHandler); + } + [TestMethod] public void AddDotNetDocs_ConfiguresProjectContext() { @@ -172,7 +185,7 @@ public void AddDotNetDocsCore_ConfiguresProjectContext() public void AddMarkdownRenderer_RegistersOnlyMarkdownRenderer() { // Arrange & Act - TestHostBuilder.ConfigureServices(services => + TestHostBuilder.ConfigureServices(services => { services.AddDotNetDocsCore(); services.AddMarkdownRenderer(); @@ -181,10 +194,27 @@ public void AddMarkdownRenderer_RegistersOnlyMarkdownRenderer() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); + renderers.Should().ContainSingle(); renderers.Should().AllBeOfType(); } + [TestMethod] + public void AddMarkdownRenderer_RegistersMarkdownDocReferenceHandler() + { + // Arrange & Act + TestHostBuilder.ConfigureServices(services => + { + services.AddDotNetDocsCore(); + services.AddMarkdownRenderer(); + }); + TestSetup(); + + // Assert + var handlers = TestHost.Services.GetServices().ToList(); + handlers.Should().ContainSingle(); + handlers.Should().AllBeOfType(); + } + [TestMethod] public void AddJsonRenderer_RegistersOnlyJsonRenderer() { @@ -198,7 +228,7 @@ public void AddJsonRenderer_RegistersOnlyJsonRenderer() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); + renderers.Should().ContainSingle(); renderers.Should().AllBeOfType(); } @@ -240,7 +270,7 @@ public void AddYamlRenderer_RegistersOnlyYamlRenderer() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); + renderers.Should().ContainSingle(); renderers.Should().AllBeOfType(); } @@ -261,7 +291,7 @@ public void AddDocRenderer_RegistersCustomRenderer() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); + renderers.Should().ContainSingle(); renderers.Should().AllBeOfType(); } @@ -278,7 +308,7 @@ public void AddDocEnricher_RegistersCustomEnricher() // Assert var enrichers = TestHost.Services.GetServices().ToList(); - enrichers.Should().HaveCount(1); + enrichers.Should().ContainSingle(); enrichers.Should().AllBeOfType(); } @@ -295,7 +325,7 @@ public void AddDocTransformer_RegistersCustomTransformer() // Assert var transformers = TestHost.Services.GetServices().ToList(); - transformers.Should().HaveCount(1); + transformers.Should().ContainSingle(); transformers.Should().AllBeOfType(); } @@ -319,9 +349,9 @@ public void MultipleAddDotNetDocs_DoesNotDuplicateServices() renderers.Should().HaveCount(3, "each renderer type should only be registered once"); // Verify each specific renderer type appears exactly once - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); } [TestMethod] @@ -338,7 +368,7 @@ public void AddRenderer_AfterAddDotNetDocs_DoesNotDuplicate() // Assert var renderers = TestHost.Services.GetServices().ToList(); var markdownRenderers = renderers.OfType().ToList(); - markdownRenderers.Should().HaveCount(1, "MarkdownRenderer should only be registered once"); + markdownRenderers.Should().ContainSingle("MarkdownRenderer should only be registered once"); } [TestMethod] @@ -356,8 +386,8 @@ public void MultipleAddMarkdownRenderer_DoesNotDuplicate() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); + renderers.Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); } [TestMethod] @@ -374,8 +404,8 @@ public void MultipleAddJsonRenderer_DoesNotDuplicate() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); + renderers.Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); } [TestMethod] @@ -392,8 +422,8 @@ public void MultipleAddYamlRenderer_DoesNotDuplicate() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); + renderers.Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); } [TestMethod] @@ -413,9 +443,9 @@ public void MixedRendererRegistrations_NoDuplicates() // Assert var renderers = TestHost.Services.GetServices().ToList(); renderers.Should().HaveCount(3, "should have exactly 3 renderers total"); - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); } [TestMethod] @@ -433,7 +463,7 @@ public void MultipleAddDocRenderer_SameType_DoesNotDuplicate() // Assert var renderers = TestHost.Services.GetServices().ToList(); - renderers.Should().HaveCount(1, "custom renderer should only be registered once"); + renderers.Should().ContainSingle("custom renderer should only be registered once"); renderers.Should().AllBeOfType(); } @@ -451,7 +481,7 @@ public void MultipleAddDocEnricher_SameType_DoesNotDuplicate() // Assert var enrichers = TestHost.Services.GetServices().ToList(); - enrichers.Should().HaveCount(1, "enricher should only be registered once"); + enrichers.Should().ContainSingle("enricher should only be registered once"); enrichers.Should().AllBeOfType(); } @@ -469,7 +499,7 @@ public void MultipleAddDocTransformer_SameType_DoesNotDuplicate() // Assert var transformers = TestHost.Services.GetServices().ToList(); - transformers.Should().HaveCount(1, "transformer should only be registered once"); + transformers.Should().ContainSingle("transformer should only be registered once"); transformers.Should().AllBeOfType(); } @@ -540,13 +570,13 @@ public void ComplexRegistrationScenario_NoDuplicates() // Assert var renderers = TestHost.Services.GetServices().ToList(); renderers.Should().HaveCount(4, "should have 3 built-in + 1 custom renderer"); - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); - renderers.OfType().Should().HaveCount(1); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); + renderers.OfType().Should().ContainSingle(); var enrichers = TestHost.Services.GetServices().ToList(); - enrichers.Should().HaveCount(1); + enrichers.Should().ContainSingle(); enrichers.Should().AllBeOfType(); var transformers = TestHost.Services.GetServices().ToList(); @@ -598,7 +628,7 @@ public void DocumentationManager_WorksWithNoRenderers() private class TestRenderer : IDocRenderer { public string OutputFormat => "Test"; - public Task RenderAsync(DocAssembly model) => Task.CompletedTask; + public Task RenderAsync(DocAssembly? model) => Task.CompletedTask; public Task RenderPlaceholdersAsync(DocAssembly model) => Task.CompletedTask; } diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/InheritDocTest.cs b/src/CloudNimble.DotNetDocs.Tests.Core/InheritDocTest.cs index 7402e32..c217054 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/InheritDocTest.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/InheritDocTest.cs @@ -52,7 +52,7 @@ public void MethodB(string value) { } var compilation = CSharpCompilation.Create("TestAssembly") .AddReferences(MetadataReference.CreateFromFile(typeof(object).Assembly.Location)) - .AddSyntaxTrees(CSharpSyntaxTree.ParseText(source)); + .AddSyntaxTrees(CSharpSyntaxTree.ParseText(source, cancellationToken: TestContext.CancellationToken)); var manager = new AssemblyManager("", ""); @@ -118,7 +118,7 @@ public void TestMethod() { } var compilation = CSharpCompilation.Create("TestAssembly") .AddReferences(MetadataReference.CreateFromFile(typeof(object).Assembly.Location)) - .AddSyntaxTrees(CSharpSyntaxTree.ParseText(source)); + .AddSyntaxTrees(CSharpSyntaxTree.ParseText(source, cancellationToken: TestContext.CancellationToken)); var manager = new AssemblyManager("", ""); diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/MarkdownDocReferenceHandlerTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/MarkdownDocReferenceHandlerTests.cs new file mode 100644 index 0000000..cb9ddef --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Tests.Core/MarkdownDocReferenceHandlerTests.cs @@ -0,0 +1,544 @@ +using CloudNimble.DotNetDocs.Core; +using CloudNimble.DotNetDocs.Core.Configuration; +using CloudNimble.DotNetDocs.Tests.Shared; +using FluentAssertions; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using System.IO; +using System.Threading.Tasks; + +namespace CloudNimble.DotNetDocs.Tests.Core +{ + + /// + /// Tests for , covering the base Markdown + /// content rewriting functionality. + /// + [TestClass] + public class MarkdownDocReferenceHandlerTests : DotNetDocsTestBase + { + + #region DocumentationType Tests + + [TestMethod] + public void DocumentationType_ReturnsGeneric() + { + var handler = new TestMarkdownHandler(); + + handler.DocumentationType.Should().Be(SupportedDocumentationType.Generic); + } + + #endregion + + #region RewriteMarkdownContent Tests - Image Rewriting + + [TestMethod] + public void RewriteMarkdownContent_MarkdownImage_RewritesPath() + { + var handler = new TestMarkdownHandler(); + + var content = "![Logo](/images/logo.png)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be("![Logo](/images/my-project/logo.png)"); + } + + [TestMethod] + public void RewriteMarkdownContent_MarkdownImageWithAltText_PreservesAltText() + { + var handler = new TestMarkdownHandler(); + + var content = "![Company Logo](/images/company/logo.png)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be("![Company Logo](/images/my-project/company/logo.png)"); + } + + [TestMethod] + public void RewriteMarkdownContent_MarkdownImageWithTitle_PreservesTitle() + { + var handler = new TestMarkdownHandler(); + + var content = "![Logo](/images/logo.png \"Company Logo\")"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be("![Logo](/images/my-project/logo.png \"Company Logo\")"); + } + + [TestMethod] + public void RewriteMarkdownContent_MultipleImages_RewritesAll() + { + var handler = new TestMarkdownHandler(); + + var content = "![Logo](/images/logo.png) and ![Banner](/images/banner.jpg)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be("![Logo](/images/my-project/logo.png) and ![Banner](/images/my-project/banner.jpg)"); + } + + #endregion + + #region RewriteMarkdownContent Tests - Link Rewriting + + [TestMethod] + public void RewriteMarkdownContent_MarkdownLink_RewritesPath() + { + var handler = new TestMarkdownHandler(); + + var content = "[Getting Started](/guides/quickstart)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be("[Getting Started](/my-project/guides/quickstart)"); + } + + [TestMethod] + public void RewriteMarkdownContent_MarkdownLinkWithAnchor_PreservesAnchor() + { + var handler = new TestMarkdownHandler(); + + var content = "[Installation](/guides/install#prerequisites)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be("[Installation](/my-project/guides/install#prerequisites)"); + } + + [TestMethod] + public void RewriteMarkdownContent_MarkdownLinkWithQueryString_PreservesQueryString() + { + var handler = new TestMarkdownHandler(); + + var content = "[API Reference](/api/overview?version=2)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be("[API Reference](/my-project/api/overview?version=2)"); + } + + [TestMethod] + public void RewriteMarkdownContent_MultipleLinks_RewritesAll() + { + var handler = new TestMarkdownHandler(); + + var content = "[Home](/index) and [About](/about)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be("[Home](/my-project/index) and [About](/my-project/about)"); + } + + #endregion + + #region RewriteMarkdownContent Tests - Code Block Preservation + + [TestMethod] + public void RewriteMarkdownContent_PathInCodeBlock_PreservesOriginalPath() + { + var handler = new TestMarkdownHandler(); + + var content = """ + ```bash + curl /api/endpoint + ``` + """; + + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be(content, "paths inside code blocks should not be rewritten"); + } + + [TestMethod] + public void RewriteMarkdownContent_PathInTildeCodeBlock_PreservesOriginalPath() + { + var handler = new TestMarkdownHandler(); + + var content = """ + ~~~javascript + fetch('/api/data'); + ~~~ + """; + + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be(content, "paths inside tilde code blocks should not be rewritten"); + } + + [TestMethod] + public void RewriteMarkdownContent_MixedContentWithCodeBlock_OnlyRewritesOutsideCodeBlock() + { + var handler = new TestMarkdownHandler(); + + var content = """ + [Documentation](/docs/intro) + + ```javascript + import { api } from '/api/client'; + ``` + + [More Info](/docs/advanced) + """; + + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Contain("[Documentation](/my-project/docs/intro)"); + result.Should().Contain("import { api } from '/api/client';"); + result.Should().Contain("[More Info](/my-project/docs/advanced)"); + } + + #endregion + + #region RewriteMarkdownContent Tests - Path Preservation + + [TestMethod] + public void RewriteMarkdownContent_RelativePath_PreservesOriginalPath() + { + var handler = new TestMarkdownHandler(); + + var content = "[Link](./relative/path)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be(content, "relative paths should not be rewritten"); + } + + [TestMethod] + public void RewriteMarkdownContent_AlreadyPrefixedPath_PreservesOriginalPath() + { + var handler = new TestMarkdownHandler(); + + var content = "[Link](/my-project/guides/intro)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be(content, "already-prefixed paths should not be rewritten again"); + } + + [TestMethod] + public void RewriteMarkdownContent_ExternalProtocolRelativeUrl_PreservesOriginalPath() + { + var handler = new TestMarkdownHandler(); + + var content = "[External](//example.com/page)"; + var result = handler.TestRewriteMarkdownContent(content, "my-project"); + + result.Should().Be(content, "protocol-relative URLs should not be rewritten"); + } + + [TestMethod] + public void RewriteMarkdownContent_EmptyContent_ReturnsEmpty() + { + var handler = new TestMarkdownHandler(); + + var result = handler.TestRewriteMarkdownContent("", "my-project"); + + result.Should().Be(""); + } + + [TestMethod] + public void RewriteMarkdownContent_NullOrWhitespaceDestination_ReturnsOriginalContent() + { + var handler = new TestMarkdownHandler(); + var content = "[Link](/guides/intro)"; + + handler.TestRewriteMarkdownContent(content, "").Should().Be(content); + handler.TestRewriteMarkdownContent(content, " ").Should().Be(content); + } + + #endregion + + #region RewritePath Tests + + [TestMethod] + public void RewritePath_ImagesPath_InsertsDestinationAfterImages() + { + var handler = new TestMarkdownHandler(); + + var result = handler.TestRewritePath("/images/logo.png", "my-project"); + + result.Should().Be("/images/my-project/logo.png"); + } + + [TestMethod] + public void RewritePath_SnippetsPath_InsertsDestinationAfterSnippets() + { + var handler = new TestMarkdownHandler(); + + var result = handler.TestRewritePath("/snippets/component.jsx", "my-project"); + + result.Should().Be("/snippets/my-project/component.jsx"); + } + + [TestMethod] + public void RewritePath_PagePath_InsertsDestinationAtRoot() + { + var handler = new TestMarkdownHandler(); + + var result = handler.TestRewritePath("/guides/overview", "my-project"); + + result.Should().Be("/my-project/guides/overview"); + } + + [TestMethod] + public void RewritePath_AlreadyPrefixed_ReturnsOriginal() + { + var handler = new TestMarkdownHandler(); + + var result = handler.TestRewritePath("/my-project/guides/overview", "my-project"); + + result.Should().Be("/my-project/guides/overview"); + } + + [TestMethod] + public void RewritePath_ProtocolRelativeUrl_ReturnsOriginal() + { + var handler = new TestMarkdownHandler(); + + var result = handler.TestRewritePath("//cdn.example.com/image.png", "my-project"); + + result.Should().Be("//cdn.example.com/image.png"); + } + + [TestMethod] + public void RewritePath_RelativePath_ReturnsOriginal() + { + var handler = new TestMarkdownHandler(); + + var result = handler.TestRewritePath("./local/file.md", "my-project"); + + result.Should().Be("./local/file.md"); + } + + [TestMethod] + public void RewritePath_EmptyOrNull_ReturnsOriginal() + { + var handler = new TestMarkdownHandler(); + + handler.TestRewritePath("", "my-project").Should().Be(""); + handler.TestRewritePath(" ", "my-project").Should().Be(" "); + } + + #endregion + + #region IsInsideCodeBlock Tests + + [TestMethod] + public void IsInsideCodeBlock_OutsideCodeBlock_ReturnsFalse() + { + var handler = new TestMarkdownHandler(); + + var content = """ + Regular content here. + + ```js + code here + ``` + + More content. + """; + + // Position at "Regular" - outside code block + handler.TestIsInsideCodeBlock(content, 0).Should().BeFalse(); + // Position at "More content" - outside code block + handler.TestIsInsideCodeBlock(content, content.LastIndexOf("More")).Should().BeFalse(); + } + + [TestMethod] + public void IsInsideCodeBlock_InsideCodeBlock_ReturnsTrue() + { + var handler = new TestMarkdownHandler(); + + var content = """ + Before code. + + ```js + code here + ``` + + After code. + """; + + // Position at "code here" - inside code block + var codePosition = content.IndexOf("code here"); + handler.TestIsInsideCodeBlock(content, codePosition).Should().BeTrue(); + } + + #endregion + + #region ProcessAsync Integration Tests + + [TestMethod] + public async Task ProcessAsync_CopiesAndRewritesMarkdownFiles() + { + // Arrange + var testDir = Path.Combine(Path.GetTempPath(), $"MarkdownHandlerTest_{System.Guid.NewGuid():N}"); + var sourceDir = Path.Combine(testDir, "source"); + var destDir = Path.Combine(testDir, "dest"); + + try + { + // Create source structure + Directory.CreateDirectory(Path.Combine(sourceDir, "guides")); + Directory.CreateDirectory(Path.Combine(sourceDir, "images")); + + // Create a markdown file with paths to rewrite + var mdContent = """ + # Guide + + ![Logo](/images/logo.png) + + [Home](/index) + """; + File.WriteAllText(Path.Combine(sourceDir, "guides", "intro.md"), mdContent); + + // Create an image file + File.WriteAllBytes(Path.Combine(sourceDir, "images", "logo.png"), new byte[] { 0x89, 0x50, 0x4E, 0x47 }); + + var reference = new DocumentationReference + { + DocumentationRoot = sourceDir, + DestinationPath = "my-lib", + DocumentationType = SupportedDocumentationType.Generic + }; + + var handler = new MarkdownDocReferenceHandler(); + + // Act + await handler.ProcessAsync(reference, destDir); + + // Assert - Content file should be copied with rewritten paths + var copiedMd = Path.Combine(destDir, "my-lib", "guides", "intro.md"); + File.Exists(copiedMd).Should().BeTrue("markdown file should be copied"); + + var rewrittenContent = File.ReadAllText(copiedMd); + rewrittenContent.Should().Contain("/images/my-lib/logo.png", "image path should be rewritten"); + rewrittenContent.Should().Contain("/my-lib/index", "link path should be rewritten"); + + // Assert - Image should be relocated to central location + var relocatedImage = Path.Combine(destDir, "images", "my-lib", "logo.png"); + File.Exists(relocatedImage).Should().BeTrue("image should be relocated to /images/{dest}/"); + } + finally + { + // Cleanup + if (Directory.Exists(testDir)) + { + Directory.Delete(testDir, recursive: true); + } + } + } + + [TestMethod] + public async Task ProcessAsync_RelocatesSnippetsDirectory() + { + // Arrange + var testDir = Path.Combine(Path.GetTempPath(), $"MarkdownHandlerTest_{System.Guid.NewGuid():N}"); + var sourceDir = Path.Combine(testDir, "source"); + var destDir = Path.Combine(testDir, "dest"); + + try + { + // Create source structure with snippets + Directory.CreateDirectory(Path.Combine(sourceDir, "snippets")); + + File.WriteAllText(Path.Combine(sourceDir, "snippets", "example.txt"), "snippet content"); + + var reference = new DocumentationReference + { + DocumentationRoot = sourceDir, + DestinationPath = "my-lib", + DocumentationType = SupportedDocumentationType.Generic + }; + + var handler = new MarkdownDocReferenceHandler(); + + // Act + await handler.ProcessAsync(reference, destDir); + + // Assert - Snippet should be relocated to central location + var relocatedSnippet = Path.Combine(destDir, "snippets", "my-lib", "example.txt"); + File.Exists(relocatedSnippet).Should().BeTrue("snippet should be relocated to /snippets/{dest}/"); + } + finally + { + // Cleanup + if (Directory.Exists(testDir)) + { + Directory.Delete(testDir, recursive: true); + } + } + } + + [TestMethod] + public async Task ProcessAsync_OnlyRewritesMdFiles() + { + // Arrange + var testDir = Path.Combine(Path.GetTempPath(), $"MarkdownHandlerTest_{System.Guid.NewGuid():N}"); + var sourceDir = Path.Combine(testDir, "source"); + var destDir = Path.Combine(testDir, "dest"); + + try + { + Directory.CreateDirectory(sourceDir); + + // Create markdown file (should be rewritten) + File.WriteAllText(Path.Combine(sourceDir, "guide.md"), "[Link](/index)"); + + // Create non-markdown file (should NOT be rewritten) + File.WriteAllText(Path.Combine(sourceDir, "data.json"), "{\"link\": \"/index\"}"); + + var reference = new DocumentationReference + { + DocumentationRoot = sourceDir, + DestinationPath = "my-lib", + DocumentationType = SupportedDocumentationType.Generic + }; + + var handler = new MarkdownDocReferenceHandler(); + + // Act + await handler.ProcessAsync(reference, destDir); + + // Assert - MD file should have rewritten paths + var mdContent = File.ReadAllText(Path.Combine(destDir, "my-lib", "guide.md")); + mdContent.Should().Contain("/my-lib/index"); + + // Assert - JSON file should NOT have rewritten paths + var jsonContent = File.ReadAllText(Path.Combine(destDir, "my-lib", "data.json")); + jsonContent.Should().Contain("\"/index\"", "non-markdown files should not be rewritten"); + } + finally + { + // Cleanup + if (Directory.Exists(testDir)) + { + Directory.Delete(testDir, recursive: true); + } + } + } + + #endregion + + #region Test Helper Class + + /// + /// Test helper that exposes protected methods of for testing. + /// + private class TestMarkdownHandler : MarkdownDocReferenceHandler + { + + public string TestRewriteMarkdownContent(string content, string destinationPath) + { + return RewriteMarkdownContent(content, destinationPath); + } + + public string TestRewritePath(string originalPath, string destinationPath) + { + return RewritePath(originalPath, destinationPath); + } + + public bool TestIsInsideCodeBlock(string content, int position) + { + return IsInsideCodeBlock(content, position); + } + + } + + #endregion + + } + +} diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/ProjectContextTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/ProjectContextTests.cs index 1f53c18..d6f495f 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/ProjectContextTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/ProjectContextTests.cs @@ -240,13 +240,13 @@ public void GetSafeNamespaceName_WithNormalNamespace_ReturnsNamespaceName() namespace TestNamespace { public class TestClass { } - }"); + }", cancellationToken: TestContext.CancellationToken); var compilation = CSharpCompilation.Create("Test", new[] { syntaxTree }); var semanticModel = compilation.GetSemanticModel(syntaxTree); - var namespaceDeclaration = syntaxTree.GetRoot().DescendantNodes() + var namespaceDeclaration = syntaxTree.GetRoot(TestContext.CancellationToken).DescendantNodes() .OfType() .First(); - var namespaceSymbol = semanticModel.GetDeclaredSymbol(namespaceDeclaration); + var namespaceSymbol = semanticModel.GetDeclaredSymbol(namespaceDeclaration, TestContext.CancellationToken); // Act var result = context.GetSafeNamespaceName(namespaceSymbol!); @@ -264,13 +264,13 @@ public void GetSafeNamespaceName_WithNestedNamespace_ReturnsFullName() namespace CloudNimble.DotNetDocs.Core { public class TestClass { } - }"); + }", cancellationToken: TestContext.CancellationToken); var compilation = CSharpCompilation.Create("Test", new[] { syntaxTree }); var semanticModel = compilation.GetSemanticModel(syntaxTree); - var namespaceDeclaration = syntaxTree.GetRoot().DescendantNodes() + var namespaceDeclaration = syntaxTree.GetRoot(TestContext.CancellationToken).DescendantNodes() .OfType() .First(); - var namespaceSymbol = semanticModel.GetDeclaredSymbol(namespaceDeclaration); + var namespaceSymbol = semanticModel.GetDeclaredSymbol(namespaceDeclaration, TestContext.CancellationToken); // Act var result = context.GetSafeNamespaceName(namespaceSymbol!); @@ -475,7 +475,7 @@ public void EnsureOutputDirectoryStructure_WithFileMode_OnlyCreatesOutputDirecto namespace TestNamespace.SubNamespace { public class TestClass { } - }"); + }", cancellationToken: TestContext.CancellationToken); var compilation = CSharpCompilation.Create("TestAssembly", new[] { syntaxTree }); var assemblySymbol = compilation.Assembly; var namespaceSymbol = compilation.GlobalNamespace.GetNamespaceMembers() @@ -523,7 +523,7 @@ public class TestClass { } namespace AnotherNamespace { public class AnotherClass { } - }"); + }", cancellationToken: TestContext.CancellationToken); var compilation = CSharpCompilation.Create("TestAssembly", new[] { syntaxTree }); var assemblySymbol = compilation.Assembly; @@ -573,7 +573,7 @@ public void EnsureOutputDirectoryStructure_WithGlobalNamespace_CreatesGlobalFold var tempPath = Path.Combine(Path.GetTempPath(), $"EnsureTest_{Guid.NewGuid()}"); var syntaxTree = CSharpSyntaxTree.ParseText(@" - public class GlobalClass { }"); + public class GlobalClass { }", cancellationToken: TestContext.CancellationToken); var compilation = CSharpCompilation.Create("TestAssembly", new[] { syntaxTree }); var assemblySymbol = compilation.Assembly; diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/JsonRendererTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/JsonRendererTests.cs index 56bbc08..15ec0eb 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/JsonRendererTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/JsonRendererTests.cs @@ -1,5 +1,4 @@ using System; -using System.Collections.Generic; using System.IO; using System.Linq; using System.Text.Json; @@ -132,7 +131,7 @@ public async Task RenderAsync_ProducesValidJson() // Assert var context = GetService(); var jsonPath = Path.Combine(_testOutputPath, "documentation.json"); - var json = await File.ReadAllTextAsync(jsonPath); + var json = await File.ReadAllTextAsync(jsonPath, TestContext.CancellationToken); Action act = () => JsonDocument.Parse(json); act.Should().NotThrow(); @@ -154,7 +153,7 @@ public async Task RenderAsync_IncludesAssemblyMetadata() await GetJsonRenderer().RenderAsync(model); // Assert - var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationTokenSource.Token); + var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationToken); using var document = JsonDocument.Parse(json); // DocAssembly is serialized directly, so root element is the assembly @@ -186,23 +185,27 @@ public async Task RenderAsync_CreatesNamespaceFiles() var nsPath = Path.Combine(_testOutputPath, fileName); File.Exists(nsPath).Should().BeTrue($"Namespace file {fileName} should exist"); - var json = await File.ReadAllTextAsync(nsPath, TestContext.CancellationTokenSource.Token); + var json = await File.ReadAllTextAsync(nsPath, TestContext.CancellationToken); Action act = () => JsonDocument.Parse(json); act.Should().NotThrow(); } } [TestMethod] - public async Task RenderAsync_WithNullModel_ThrowsArgumentNullException() + public async Task RenderAsync_WithNullModel_ReturnsWithoutError() { // Arrange var renderer = GetJsonRenderer(); - // Act - Func act = async () => await renderer.RenderAsync(null!); + // Act - Documentation-only mode passes null model to renderers + Func act = async () => await renderer.RenderAsync(null); - // Assert - await act.Should().ThrowAsync(); + // Assert - Should not throw, should return gracefully + await act.Should().NotThrowAsync(); + + // Verify no documentation.json was created (nothing to render) + var docJsonPath = Path.Combine(_testOutputPath, "documentation.json"); + File.Exists(docJsonPath).Should().BeFalse("No documentation file should be created for null model"); } #endregion @@ -221,7 +224,7 @@ public async Task RenderAsync_IncludesNamespaceHierarchy() await documentationManager.ProcessAsync(assemblyPath, xmlPath); // Assert - var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json")); + var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationToken); using var document = JsonDocument.Parse(json); var namespaces = document.RootElement.GetProperty("namespaces"); @@ -246,7 +249,7 @@ public async Task RenderAsync_IncludesTypeInformation() await documentationManager.ProcessAsync(assemblyPath, xmlPath); // Assert - var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationTokenSource.Token); + var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationToken); using var document = JsonDocument.Parse(json); var namespaces = document.RootElement.GetProperty("namespaces"); @@ -281,7 +284,7 @@ public async Task RenderAsync_IncludesMemberInformation() await documentationManager.ProcessAsync(assemblyPath, xmlPath); // Assert - var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationTokenSource.Token); + var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationToken); using var document = JsonDocument.Parse(json); var namespaces = document.RootElement.GetProperty("namespaces"); @@ -326,7 +329,7 @@ public async Task RenderAsync_IncludesParameterInformation() await documentationManager.ProcessAsync(assemblyPath, xmlPath); // Assert - var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json")); + var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationToken); using var document = JsonDocument.Parse(json); var namespaces = document.RootElement.GetProperty("namespaces"); @@ -374,13 +377,13 @@ public async Task RenderAsync_UsesProperJsonNamingConvention() using var manager = new AssemblyManager(assemblyPath, xmlPath); var model = await manager.DocumentAsync(context); model.BestPractices = "Test best practices"; - model.RelatedApis = new List { "System.Object" }; + model.RelatedApis = ["System.Object"]; // Act await GetJsonRenderer().RenderAsync(model); // Assert - var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationTokenSource.Token); + var json = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "documentation.json"), TestContext.CancellationToken); using var document = JsonDocument.Parse(json); // DocAssembly is serialized directly at root level @@ -442,7 +445,7 @@ public async Task GenerateJsonBaseline(string projectPath) await renderer.RenderAsync(assembly); } -#endregion + #endregion } diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/MarkdownRendererTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/MarkdownRendererTests.cs index f85a85d..2517356 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/MarkdownRendererTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/MarkdownRendererTests.cs @@ -1,5 +1,4 @@ using System; -using System.Collections.Generic; using System.IO; using System.Linq; using System.Text; @@ -98,8 +97,8 @@ public async Task RenderAsync_ProducesConsistentBaseline() if (File.Exists(baselinePath)) { - var baseline = await File.ReadAllTextAsync(baselinePath, TestContext.CancellationTokenSource.Token); - var actual = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationTokenSource.Token); + var baseline = await File.ReadAllTextAsync(baselinePath, TestContext.CancellationToken); + var actual = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationToken); // Normalize line endings for cross-platform compatibility var normalizedActual = actual.ReplaceLineEndings(Environment.NewLine); @@ -170,13 +169,20 @@ public async Task RenderAsync_WithTypes_CreatesTypeFiles() } [TestMethod] - public async Task RenderAsync_WithNullModel_ThrowsArgumentNullException() + public async Task RenderAsync_WithNullModel_ReturnsWithoutError() { + // Arrange var renderer = GetMarkdownRenderer(); - Func act = async () => await renderer.RenderAsync(null!); + // Act - Documentation-only mode passes null model to renderers + Func act = async () => await renderer.RenderAsync(null); - await act.Should().ThrowAsync(); + // Assert - Should not throw, should return gracefully + await act.Should().NotThrowAsync(); + + // Verify no index.md was created (nothing to render) + var indexPath = Path.Combine(_testOutputPath, "index.md"); + File.Exists(indexPath).Should().BeFalse("No index file should be created for null model"); } [TestMethod] @@ -231,7 +237,7 @@ public async Task RenderAsync_IncludesAssemblyUsage_WhenProvided() var renderer = GetMarkdownRenderer(); await renderer.RenderAsync(model); - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationToken); content.Should().Contain("## Usage"); content.Should().Contain("This is assembly usage documentation"); } @@ -250,7 +256,7 @@ public async Task RenderAsync_IncludesAssemblyExamples_WhenProvided() var renderer = GetMarkdownRenderer(); await renderer.RenderAsync(model); - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationToken); content.Should().Contain("## Examples"); content.Should().Contain("Example code here"); } @@ -264,12 +270,12 @@ public async Task RenderAsync_IncludesRelatedApis_WhenProvided() // Get the model and modify it using var manager = new AssemblyManager(assemblyPath, xmlPath); var model = await manager.DocumentAsync(); - model.RelatedApis = new List { "System.Object", "System.String" }; + model.RelatedApis = ["System.Object", "System.String"]; var renderer = GetMarkdownRenderer(); await renderer.RenderAsync(model); - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationToken); content.Should().Contain("## Related APIs"); content.Should().Contain("- System.Object"); content.Should().Contain("- System.String"); @@ -291,12 +297,12 @@ public async Task RenderAsync_HandlesEmptyDocumentation_Gracefully() model.BestPractices = string.Empty; model.Patterns = string.Empty; model.Considerations = string.Empty; - model.RelatedApis = new List(); + model.RelatedApis = []; var renderer = GetMarkdownRenderer(); await renderer.RenderAsync(model); - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationToken); content.Should().Contain($"# {model.AssemblyName}"); content.Should().NotContain("## Overview"); content.Should().NotContain("## Examples"); @@ -324,7 +330,7 @@ public async Task RenderAsync_IncludesMemberSignatures_InTypeFiles() var ns = model.Namespaces.First(n => n.Types.Any(t => t.Symbol.Name == "ClassWithMethods")); var namespaceName = string.IsNullOrEmpty(ns.Name) ? "global" : ns.Name; var typeFileName = $"{namespaceName.Replace('.', context.FileNamingOptions.NamespaceSeparator)}.ClassWithMethods.md"; - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, typeFileName), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, typeFileName), TestContext.CancellationToken); content.Should().Contain("```csharp"); content.Should().Contain("public"); @@ -659,7 +665,7 @@ public async Task RenderAssemblyAsync_Should_Include_Assembly_Name() await renderer.RenderAssemblyAsync(assembly, _testOutputPath); var indexPath = Path.Combine(_testOutputPath, "index.md"); - var content = await File.ReadAllTextAsync(indexPath); + var content = await File.ReadAllTextAsync(indexPath, TestContext.CancellationToken); content.Should().Contain($"# {assembly.AssemblyName}"); } @@ -672,7 +678,7 @@ public async Task RenderAssemblyAsync_Should_Include_Usage_When_Present() await renderer.RenderAssemblyAsync(assembly, _testOutputPath); - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md")); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationToken); content.Should().Contain("## Usage"); content.Should().Contain(assembly.Usage); } @@ -685,7 +691,7 @@ public async Task RenderAssemblyAsync_Should_List_Namespaces() await renderer.RenderAssemblyAsync(assembly, _testOutputPath); - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md")); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.md"), TestContext.CancellationToken); content.Should().Contain("## Namespaces"); foreach (var ns in assembly.Namespaces) { @@ -734,7 +740,7 @@ public async Task RenderNamespaceAsync_Should_List_Types_By_Category() var namespaceName = string.IsNullOrEmpty(ns.Name) ? "global" : ns.Name; var nsPath = Path.Combine(_testOutputPath, $"{namespaceName.Replace('.', context.FileNamingOptions.NamespaceSeparator)}.md"); - var content = await File.ReadAllTextAsync(nsPath); + var content = await File.ReadAllTextAsync(nsPath, TestContext.CancellationToken); content.Should().Contain("## Types"); if (ns.Types.Any(t => t.Symbol.TypeKind == TypeKind.Class)) @@ -798,7 +804,7 @@ public async Task RenderTypeAsync_Should_Include_Type_Metadata() var separator = context.FileNamingOptions.NamespaceSeparator; var fileName = $"{safeNamespace.Replace('.', separator)}.{safeTypeName}.md"; var typePath = Path.Combine(_testOutputPath, fileName); - var content = await File.ReadAllTextAsync(typePath); + var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationToken); content.Should().Contain($"# {type.Symbol.Name}"); content.Should().Contain("## Definition"); @@ -829,7 +835,7 @@ public async Task RenderTypeAsync_Should_Include_Type_Signature() var separator = context.FileNamingOptions.NamespaceSeparator; var fileName = $"{safeNamespace.Replace('.', separator)}.{safeTypeName}.md"; var typePath = Path.Combine(_testOutputPath, fileName); - var content = await File.ReadAllTextAsync(typePath); + var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationToken); content.Should().Contain("## Syntax"); content.Should().Contain("```csharp"); @@ -859,7 +865,7 @@ public async Task RenderTypeAsync_Should_Include_Members_By_Category() var separator = context.FileNamingOptions.NamespaceSeparator; var fileName = $"{safeNamespace.Replace('.', separator)}.{safeTypeName}.md"; var typePath = Path.Combine(_testOutputPath, fileName); - var content = await File.ReadAllTextAsync(typePath); + var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationToken); content.Should().Contain("## Constructors"); content.Should().Contain("## Methods"); @@ -1061,7 +1067,7 @@ public async Task RenderTypeAsync_Should_Include_Enum_Values() var outputFile = Path.Combine(_testOutputPath, "CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.md"); File.Exists(outputFile).Should().BeTrue("Output file should exist"); - var content = await File.ReadAllTextAsync(outputFile); + var content = await File.ReadAllTextAsync(outputFile, TestContext.CancellationToken); // Check that enum values section is present content.Should().Contain("## Values", "Should have Values section"); @@ -1094,7 +1100,7 @@ public async Task RenderTypeAsync_Should_Include_Flags_Attribute() await renderer.RenderTypeAsync(flagsEnum!, assembly.Namespaces.First(n => n.Types.Contains(flagsEnum!)), _testOutputPath); var outputFile = Path.Combine(_testOutputPath, "CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.md"); - var content = await File.ReadAllTextAsync(outputFile); + var content = await File.ReadAllTextAsync(outputFile, TestContext.CancellationToken); // Check that Flags attribute is mentioned content.Should().Contain("[Flags]", "Should indicate Flags attribute"); @@ -1123,7 +1129,7 @@ public async Task RenderTypeAsync_Should_Show_Correct_Underlying_Type() await renderer.RenderTypeAsync(byteEnum!, assembly.Namespaces.First(n => n.Types.Contains(byteEnum!)), _testOutputPath); var outputFile = Path.Combine(_testOutputPath, "CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.md"); - var content = await File.ReadAllTextAsync(outputFile); + var content = await File.ReadAllTextAsync(outputFile, TestContext.CancellationToken); // Check that underlying type is shown content.Should().Contain("**Underlying Type:** byte", "Should show byte as underlying type"); diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/YamlRendererTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/YamlRendererTests.cs index 3d7fd87..7a6d490 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/YamlRendererTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Renderers/YamlRendererTests.cs @@ -112,8 +112,8 @@ public async Task RenderAsync_ProducesConsistentBaseline() if (File.Exists(baselinePath)) { - var baseline = await File.ReadAllTextAsync(baselinePath); - var actual = await File.ReadAllTextAsync(actualPath); + var baseline = await File.ReadAllTextAsync(baselinePath, TestContext.CancellationToken); + var actual = await File.ReadAllTextAsync(actualPath, TestContext.CancellationToken); // Normalize line endings for cross-platform compatibility var normalizedActual = actual.ReplaceLineEndings(Environment.NewLine); @@ -159,7 +159,7 @@ public async Task RenderAsync_ProducesValidYaml() // Assert var context = GetService(); var yamlPath = Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml"); - var yaml = await File.ReadAllTextAsync(yamlPath); + var yaml = await File.ReadAllTextAsync(yamlPath, TestContext.CancellationToken); Action act = () => _yamlDeserializer.Deserialize>(yaml); act.Should().NotThrow(); @@ -182,7 +182,7 @@ public async Task RenderAsync_IncludesAssemblyMetadata() await GetYamlRenderer().RenderAsync(model); // Assert - var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml")); + var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml"), TestContext.CancellationToken); var document = _yamlDeserializer.Deserialize>(yaml); // DocAssembly is serialized directly at root level @@ -216,23 +216,28 @@ public async Task RenderAsync_CreatesNamespaceFiles() var nsPath = Path.Combine(_testOutputPath, context.ApiReferencePath, nsFileName); File.Exists(nsPath).Should().BeTrue($"Namespace file {nsFileName} should exist"); - var yaml = await File.ReadAllTextAsync(nsPath); + var yaml = await File.ReadAllTextAsync(nsPath, TestContext.CancellationToken); Action act = () => _yamlDeserializer.Deserialize>(yaml); act.Should().NotThrow(); } } [TestMethod] - public async Task RenderAsync_WithNullModel_ThrowsArgumentNullException() + public async Task RenderAsync_WithNullModel_ReturnsWithoutError() { // Arrange var renderer = GetYamlRenderer(); + var context = GetService(); - // Act - Func act = async () => await renderer.RenderAsync(null!); + // Act - Documentation-only mode passes null model to renderers + Func act = async () => await renderer.RenderAsync(null); - // Assert - await act.Should().ThrowAsync(); + // Assert - Should not throw, should return gracefully + await act.Should().NotThrowAsync(); + + // Verify no documentation.yaml was created (nothing to render) + var docYamlPath = Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml"); + File.Exists(docYamlPath).Should().BeFalse("No documentation file should be created for null model"); } #endregion @@ -283,7 +288,7 @@ public async Task RenderAsync_IncludesTypeInformation() // Assert var context = GetService(); - var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml")); + var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml"), TestContext.CancellationToken); var document = _yamlDeserializer.Deserialize>(yaml); // DocAssembly is serialized directly at root level @@ -325,7 +330,7 @@ public async Task RenderAsync_IncludesMemberModifiers() // Assert var context = GetService(); - var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml")); + var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml"), TestContext.CancellationToken); var document = _yamlDeserializer.Deserialize>(yaml); // DocAssembly is serialized directly at root level @@ -377,7 +382,7 @@ public async Task RenderAsync_IncludesParameterDetails() // Assert var context = GetService(); - var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml")); + var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml"), TestContext.CancellationToken); var document = _yamlDeserializer.Deserialize>(yaml); // DocAssembly is serialized directly at root level @@ -406,7 +411,7 @@ public async Task RenderAsync_IncludesParameterDetails() { param.Should().ContainKey("name"); // parameterType or typeName should exist - (param.ContainsKey("parameterType") || param.ContainsKey("typeName")).Should().BeTrue(); + (param.ContainsKey("parameterType") || param.ContainsKey("typeName")).Should().BeTrue("parameterType or typeName should exist"); // These properties are only present when true or when hasDefaultValue is true // We just need to verify the structure is correct when they exist @@ -450,13 +455,13 @@ public async Task RenderAsync_UsesProperYamlNamingConvention() using var manager = new AssemblyManager(assemblyPath, xmlPath); var model = await manager.DocumentAsync(context); model.BestPractices = "Test best practices"; - model.RelatedApis = new List { "System.Object" }; + model.RelatedApis = ["System.Object"]; // Act await GetYamlRenderer().RenderAsync(model); // Assert - var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml")); + var yaml = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, context.ApiReferencePath, "documentation.yaml"), TestContext.CancellationToken); var document = _yamlDeserializer.Deserialize>(yaml); // DocAssembly is serialized directly at root level @@ -605,7 +610,7 @@ public async Task RenderAsync_WithFolderMode_CreatesNamespaceFolderStructure() // YAML renderer includes types within namespace files, not as separate files // So we just check that the namespace file exists - var content = await File.ReadAllTextAsync(indexFile); + var content = await File.ReadAllTextAsync(indexFile, TestContext.CancellationToken); content.Should().NotBeNullOrWhiteSpace(); content.Should().Contain("types", "Namespace file should include types"); } @@ -694,7 +699,7 @@ public async Task RenderAsync_WithWebSafeSeparators_CreatesValidFileNames() { var fileName = Path.GetFileNameWithoutExtension(file); // Check that file names don't contain invalid web characters - fileName.Should().NotContainAny(new[] { "<", ">", ":", "\"", "|", "?", "*", "\\" }, + fileName.Should().NotContainAny(["<", ">", ":", "\"", "|", "?", "*", "\\"], $"File names with separator '{separator}' should be web-safe"); } } @@ -795,7 +800,7 @@ await CompareYamlWithFolderBaseline( private async Task CompareYamlWithFolderBaseline(string actualFilePath, string baselineRelativePath) { // Read actual file - var actualContent = await File.ReadAllTextAsync(actualFilePath); + var actualContent = await File.ReadAllTextAsync(actualFilePath, TestContext.CancellationToken); // Construct baseline path var baselineDir = Path.Combine( @@ -814,13 +819,13 @@ private async Task CompareYamlWithFolderBaseline(string actualFilePath, string b { Directory.CreateDirectory(directory); } - await File.WriteAllTextAsync(baselinePath, actualContent); + await File.WriteAllTextAsync(baselinePath, actualContent, TestContext.CancellationToken); Assert.Inconclusive($"Baseline created at: {baselinePath}. Re-run test to verify."); } // Parse YAML for comparison var actualYaml = _yamlDeserializer.Deserialize(actualContent); - var baselineContent = await File.ReadAllTextAsync(baselinePath); + var baselineContent = await File.ReadAllTextAsync(baselinePath, TestContext.CancellationToken); var baselineYaml = _yamlDeserializer.Deserialize(baselineContent); // Compare YAML structures @@ -847,8 +852,8 @@ private async Task CompareYamlWithFolderBaseline(string actualFilePath, string b /// these are unit test baselines for the renderer itself, not integration test baselines. /// The renderer should be tested in isolation without transformers applied. /// - //[TestMethod] - //[DataRow(projectPath)] + [TestMethod] + [DataRow(projectPath)] [BreakdanceManifestGenerator] public async Task GenerateYamlBaselines(string projectPath) { @@ -938,7 +943,6 @@ private async Task GenerateFolderModeBaselines(string projectPath) await renderer.RenderAsync(assembly); } - #endregion } diff --git a/src/CloudNimble.DotNetDocs.Tests.Core/Transformers/MarkdownXmlTransformerTests.cs b/src/CloudNimble.DotNetDocs.Tests.Core/Transformers/MarkdownXmlTransformerTests.cs index fb90e71..c13345c 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Core/Transformers/MarkdownXmlTransformerTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Core/Transformers/MarkdownXmlTransformerTests.cs @@ -1,5 +1,4 @@ using System; -using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using CloudNimble.DotNetDocs.Core; @@ -2636,11 +2635,11 @@ public async Task TransformAsync_ConvertsSeeAlsoReferences() namespaceMode.Should().NotBeNull("NamespaceMode type should exist in the assembly"); - namespaceMode!.SeeAlso = new List - { + namespaceMode!.SeeAlso = + [ new DocReference("T:CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode"), new DocReference("T:System.String") - }; + ]; await _transformer.TransformAsync(assembly); diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx index 2e7efe1..3d76acc 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class tests the IncludedMembers filtering functionality. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class tests the IncludedMembers filtering functionality. public MixedAccessClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### PublicProperty +### PublicProperty Gets or sets the public property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -87,7 +85,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -108,7 +106,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -122,7 +120,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -136,7 +134,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -150,7 +148,7 @@ protected internal object MemberwiseClone() Type: `object` -### PublicMethod +### PublicMethod A public method. @@ -165,7 +163,7 @@ public string PublicMethod() Type: `string` A string indicating this is a public method. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -186,7 +184,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx index bc0e0e1..f0c0cfe 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class serves as the base for DerivedClass. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class serves as the base for DerivedClass. public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Virtual Gets or sets the base property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod A method in the base class. @@ -77,7 +75,7 @@ A method in the base class. public void BaseMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Virtual A virtual method that can be overridden. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx index 34f1e3b..b4a4193 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = obj.Calculate(5, 10); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = obj.Calculate(5, 10); public ClassWithMethods() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Methods -### Calculate +### Calculate Calculates the sum of two numbers. @@ -86,7 +84,7 @@ The sum of a and b. var result = Calculate(3, 4); // Returns 7 -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -106,7 +104,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -127,7 +125,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetConditionalValue +### GetConditionalValue Gets a value based on a condition. @@ -148,7 +146,7 @@ public string GetConditionalValue(bool condition) Type: `string` Returns "Yes" if condition is true, "No" otherwise. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected internal object MemberwiseClone() Type: `object` -### PerformAction +### PerformAction A void method that performs an action. @@ -204,7 +202,7 @@ public void PerformAction() This method doesn't return anything. -### Process +### Process Processes the input string. @@ -235,7 +233,7 @@ The processed string in uppercase. This method performs a simple transformation for testing purposes. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -256,7 +254,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx index 629ebd6..1eed6c1 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains properties with different access modifiers and documentation ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains properties with different access modifiers and documentation public ClassWithProperties() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### Id +### Id Gets the read-only identifier. @@ -69,7 +67,7 @@ Type: `int` This property can only be read, not written to. -### Name +### Name Gets or sets the name. @@ -87,7 +85,7 @@ Type: `string` This is a standard public property with get and set accessors. -### Value +### Value Gets or sets the value with a private setter. @@ -107,7 +105,7 @@ This property can be read publicly but only set within the class. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -127,7 +125,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -148,7 +146,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -211,7 +209,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -225,7 +223,7 @@ public virtual string ToString() Type: `string?` -### UpdateValue +### UpdateValue Updates the value property. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx index a3da30c..59b3996 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = derived.VirtualMethod(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = derived.VirtualMethod(); public DerivedClass() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -56,7 +54,7 @@ public DerivedClass() public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -68,7 +66,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Override Gets or sets the base property with overridden behavior. @@ -86,7 +84,7 @@ Type: `string` This property overrides the base implementation. -### BaseProperty +### BaseProperty Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -102,7 +100,7 @@ public virtual string BaseProperty { get; set; } Type: `string` -### DerivedProperty +### DerivedProperty Gets or sets the derived property. @@ -118,7 +116,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -130,7 +128,7 @@ A method in the base class. public void BaseMethod() ``` -### DerivedMethod +### DerivedMethod An additional method in the derived class. @@ -140,7 +138,7 @@ An additional method in the derived class. public void DerivedMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -160,7 +158,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -209,7 +207,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -223,7 +221,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -244,7 +242,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -258,7 +256,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Override Overrides the virtual method from the base class. @@ -277,7 +275,7 @@ A string indicating the derived implementation. This method provides custom behavior for the derived class. -### VirtualMethod +### VirtualMethod Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx index 5e97dfe..b0f7d27 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'System.IDisposable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ using (var disposable = new DisposableClass()) ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ using (var disposable = new DisposableClass()) public DisposableClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Properties -### ResourceName +### ResourceName Gets or sets the resource name. @@ -76,7 +74,7 @@ Type: `string` ## Methods -### Dispose +### Dispose Disposes the resources used by this instance. @@ -90,7 +88,7 @@ public void Dispose() Implements the IDisposable pattern. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -110,7 +108,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -131,7 +129,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -145,7 +143,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -159,7 +157,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -173,7 +171,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -194,7 +192,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -208,7 +206,7 @@ public virtual string ToString() Type: `string?` -### UseResource +### UseResource Uses the resource. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx index 4223fec..aeb5dd9 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -30,7 +28,7 @@ This interface is used to test extension methods on interfaces and to verify ## Properties -### TestValue +### TestValue Abstract Gets the test value. @@ -46,7 +44,7 @@ Type: `string` ## Methods -### GetFormattedValue +### GetFormattedValue Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` @@ -76,7 +74,7 @@ ITestInterface test = new TestImplementation(); var formatted = test.GetFormattedValue(); -### TestMethod +### TestMethod Abstract Performs a test operation. @@ -86,7 +84,7 @@ Performs a test operation. void TestMethod() ``` -### Validate +### Validate Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx index 6e0634e..20f90ce 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -39,7 +37,7 @@ simple.DoWork(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -47,7 +45,7 @@ simple.DoWork(); public SimpleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -59,7 +57,7 @@ public Object() ## Methods -### DoWork +### DoWork Performs some work. @@ -73,7 +71,7 @@ public void DoWork() This method doesn't actually do anything, but it has documentation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### IsValid +### IsValid Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -169,7 +167,7 @@ True if valid, otherwise false. This is a simple validation extension for demonstration purposes. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -183,7 +181,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -204,7 +202,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToDisplayString +### ToDisplayString Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -234,7 +232,7 @@ var simple = new SimpleClass(); var display = simple.ToDisplayString(); -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx index f0ed2df..80e74bd 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -32,7 +30,7 @@ This class implements ITestInterface to demonstrate interface member inheritance ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class implements ITestInterface to demonstrate interface member inheritance public TestImplementation() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### TestValue +### TestValue Gets the test value. @@ -68,7 +66,7 @@ Type: `string` ## Methods -### AdditionalMethod +### AdditionalMethod An additional method specific to the implementation. @@ -78,7 +76,7 @@ An additional method specific to the implementation. public void AdditionalMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -98,7 +96,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -119,7 +117,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -133,7 +131,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -147,7 +145,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -161,7 +159,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -182,7 +180,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### TestMethod +### TestMethod Performs a test operation. @@ -192,7 +190,7 @@ Performs a test operation. public void TestMethod() ``` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx index 561c8db..54c2fd7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ fullDocs.ComplexMethod("test", 42); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ fullDocs.ComplexMethod("test", 42); public ClassWithFullDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Properties -### Value +### Value Gets or sets the value property. @@ -79,7 +77,7 @@ This property stores important data. ## Methods -### ComplexMethod +### ComplexMethod A complex method with full documentation. @@ -133,7 +131,7 @@ Console.WriteLine(result); - `Object[])` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -153,7 +151,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -174,7 +172,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -188,7 +186,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -202,7 +200,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -216,7 +214,7 @@ protected internal object MemberwiseClone() Type: `object` -### ProcessNumbers +### ProcessNumbers Filters and transforms a collection of numbers. @@ -245,7 +243,7 @@ var numbers = Enumerable.Range(1, 10) .ToList(); -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -266,7 +264,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx index 1658ae7..79be5e2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A class with minimal documentation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A class with minimal documentation. public ClassWithMinimalDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -63,7 +61,7 @@ Type: `string` ## Methods -### DoSomething +### DoSomething Does something. @@ -73,7 +71,7 @@ Does something. public void DoSomething() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -156,7 +154,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx index 138b0df..09b9bd5 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs ## Constructors -### .ctor +### .ctor #### Syntax @@ -30,7 +28,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs public ClassWithNoDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -42,7 +40,7 @@ public Object() ## Properties -### UndocumentedProperty +### UndocumentedProperty #### Syntax @@ -56,7 +54,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -76,7 +74,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -97,7 +95,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -111,7 +109,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -125,7 +123,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -139,7 +137,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -160,7 +158,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -174,7 +172,7 @@ public virtual string ToString() Type: `string?` -### UndocumentedMethod +### UndocumentedMethod #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx index d23fa11..d99e1a2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ if (x > 0 && y < 10) { } ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ if (x > 0 && y < 10) { } public ClassWithSpecialCharacters() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -80,7 +78,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -101,7 +99,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -115,7 +113,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -129,7 +127,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -143,7 +141,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithSpecialChars +### MethodWithSpecialChars A method with special characters in docs: <T> generics. @@ -168,7 +166,7 @@ A string with & ampersands. This method handles <, >, & characters properly. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -189,7 +187,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx index 1d3fe8e..881ca58 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx index bef9fb6..be78bf2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx index 70a414d..11d13cf 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx index edac5c1..fe806ef 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx index 9955a4a..ad41304 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains methods with different parameter modifiers and types. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains methods with different parameter modifiers and types. public ParameterVariations() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -71,7 +69,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -92,7 +90,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GenericMethod +### GenericMethod A generic method with a type parameter. @@ -124,7 +122,7 @@ var result1 = GenericMethod<int>(42); var result2 = GenericMethod("hello"); -### GenericMethodWithMultipleTypes +### GenericMethodWithMultipleTypes A method with multiple generic type parameters. @@ -151,7 +149,7 @@ A key-value pair. - `TKey` - The type of the key. - `TValue` - The type of the value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -179,7 +177,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -193,7 +191,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithConstraints +### MethodWithConstraints A method demonstrating parameter constraints. @@ -218,7 +216,7 @@ The type name of the item. - `T` - The type parameter constrained to class types. -### MethodWithNullables +### MethodWithNullables A method with nullable parameters. @@ -240,7 +238,7 @@ public string MethodWithNullables(System.Nullable nullableInt, string nulla Type: `string` A description of the provided values. -### MethodWithOptionalParam +### MethodWithOptionalParam A method with an optional parameter. @@ -269,7 +267,7 @@ var result1 = MethodWithOptionalParam("test"); // Uses default value 42 var result2 = MethodWithOptionalParam("test", 100); // Uses provided value -### MethodWithOut +### MethodWithOut A method with an out parameter. @@ -291,7 +289,7 @@ public bool MethodWithOut(string input, out int value) Type: `bool` true if the parsing was successful; otherwise, false. -### MethodWithParams +### MethodWithParams A method with a params array. @@ -319,7 +317,7 @@ var sum1 = MethodWithParams(1, 2, 3); // Returns 6 var sum2 = MethodWithParams(new[] { 1, 2 }); // Returns 3 -### MethodWithRef +### MethodWithRef A method with a ref parameter. @@ -339,7 +337,7 @@ public void MethodWithRef(ref int value) This method doubles the input value. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -360,7 +358,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx index 35c89d8..11b163e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase ## Constructors -### .ctor +### .ctor #### Syntax @@ -32,7 +30,7 @@ public DotNetDocsTestBase() ## Properties -### TestContext +### TestContext #### Syntax @@ -46,7 +44,7 @@ Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` ## Methods -### GetTestsDotSharedAssembly +### GetTestsDotSharedAssembly #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx index a47efbd..634bff4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared.SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A sample class for testing documentation generation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A sample class for testing documentation generation. public SampleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -61,7 +59,7 @@ public string Name { get; set; } Type: `string` -### Value +### Value Gets or sets the value. @@ -77,7 +75,7 @@ Type: `int` ## Methods -### DoSomething +### DoSomething Performs a sample operation. @@ -98,7 +96,7 @@ public string DoSomething(string input) Type: `string` The result of the operation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -118,7 +116,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -139,7 +137,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetDisplay +### GetDisplay Gets the display value. @@ -154,7 +152,7 @@ public string GetDisplay() Type: `string` A formatted string containing the name and value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -168,7 +166,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -182,7 +180,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -196,7 +194,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithOptional +### MethodWithOptional Method with optional parameter. @@ -218,7 +216,7 @@ public string MethodWithOptional(string required, int optional = 42) Type: `string` Combined result. -### MethodWithParams +### MethodWithParams Method with params array. @@ -239,7 +237,7 @@ public int MethodWithParams(params int[] values) Type: `int` Sum of values. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -260,7 +258,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx index bde7908..64bbea7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['List', 'System.Collections.Generic.List', 'System.Collections.Generic', 'error'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Collections.dll @@ -29,7 +27,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.coll ## Methods -### AddMultiple +### AddMultiple Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -64,7 +62,7 @@ var numbers = new List<int>() .AddMultiple(1, 2, 3, 4, 5); -### IsNullOrEmpty +### IsNullOrEmpty Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -101,7 +99,7 @@ if (numbers.IsNullOrEmpty()) } -### Shuffle +### Shuffle Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/System.String.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/System.String.mdx index ea18303..f96c342 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/System.String.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/System.String.mdx @@ -6,8 +6,6 @@ tag: "SEALED" keywords: ['String', 'string', 'System', 'class'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Private.CoreLib.dll @@ -30,7 +28,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.stri ## Methods -### Repeat +### Repeat Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` @@ -61,7 +59,7 @@ var result = "ha".Repeat(3); // result = "hahaha" -### Reverse +### Reverse Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx deleted file mode 100644 index bd1d4c9..0000000 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx +++ /dev/null @@ -1,35 +0,0 @@ -/** - * DocsBadge Component for Mintlify Documentation - * - * A customizable badge component that matches Mintlify's design system. - * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). - * - * Usage: - * - * - * - * - * - */ - -export function DocsBadge({ text, variant = 'neutral' }) { - // Tailwind color classes for consistent theming - // Using standard Tailwind colors that work in both light and dark modes - const variantClasses = { - success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', - neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', - info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', - warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', - danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' - }; - - const classes = variantClasses[variant] || variantClasses.neutral; - - return ( - - {text} - - ); -} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx index 2e7efe1..3d76acc 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class tests the IncludedMembers filtering functionality. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class tests the IncludedMembers filtering functionality. public MixedAccessClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### PublicProperty +### PublicProperty Gets or sets the public property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -87,7 +85,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -108,7 +106,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -122,7 +120,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -136,7 +134,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -150,7 +148,7 @@ protected internal object MemberwiseClone() Type: `object` -### PublicMethod +### PublicMethod A public method. @@ -165,7 +163,7 @@ public string PublicMethod() Type: `string` A string indicating this is a public method. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -186,7 +184,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx index bc0e0e1..f0c0cfe 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class serves as the base for DerivedClass. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class serves as the base for DerivedClass. public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Virtual Gets or sets the base property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod A method in the base class. @@ -77,7 +75,7 @@ A method in the base class. public void BaseMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Virtual A virtual method that can be overridden. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx index 34f1e3b..b4a4193 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = obj.Calculate(5, 10); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = obj.Calculate(5, 10); public ClassWithMethods() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Methods -### Calculate +### Calculate Calculates the sum of two numbers. @@ -86,7 +84,7 @@ The sum of a and b. var result = Calculate(3, 4); // Returns 7 -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -106,7 +104,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -127,7 +125,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetConditionalValue +### GetConditionalValue Gets a value based on a condition. @@ -148,7 +146,7 @@ public string GetConditionalValue(bool condition) Type: `string` Returns "Yes" if condition is true, "No" otherwise. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected internal object MemberwiseClone() Type: `object` -### PerformAction +### PerformAction A void method that performs an action. @@ -204,7 +202,7 @@ public void PerformAction() This method doesn't return anything. -### Process +### Process Processes the input string. @@ -235,7 +233,7 @@ The processed string in uppercase. This method performs a simple transformation for testing purposes. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -256,7 +254,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx index 629ebd6..1eed6c1 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains properties with different access modifiers and documentation ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains properties with different access modifiers and documentation public ClassWithProperties() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### Id +### Id Gets the read-only identifier. @@ -69,7 +67,7 @@ Type: `int` This property can only be read, not written to. -### Name +### Name Gets or sets the name. @@ -87,7 +85,7 @@ Type: `string` This is a standard public property with get and set accessors. -### Value +### Value Gets or sets the value with a private setter. @@ -107,7 +105,7 @@ This property can be read publicly but only set within the class. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -127,7 +125,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -148,7 +146,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -211,7 +209,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -225,7 +223,7 @@ public virtual string ToString() Type: `string?` -### UpdateValue +### UpdateValue Updates the value property. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx index a3da30c..59b3996 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = derived.VirtualMethod(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = derived.VirtualMethod(); public DerivedClass() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -56,7 +54,7 @@ public DerivedClass() public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -68,7 +66,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Override Gets or sets the base property with overridden behavior. @@ -86,7 +84,7 @@ Type: `string` This property overrides the base implementation. -### BaseProperty +### BaseProperty Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -102,7 +100,7 @@ public virtual string BaseProperty { get; set; } Type: `string` -### DerivedProperty +### DerivedProperty Gets or sets the derived property. @@ -118,7 +116,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -130,7 +128,7 @@ A method in the base class. public void BaseMethod() ``` -### DerivedMethod +### DerivedMethod An additional method in the derived class. @@ -140,7 +138,7 @@ An additional method in the derived class. public void DerivedMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -160,7 +158,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -209,7 +207,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -223,7 +221,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -244,7 +242,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -258,7 +256,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Override Overrides the virtual method from the base class. @@ -277,7 +275,7 @@ A string indicating the derived implementation. This method provides custom behavior for the derived class. -### VirtualMethod +### VirtualMethod Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx index 5e97dfe..b0f7d27 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'System.IDisposable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ using (var disposable = new DisposableClass()) ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ using (var disposable = new DisposableClass()) public DisposableClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Properties -### ResourceName +### ResourceName Gets or sets the resource name. @@ -76,7 +74,7 @@ Type: `string` ## Methods -### Dispose +### Dispose Disposes the resources used by this instance. @@ -90,7 +88,7 @@ public void Dispose() Implements the IDisposable pattern. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -110,7 +108,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -131,7 +129,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -145,7 +143,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -159,7 +157,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -173,7 +171,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -194,7 +192,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -208,7 +206,7 @@ public virtual string ToString() Type: `string?` -### UseResource +### UseResource Uses the resource. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx index 4223fec..aeb5dd9 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -30,7 +28,7 @@ This interface is used to test extension methods on interfaces and to verify ## Properties -### TestValue +### TestValue Abstract Gets the test value. @@ -46,7 +44,7 @@ Type: `string` ## Methods -### GetFormattedValue +### GetFormattedValue Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` @@ -76,7 +74,7 @@ ITestInterface test = new TestImplementation(); var formatted = test.GetFormattedValue(); -### TestMethod +### TestMethod Abstract Performs a test operation. @@ -86,7 +84,7 @@ Performs a test operation. void TestMethod() ``` -### Validate +### Validate Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx index 6e0634e..20f90ce 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -39,7 +37,7 @@ simple.DoWork(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -47,7 +45,7 @@ simple.DoWork(); public SimpleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -59,7 +57,7 @@ public Object() ## Methods -### DoWork +### DoWork Performs some work. @@ -73,7 +71,7 @@ public void DoWork() This method doesn't actually do anything, but it has documentation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### IsValid +### IsValid Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -169,7 +167,7 @@ True if valid, otherwise false. This is a simple validation extension for demonstration purposes. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -183,7 +181,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -204,7 +202,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToDisplayString +### ToDisplayString Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -234,7 +232,7 @@ var simple = new SimpleClass(); var display = simple.ToDisplayString(); -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx index f0ed2df..80e74bd 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -32,7 +30,7 @@ This class implements ITestInterface to demonstrate interface member inheritance ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class implements ITestInterface to demonstrate interface member inheritance public TestImplementation() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### TestValue +### TestValue Gets the test value. @@ -68,7 +66,7 @@ Type: `string` ## Methods -### AdditionalMethod +### AdditionalMethod An additional method specific to the implementation. @@ -78,7 +76,7 @@ An additional method specific to the implementation. public void AdditionalMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -98,7 +96,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -119,7 +117,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -133,7 +131,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -147,7 +145,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -161,7 +159,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -182,7 +180,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### TestMethod +### TestMethod Performs a test operation. @@ -192,7 +190,7 @@ Performs a test operation. public void TestMethod() ``` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx index 35c89d8..11b163e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase ## Constructors -### .ctor +### .ctor #### Syntax @@ -32,7 +30,7 @@ public DotNetDocsTestBase() ## Properties -### TestContext +### TestContext #### Syntax @@ -46,7 +44,7 @@ Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` ## Methods -### GetTestsDotSharedAssembly +### GetTestsDotSharedAssembly #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx index 561c8db..54c2fd7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ fullDocs.ComplexMethod("test", 42); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ fullDocs.ComplexMethod("test", 42); public ClassWithFullDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Properties -### Value +### Value Gets or sets the value property. @@ -79,7 +77,7 @@ This property stores important data. ## Methods -### ComplexMethod +### ComplexMethod A complex method with full documentation. @@ -133,7 +131,7 @@ Console.WriteLine(result); - `Object[])` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -153,7 +151,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -174,7 +172,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -188,7 +186,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -202,7 +200,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -216,7 +214,7 @@ protected internal object MemberwiseClone() Type: `object` -### ProcessNumbers +### ProcessNumbers Filters and transforms a collection of numbers. @@ -245,7 +243,7 @@ var numbers = Enumerable.Range(1, 10) .ToList(); -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -266,7 +264,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx index 1658ae7..79be5e2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A class with minimal documentation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A class with minimal documentation. public ClassWithMinimalDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -63,7 +61,7 @@ Type: `string` ## Methods -### DoSomething +### DoSomething Does something. @@ -73,7 +71,7 @@ Does something. public void DoSomething() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -156,7 +154,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx index 138b0df..09b9bd5 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs ## Constructors -### .ctor +### .ctor #### Syntax @@ -30,7 +28,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs public ClassWithNoDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -42,7 +40,7 @@ public Object() ## Properties -### UndocumentedProperty +### UndocumentedProperty #### Syntax @@ -56,7 +54,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -76,7 +74,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -97,7 +95,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -111,7 +109,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -125,7 +123,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -139,7 +137,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -160,7 +158,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -174,7 +172,7 @@ public virtual string ToString() Type: `string?` -### UndocumentedMethod +### UndocumentedMethod #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx index d23fa11..d99e1a2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ if (x > 0 && y < 10) { } ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ if (x > 0 && y < 10) { } public ClassWithSpecialCharacters() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -80,7 +78,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -101,7 +99,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -115,7 +113,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -129,7 +127,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -143,7 +141,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithSpecialChars +### MethodWithSpecialChars A method with special characters in docs: <T> generics. @@ -168,7 +166,7 @@ A string with & ampersands. This method handles <, >, & characters properly. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -189,7 +187,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx index 1d3fe8e..881ca58 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx index bef9fb6..be78bf2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx index 70a414d..11d13cf 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx index edac5c1..fe806ef 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx index 9955a4a..ad41304 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains methods with different parameter modifiers and types. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains methods with different parameter modifiers and types. public ParameterVariations() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -71,7 +69,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -92,7 +90,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GenericMethod +### GenericMethod A generic method with a type parameter. @@ -124,7 +122,7 @@ var result1 = GenericMethod<int>(42); var result2 = GenericMethod("hello"); -### GenericMethodWithMultipleTypes +### GenericMethodWithMultipleTypes A method with multiple generic type parameters. @@ -151,7 +149,7 @@ A key-value pair. - `TKey` - The type of the key. - `TValue` - The type of the value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -179,7 +177,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -193,7 +191,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithConstraints +### MethodWithConstraints A method demonstrating parameter constraints. @@ -218,7 +216,7 @@ The type name of the item. - `T` - The type parameter constrained to class types. -### MethodWithNullables +### MethodWithNullables A method with nullable parameters. @@ -240,7 +238,7 @@ public string MethodWithNullables(System.Nullable nullableInt, string nulla Type: `string` A description of the provided values. -### MethodWithOptionalParam +### MethodWithOptionalParam A method with an optional parameter. @@ -269,7 +267,7 @@ var result1 = MethodWithOptionalParam("test"); // Uses default value 42 var result2 = MethodWithOptionalParam("test", 100); // Uses provided value -### MethodWithOut +### MethodWithOut A method with an out parameter. @@ -291,7 +289,7 @@ public bool MethodWithOut(string input, out int value) Type: `bool` true if the parsing was successful; otherwise, false. -### MethodWithParams +### MethodWithParams A method with a params array. @@ -319,7 +317,7 @@ var sum1 = MethodWithParams(1, 2, 3); // Returns 6 var sum2 = MethodWithParams(new[] { 1, 2 }); // Returns 3 -### MethodWithRef +### MethodWithRef A method with a ref parameter. @@ -339,7 +337,7 @@ public void MethodWithRef(ref int value) This method doubles the input value. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -360,7 +358,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx index a47efbd..634bff4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared.SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A sample class for testing documentation generation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A sample class for testing documentation generation. public SampleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -61,7 +59,7 @@ public string Name { get; set; } Type: `string` -### Value +### Value Gets or sets the value. @@ -77,7 +75,7 @@ Type: `int` ## Methods -### DoSomething +### DoSomething Performs a sample operation. @@ -98,7 +96,7 @@ public string DoSomething(string input) Type: `string` The result of the operation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -118,7 +116,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -139,7 +137,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetDisplay +### GetDisplay Gets the display value. @@ -154,7 +152,7 @@ public string GetDisplay() Type: `string` A formatted string containing the name and value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -168,7 +166,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -182,7 +180,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -196,7 +194,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithOptional +### MethodWithOptional Method with optional parameter. @@ -218,7 +216,7 @@ public string MethodWithOptional(string required, int optional = 42) Type: `string` Combined result. -### MethodWithParams +### MethodWithParams Method with params array. @@ -239,7 +237,7 @@ public int MethodWithParams(params int[] values) Type: `int` Sum of values. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -260,7 +258,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx index bde7908..64bbea7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['List', 'System.Collections.Generic.List', 'System.Collections.Generic', 'error'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Collections.dll @@ -29,7 +27,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.coll ## Methods -### AddMultiple +### AddMultiple Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -64,7 +62,7 @@ var numbers = new List<int>() .AddMultiple(1, 2, 3, 4, 5); -### IsNullOrEmpty +### IsNullOrEmpty Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -101,7 +99,7 @@ if (numbers.IsNullOrEmpty()) } -### Shuffle +### Shuffle Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/System/String.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/System/String.mdx index ea18303..f96c342 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/System/String.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/System/String.mdx @@ -6,8 +6,6 @@ tag: "SEALED" keywords: ['String', 'string', 'System', 'class'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Private.CoreLib.dll @@ -30,7 +28,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.stri ## Methods -### Repeat +### Repeat Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` @@ -61,7 +59,7 @@ var result = "ha".Repeat(3); // result = "hahaha" -### Reverse +### Reverse Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx deleted file mode 100644 index bd1d4c9..0000000 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net10.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx +++ /dev/null @@ -1,35 +0,0 @@ -/** - * DocsBadge Component for Mintlify Documentation - * - * A customizable badge component that matches Mintlify's design system. - * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). - * - * Usage: - * - * - * - * - * - */ - -export function DocsBadge({ text, variant = 'neutral' }) { - // Tailwind color classes for consistent theming - // Using standard Tailwind colors that work in both light and dark modes - const variantClasses = { - success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', - neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', - info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', - warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', - danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' - }; - - const classes = variantClasses[variant] || variantClasses.neutral; - - return ( - - {text} - - ); -} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx index df6415c..dd54ef4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class tests the IncludedMembers filtering functionality. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class tests the IncludedMembers filtering functionality. public MixedAccessClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### PublicProperty +### PublicProperty Gets or sets the public property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -87,7 +85,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -108,7 +106,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -122,7 +120,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -136,7 +134,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -150,7 +148,7 @@ protected object MemberwiseClone() Type: `object` -### PublicMethod +### PublicMethod A public method. @@ -165,7 +163,7 @@ public string PublicMethod() Type: `string` A string indicating this is a public method. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -186,7 +184,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx index a7aeab4..199095e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class serves as the base for DerivedClass. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class serves as the base for DerivedClass. public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Virtual Gets or sets the base property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod A method in the base class. @@ -77,7 +75,7 @@ A method in the base class. public void BaseMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Virtual A virtual method that can be overridden. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx index 4dc51fe..c6aa7a8 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = obj.Calculate(5, 10); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = obj.Calculate(5, 10); public ClassWithMethods() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Methods -### Calculate +### Calculate Calculates the sum of two numbers. @@ -86,7 +84,7 @@ The sum of a and b. var result = Calculate(3, 4); // Returns 7 -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -106,7 +104,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -127,7 +125,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetConditionalValue +### GetConditionalValue Gets a value based on a condition. @@ -148,7 +146,7 @@ public string GetConditionalValue(bool condition) Type: `string` Returns "Yes" if condition is true, "No" otherwise. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected object MemberwiseClone() Type: `object` -### PerformAction +### PerformAction A void method that performs an action. @@ -204,7 +202,7 @@ public void PerformAction() This method doesn't return anything. -### Process +### Process Processes the input string. @@ -235,7 +233,7 @@ The processed string in uppercase. This method performs a simple transformation for testing purposes. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -256,7 +254,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx index 6189868..61dc116 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains properties with different access modifiers and documentation ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains properties with different access modifiers and documentation public ClassWithProperties() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### Id +### Id Gets the read-only identifier. @@ -69,7 +67,7 @@ Type: `int` This property can only be read, not written to. -### Name +### Name Gets or sets the name. @@ -87,7 +85,7 @@ Type: `string` This is a standard public property with get and set accessors. -### Value +### Value Gets or sets the value with a private setter. @@ -107,7 +105,7 @@ This property can be read publicly but only set within the class. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -127,7 +125,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -148,7 +146,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -211,7 +209,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -225,7 +223,7 @@ public virtual string ToString() Type: `string?` -### UpdateValue +### UpdateValue Updates the value property. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx index f86e276..efbedb4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = derived.VirtualMethod(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = derived.VirtualMethod(); public DerivedClass() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -56,7 +54,7 @@ public DerivedClass() public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -68,7 +66,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Override Gets or sets the base property with overridden behavior. @@ -86,7 +84,7 @@ Type: `string` This property overrides the base implementation. -### BaseProperty +### BaseProperty Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -102,7 +100,7 @@ public virtual string BaseProperty { get; set; } Type: `string` -### DerivedProperty +### DerivedProperty Gets or sets the derived property. @@ -118,7 +116,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -130,7 +128,7 @@ A method in the base class. public void BaseMethod() ``` -### DerivedMethod +### DerivedMethod An additional method in the derived class. @@ -140,7 +138,7 @@ An additional method in the derived class. public void DerivedMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -160,7 +158,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -209,7 +207,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -223,7 +221,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -244,7 +242,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -258,7 +256,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Override Overrides the virtual method from the base class. @@ -277,7 +275,7 @@ A string indicating the derived implementation. This method provides custom behavior for the derived class. -### VirtualMethod +### VirtualMethod Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx index 2483217..2958cb6 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'System.IDisposable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ using (var disposable = new DisposableClass()) ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ using (var disposable = new DisposableClass()) public DisposableClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Properties -### ResourceName +### ResourceName Gets or sets the resource name. @@ -76,7 +74,7 @@ Type: `string` ## Methods -### Dispose +### Dispose Disposes the resources used by this instance. @@ -90,7 +88,7 @@ public void Dispose() Implements the IDisposable pattern. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -110,7 +108,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -131,7 +129,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -145,7 +143,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -159,7 +157,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -173,7 +171,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -194,7 +192,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -208,7 +206,7 @@ public virtual string ToString() Type: `string?` -### UseResource +### UseResource Uses the resource. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx index 4223fec..aeb5dd9 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -30,7 +28,7 @@ This interface is used to test extension methods on interfaces and to verify ## Properties -### TestValue +### TestValue Abstract Gets the test value. @@ -46,7 +44,7 @@ Type: `string` ## Methods -### GetFormattedValue +### GetFormattedValue Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` @@ -76,7 +74,7 @@ ITestInterface test = new TestImplementation(); var formatted = test.GetFormattedValue(); -### TestMethod +### TestMethod Abstract Performs a test operation. @@ -86,7 +84,7 @@ Performs a test operation. void TestMethod() ``` -### Validate +### Validate Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx index ce1893f..1d00087 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -39,7 +37,7 @@ simple.DoWork(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -47,7 +45,7 @@ simple.DoWork(); public SimpleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -59,7 +57,7 @@ public Object() ## Methods -### DoWork +### DoWork Performs some work. @@ -73,7 +71,7 @@ public void DoWork() This method doesn't actually do anything, but it has documentation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### IsValid +### IsValid Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -169,7 +167,7 @@ True if valid, otherwise false. This is a simple validation extension for demonstration purposes. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -183,7 +181,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -204,7 +202,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToDisplayString +### ToDisplayString Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -234,7 +232,7 @@ var simple = new SimpleClass(); var display = simple.ToDisplayString(); -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx index ee4f228..b2d560a 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -32,7 +30,7 @@ This class implements ITestInterface to demonstrate interface member inheritance ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class implements ITestInterface to demonstrate interface member inheritance public TestImplementation() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### TestValue +### TestValue Gets the test value. @@ -68,7 +66,7 @@ Type: `string` ## Methods -### AdditionalMethod +### AdditionalMethod An additional method specific to the implementation. @@ -78,7 +76,7 @@ An additional method specific to the implementation. public void AdditionalMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -98,7 +96,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -119,7 +117,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -133,7 +131,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -147,7 +145,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -161,7 +159,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -182,7 +180,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### TestMethod +### TestMethod Performs a test operation. @@ -192,7 +190,7 @@ Performs a test operation. public void TestMethod() ``` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx index 9fce904..f17d0d9 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ fullDocs.ComplexMethod("test", 42); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ fullDocs.ComplexMethod("test", 42); public ClassWithFullDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Properties -### Value +### Value Gets or sets the value property. @@ -79,7 +77,7 @@ This property stores important data. ## Methods -### ComplexMethod +### ComplexMethod A complex method with full documentation. @@ -133,7 +131,7 @@ Console.WriteLine(result); - `Object[])` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -153,7 +151,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -174,7 +172,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -188,7 +186,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -202,7 +200,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -216,7 +214,7 @@ protected object MemberwiseClone() Type: `object` -### ProcessNumbers +### ProcessNumbers Filters and transforms a collection of numbers. @@ -245,7 +243,7 @@ var numbers = Enumerable.Range(1, 10) .ToList(); -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -266,7 +264,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx index 459560f..dca3ce5 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A class with minimal documentation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A class with minimal documentation. public ClassWithMinimalDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -63,7 +61,7 @@ Type: `string` ## Methods -### DoSomething +### DoSomething Does something. @@ -73,7 +71,7 @@ Does something. public void DoSomething() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -156,7 +154,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx index c23c3cd..1a4182f 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs ## Constructors -### .ctor +### .ctor #### Syntax @@ -30,7 +28,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs public ClassWithNoDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -42,7 +40,7 @@ public Object() ## Properties -### UndocumentedProperty +### UndocumentedProperty #### Syntax @@ -56,7 +54,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -76,7 +74,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -97,7 +95,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -111,7 +109,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -125,7 +123,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -139,7 +137,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -160,7 +158,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -174,7 +172,7 @@ public virtual string ToString() Type: `string?` -### UndocumentedMethod +### UndocumentedMethod #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx index e725d8e..b945cd4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ if (x > 0 && y < 10) { } ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ if (x > 0 && y < 10) { } public ClassWithSpecialCharacters() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -80,7 +78,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -101,7 +99,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -115,7 +113,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -129,7 +127,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -143,7 +141,7 @@ protected object MemberwiseClone() Type: `object` -### MethodWithSpecialChars +### MethodWithSpecialChars A method with special characters in docs: <T> generics. @@ -168,7 +166,7 @@ A string with & ampersands. This method handles <, >, & characters properly. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -189,7 +187,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx index 1d3fe8e..881ca58 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx index bef9fb6..be78bf2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx index 70a414d..11d13cf 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx index edac5c1..fe806ef 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx index a21bcd4..962105c 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains methods with different parameter modifiers and types. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains methods with different parameter modifiers and types. public ParameterVariations() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -71,7 +69,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -92,7 +90,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GenericMethod +### GenericMethod A generic method with a type parameter. @@ -124,7 +122,7 @@ var result1 = GenericMethod<int>(42); var result2 = GenericMethod("hello"); -### GenericMethodWithMultipleTypes +### GenericMethodWithMultipleTypes A method with multiple generic type parameters. @@ -151,7 +149,7 @@ A key-value pair. - `TKey` - The type of the key. - `TValue` - The type of the value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -179,7 +177,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -193,7 +191,7 @@ protected object MemberwiseClone() Type: `object` -### MethodWithConstraints +### MethodWithConstraints A method demonstrating parameter constraints. @@ -218,7 +216,7 @@ The type name of the item. - `T` - The type parameter constrained to class types. -### MethodWithNullables +### MethodWithNullables A method with nullable parameters. @@ -240,7 +238,7 @@ public string MethodWithNullables(System.Nullable nullableInt, string nulla Type: `string` A description of the provided values. -### MethodWithOptionalParam +### MethodWithOptionalParam A method with an optional parameter. @@ -269,7 +267,7 @@ var result1 = MethodWithOptionalParam("test"); // Uses default value 42 var result2 = MethodWithOptionalParam("test", 100); // Uses provided value -### MethodWithOut +### MethodWithOut A method with an out parameter. @@ -291,7 +289,7 @@ public bool MethodWithOut(string input, out int value) Type: `bool` true if the parsing was successful; otherwise, false. -### MethodWithParams +### MethodWithParams A method with a params array. @@ -319,7 +317,7 @@ var sum1 = MethodWithParams(1, 2, 3); // Returns 6 var sum2 = MethodWithParams(new[] { 1, 2 }); // Returns 3 -### MethodWithRef +### MethodWithRef A method with a ref parameter. @@ -339,7 +337,7 @@ public void MethodWithRef(ref int value) This method doubles the input value. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -360,7 +358,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx index 35c89d8..11b163e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase ## Constructors -### .ctor +### .ctor #### Syntax @@ -32,7 +30,7 @@ public DotNetDocsTestBase() ## Properties -### TestContext +### TestContext #### Syntax @@ -46,7 +44,7 @@ Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` ## Methods -### GetTestsDotSharedAssembly +### GetTestsDotSharedAssembly #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx index 60dcc63..ae429bf 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared.SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A sample class for testing documentation generation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A sample class for testing documentation generation. public SampleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -61,7 +59,7 @@ public string Name { get; set; } Type: `string` -### Value +### Value Gets or sets the value. @@ -77,7 +75,7 @@ Type: `int` ## Methods -### DoSomething +### DoSomething Performs a sample operation. @@ -98,7 +96,7 @@ public string DoSomething(string input) Type: `string` The result of the operation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -118,7 +116,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -139,7 +137,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetDisplay +### GetDisplay Gets the display value. @@ -154,7 +152,7 @@ public string GetDisplay() Type: `string` A formatted string containing the name and value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -168,7 +166,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -182,7 +180,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -196,7 +194,7 @@ protected object MemberwiseClone() Type: `object` -### MethodWithOptional +### MethodWithOptional Method with optional parameter. @@ -218,7 +216,7 @@ public string MethodWithOptional(string required, int optional = 42) Type: `string` Combined result. -### MethodWithParams +### MethodWithParams Method with params array. @@ -239,7 +237,7 @@ public int MethodWithParams(params int[] values) Type: `int` Sum of values. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -260,7 +258,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx index bde7908..64bbea7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['List', 'System.Collections.Generic.List', 'System.Collections.Generic', 'error'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Collections.dll @@ -29,7 +27,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.coll ## Methods -### AddMultiple +### AddMultiple Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -64,7 +62,7 @@ var numbers = new List<int>() .AddMultiple(1, 2, 3, 4, 5); -### IsNullOrEmpty +### IsNullOrEmpty Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -101,7 +99,7 @@ if (numbers.IsNullOrEmpty()) } -### Shuffle +### Shuffle Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/System.String.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/System.String.mdx index ea18303..f96c342 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/System.String.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/System.String.mdx @@ -6,8 +6,6 @@ tag: "SEALED" keywords: ['String', 'string', 'System', 'class'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Private.CoreLib.dll @@ -30,7 +28,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.stri ## Methods -### Repeat +### Repeat Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` @@ -61,7 +59,7 @@ var result = "ha".Repeat(3); // result = "hahaha" -### Reverse +### Reverse Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx deleted file mode 100644 index bd1d4c9..0000000 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx +++ /dev/null @@ -1,35 +0,0 @@ -/** - * DocsBadge Component for Mintlify Documentation - * - * A customizable badge component that matches Mintlify's design system. - * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). - * - * Usage: - * - * - * - * - * - */ - -export function DocsBadge({ text, variant = 'neutral' }) { - // Tailwind color classes for consistent theming - // Using standard Tailwind colors that work in both light and dark modes - const variantClasses = { - success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', - neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', - info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', - warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', - danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' - }; - - const classes = variantClasses[variant] || variantClasses.neutral; - - return ( - - {text} - - ); -} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx index df6415c..dd54ef4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class tests the IncludedMembers filtering functionality. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class tests the IncludedMembers filtering functionality. public MixedAccessClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### PublicProperty +### PublicProperty Gets or sets the public property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -87,7 +85,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -108,7 +106,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -122,7 +120,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -136,7 +134,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -150,7 +148,7 @@ protected object MemberwiseClone() Type: `object` -### PublicMethod +### PublicMethod A public method. @@ -165,7 +163,7 @@ public string PublicMethod() Type: `string` A string indicating this is a public method. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -186,7 +184,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx index a7aeab4..199095e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class serves as the base for DerivedClass. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class serves as the base for DerivedClass. public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Virtual Gets or sets the base property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod A method in the base class. @@ -77,7 +75,7 @@ A method in the base class. public void BaseMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Virtual A virtual method that can be overridden. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx index 4dc51fe..c6aa7a8 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = obj.Calculate(5, 10); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = obj.Calculate(5, 10); public ClassWithMethods() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Methods -### Calculate +### Calculate Calculates the sum of two numbers. @@ -86,7 +84,7 @@ The sum of a and b. var result = Calculate(3, 4); // Returns 7 -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -106,7 +104,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -127,7 +125,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetConditionalValue +### GetConditionalValue Gets a value based on a condition. @@ -148,7 +146,7 @@ public string GetConditionalValue(bool condition) Type: `string` Returns "Yes" if condition is true, "No" otherwise. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected object MemberwiseClone() Type: `object` -### PerformAction +### PerformAction A void method that performs an action. @@ -204,7 +202,7 @@ public void PerformAction() This method doesn't return anything. -### Process +### Process Processes the input string. @@ -235,7 +233,7 @@ The processed string in uppercase. This method performs a simple transformation for testing purposes. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -256,7 +254,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx index 6189868..61dc116 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains properties with different access modifiers and documentation ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains properties with different access modifiers and documentation public ClassWithProperties() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### Id +### Id Gets the read-only identifier. @@ -69,7 +67,7 @@ Type: `int` This property can only be read, not written to. -### Name +### Name Gets or sets the name. @@ -87,7 +85,7 @@ Type: `string` This is a standard public property with get and set accessors. -### Value +### Value Gets or sets the value with a private setter. @@ -107,7 +105,7 @@ This property can be read publicly but only set within the class. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -127,7 +125,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -148,7 +146,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -211,7 +209,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -225,7 +223,7 @@ public virtual string ToString() Type: `string?` -### UpdateValue +### UpdateValue Updates the value property. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx index f86e276..efbedb4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = derived.VirtualMethod(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = derived.VirtualMethod(); public DerivedClass() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -56,7 +54,7 @@ public DerivedClass() public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -68,7 +66,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Override Gets or sets the base property with overridden behavior. @@ -86,7 +84,7 @@ Type: `string` This property overrides the base implementation. -### BaseProperty +### BaseProperty Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -102,7 +100,7 @@ public virtual string BaseProperty { get; set; } Type: `string` -### DerivedProperty +### DerivedProperty Gets or sets the derived property. @@ -118,7 +116,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -130,7 +128,7 @@ A method in the base class. public void BaseMethod() ``` -### DerivedMethod +### DerivedMethod An additional method in the derived class. @@ -140,7 +138,7 @@ An additional method in the derived class. public void DerivedMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -160,7 +158,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -209,7 +207,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -223,7 +221,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -244,7 +242,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -258,7 +256,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Override Overrides the virtual method from the base class. @@ -277,7 +275,7 @@ A string indicating the derived implementation. This method provides custom behavior for the derived class. -### VirtualMethod +### VirtualMethod Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx index 2483217..2958cb6 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'System.IDisposable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ using (var disposable = new DisposableClass()) ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ using (var disposable = new DisposableClass()) public DisposableClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Properties -### ResourceName +### ResourceName Gets or sets the resource name. @@ -76,7 +74,7 @@ Type: `string` ## Methods -### Dispose +### Dispose Disposes the resources used by this instance. @@ -90,7 +88,7 @@ public void Dispose() Implements the IDisposable pattern. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -110,7 +108,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -131,7 +129,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -145,7 +143,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -159,7 +157,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -173,7 +171,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -194,7 +192,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -208,7 +206,7 @@ public virtual string ToString() Type: `string?` -### UseResource +### UseResource Uses the resource. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx index 4223fec..aeb5dd9 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -30,7 +28,7 @@ This interface is used to test extension methods on interfaces and to verify ## Properties -### TestValue +### TestValue Abstract Gets the test value. @@ -46,7 +44,7 @@ Type: `string` ## Methods -### GetFormattedValue +### GetFormattedValue Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` @@ -76,7 +74,7 @@ ITestInterface test = new TestImplementation(); var formatted = test.GetFormattedValue(); -### TestMethod +### TestMethod Abstract Performs a test operation. @@ -86,7 +84,7 @@ Performs a test operation. void TestMethod() ``` -### Validate +### Validate Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx index ce1893f..1d00087 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -39,7 +37,7 @@ simple.DoWork(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -47,7 +45,7 @@ simple.DoWork(); public SimpleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -59,7 +57,7 @@ public Object() ## Methods -### DoWork +### DoWork Performs some work. @@ -73,7 +71,7 @@ public void DoWork() This method doesn't actually do anything, but it has documentation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### IsValid +### IsValid Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -169,7 +167,7 @@ True if valid, otherwise false. This is a simple validation extension for demonstration purposes. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -183,7 +181,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -204,7 +202,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToDisplayString +### ToDisplayString Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -234,7 +232,7 @@ var simple = new SimpleClass(); var display = simple.ToDisplayString(); -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx index ee4f228..b2d560a 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -32,7 +30,7 @@ This class implements ITestInterface to demonstrate interface member inheritance ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class implements ITestInterface to demonstrate interface member inheritance public TestImplementation() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### TestValue +### TestValue Gets the test value. @@ -68,7 +66,7 @@ Type: `string` ## Methods -### AdditionalMethod +### AdditionalMethod An additional method specific to the implementation. @@ -78,7 +76,7 @@ An additional method specific to the implementation. public void AdditionalMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -98,7 +96,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -119,7 +117,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -133,7 +131,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -147,7 +145,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -161,7 +159,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -182,7 +180,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### TestMethod +### TestMethod Performs a test operation. @@ -192,7 +190,7 @@ Performs a test operation. public void TestMethod() ``` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx index 35c89d8..11b163e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase ## Constructors -### .ctor +### .ctor #### Syntax @@ -32,7 +30,7 @@ public DotNetDocsTestBase() ## Properties -### TestContext +### TestContext #### Syntax @@ -46,7 +44,7 @@ Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` ## Methods -### GetTestsDotSharedAssembly +### GetTestsDotSharedAssembly #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx index 9fce904..f17d0d9 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ fullDocs.ComplexMethod("test", 42); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ fullDocs.ComplexMethod("test", 42); public ClassWithFullDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Properties -### Value +### Value Gets or sets the value property. @@ -79,7 +77,7 @@ This property stores important data. ## Methods -### ComplexMethod +### ComplexMethod A complex method with full documentation. @@ -133,7 +131,7 @@ Console.WriteLine(result); - `Object[])` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -153,7 +151,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -174,7 +172,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -188,7 +186,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -202,7 +200,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -216,7 +214,7 @@ protected object MemberwiseClone() Type: `object` -### ProcessNumbers +### ProcessNumbers Filters and transforms a collection of numbers. @@ -245,7 +243,7 @@ var numbers = Enumerable.Range(1, 10) .ToList(); -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -266,7 +264,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx index 459560f..dca3ce5 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A class with minimal documentation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A class with minimal documentation. public ClassWithMinimalDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -63,7 +61,7 @@ Type: `string` ## Methods -### DoSomething +### DoSomething Does something. @@ -73,7 +71,7 @@ Does something. public void DoSomething() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -156,7 +154,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx index c23c3cd..1a4182f 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs ## Constructors -### .ctor +### .ctor #### Syntax @@ -30,7 +28,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs public ClassWithNoDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -42,7 +40,7 @@ public Object() ## Properties -### UndocumentedProperty +### UndocumentedProperty #### Syntax @@ -56,7 +54,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -76,7 +74,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -97,7 +95,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -111,7 +109,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -125,7 +123,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -139,7 +137,7 @@ protected object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -160,7 +158,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -174,7 +172,7 @@ public virtual string ToString() Type: `string?` -### UndocumentedMethod +### UndocumentedMethod #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx index e725d8e..b945cd4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ if (x > 0 && y < 10) { } ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ if (x > 0 && y < 10) { } public ClassWithSpecialCharacters() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -80,7 +78,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -101,7 +99,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -115,7 +113,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -129,7 +127,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -143,7 +141,7 @@ protected object MemberwiseClone() Type: `object` -### MethodWithSpecialChars +### MethodWithSpecialChars A method with special characters in docs: <T> generics. @@ -168,7 +166,7 @@ A string with & ampersands. This method handles <, >, & characters properly. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -189,7 +187,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx index 1d3fe8e..881ca58 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx index bef9fb6..be78bf2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx index 70a414d..11d13cf 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx index edac5c1..fe806ef 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx index a21bcd4..962105c 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains methods with different parameter modifiers and types. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains methods with different parameter modifiers and types. public ParameterVariations() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -71,7 +69,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -92,7 +90,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GenericMethod +### GenericMethod A generic method with a type parameter. @@ -124,7 +122,7 @@ var result1 = GenericMethod<int>(42); var result2 = GenericMethod("hello"); -### GenericMethodWithMultipleTypes +### GenericMethodWithMultipleTypes A method with multiple generic type parameters. @@ -151,7 +149,7 @@ A key-value pair. - `TKey` - The type of the key. - `TValue` - The type of the value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -179,7 +177,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -193,7 +191,7 @@ protected object MemberwiseClone() Type: `object` -### MethodWithConstraints +### MethodWithConstraints A method demonstrating parameter constraints. @@ -218,7 +216,7 @@ The type name of the item. - `T` - The type parameter constrained to class types. -### MethodWithNullables +### MethodWithNullables A method with nullable parameters. @@ -240,7 +238,7 @@ public string MethodWithNullables(System.Nullable nullableInt, string nulla Type: `string` A description of the provided values. -### MethodWithOptionalParam +### MethodWithOptionalParam A method with an optional parameter. @@ -269,7 +267,7 @@ var result1 = MethodWithOptionalParam("test"); // Uses default value 42 var result2 = MethodWithOptionalParam("test", 100); // Uses provided value -### MethodWithOut +### MethodWithOut A method with an out parameter. @@ -291,7 +289,7 @@ public bool MethodWithOut(string input, out int value) Type: `bool` true if the parsing was successful; otherwise, false. -### MethodWithParams +### MethodWithParams A method with a params array. @@ -319,7 +317,7 @@ var sum1 = MethodWithParams(1, 2, 3); // Returns 6 var sum2 = MethodWithParams(new[] { 1, 2 }); // Returns 3 -### MethodWithRef +### MethodWithRef A method with a ref parameter. @@ -339,7 +337,7 @@ public void MethodWithRef(ref int value) This method doubles the input value. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -360,7 +358,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx index 60dcc63..ae429bf 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared.SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A sample class for testing documentation generation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A sample class for testing documentation generation. public SampleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -61,7 +59,7 @@ public string Name { get; set; } Type: `string` -### Value +### Value Gets or sets the value. @@ -77,7 +75,7 @@ Type: `int` ## Methods -### DoSomething +### DoSomething Performs a sample operation. @@ -98,7 +96,7 @@ public string DoSomething(string input) Type: `string` The result of the operation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -118,7 +116,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -139,7 +137,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetDisplay +### GetDisplay Gets the display value. @@ -154,7 +152,7 @@ public string GetDisplay() Type: `string` A formatted string containing the name and value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -168,7 +166,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -182,7 +180,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -196,7 +194,7 @@ protected object MemberwiseClone() Type: `object` -### MethodWithOptional +### MethodWithOptional Method with optional parameter. @@ -218,7 +216,7 @@ public string MethodWithOptional(string required, int optional = 42) Type: `string` Combined result. -### MethodWithParams +### MethodWithParams Method with params array. @@ -239,7 +237,7 @@ public int MethodWithParams(params int[] values) Type: `int` Sum of values. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -260,7 +258,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx index bde7908..64bbea7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['List', 'System.Collections.Generic.List', 'System.Collections.Generic', 'error'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Collections.dll @@ -29,7 +27,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.coll ## Methods -### AddMultiple +### AddMultiple Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -64,7 +62,7 @@ var numbers = new List<int>() .AddMultiple(1, 2, 3, 4, 5); -### IsNullOrEmpty +### IsNullOrEmpty Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -101,7 +99,7 @@ if (numbers.IsNullOrEmpty()) } -### Shuffle +### Shuffle Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/System/String.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/System/String.mdx index ea18303..f96c342 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/System/String.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/System/String.mdx @@ -6,8 +6,6 @@ tag: "SEALED" keywords: ['String', 'string', 'System', 'class'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Private.CoreLib.dll @@ -30,7 +28,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.stri ## Methods -### Repeat +### Repeat Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` @@ -61,7 +59,7 @@ var result = "ha".Repeat(3); // result = "hahaha" -### Reverse +### Reverse Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx deleted file mode 100644 index bd1d4c9..0000000 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net8.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx +++ /dev/null @@ -1,35 +0,0 @@ -/** - * DocsBadge Component for Mintlify Documentation - * - * A customizable badge component that matches Mintlify's design system. - * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). - * - * Usage: - * - * - * - * - * - */ - -export function DocsBadge({ text, variant = 'neutral' }) { - // Tailwind color classes for consistent theming - // Using standard Tailwind colors that work in both light and dark modes - const variantClasses = { - success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', - neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', - info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', - warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', - danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' - }; - - const classes = variantClasses[variant] || variantClasses.neutral; - - return ( - - {text} - - ); -} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx index 2e7efe1..3d76acc 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-AccessModifiers.MixedAccessClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class tests the IncludedMembers filtering functionality. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class tests the IncludedMembers filtering functionality. public MixedAccessClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### PublicProperty +### PublicProperty Gets or sets the public property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -87,7 +85,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -108,7 +106,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -122,7 +120,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -136,7 +134,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -150,7 +148,7 @@ protected internal object MemberwiseClone() Type: `object` -### PublicMethod +### PublicMethod A public method. @@ -165,7 +163,7 @@ public string PublicMethod() Type: `string` A string indicating this is a public method. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -186,7 +184,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx index bc0e0e1..f0c0cfe 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.BaseClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class serves as the base for DerivedClass. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class serves as the base for DerivedClass. public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Virtual Gets or sets the base property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod A method in the base class. @@ -77,7 +75,7 @@ A method in the base class. public void BaseMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Virtual A virtual method that can be overridden. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx index 34f1e3b..b4a4193 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithMethods.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = obj.Calculate(5, 10); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = obj.Calculate(5, 10); public ClassWithMethods() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Methods -### Calculate +### Calculate Calculates the sum of two numbers. @@ -86,7 +84,7 @@ The sum of a and b. var result = Calculate(3, 4); // Returns 7 -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -106,7 +104,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -127,7 +125,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetConditionalValue +### GetConditionalValue Gets a value based on a condition. @@ -148,7 +146,7 @@ public string GetConditionalValue(bool condition) Type: `string` Returns "Yes" if condition is true, "No" otherwise. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected internal object MemberwiseClone() Type: `object` -### PerformAction +### PerformAction A void method that performs an action. @@ -204,7 +202,7 @@ public void PerformAction() This method doesn't return anything. -### Process +### Process Processes the input string. @@ -235,7 +233,7 @@ The processed string in uppercase. This method performs a simple transformation for testing purposes. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -256,7 +254,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx index 629ebd6..1eed6c1 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ClassWithProperties.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains properties with different access modifiers and documentation ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains properties with different access modifiers and documentation public ClassWithProperties() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### Id +### Id Gets the read-only identifier. @@ -69,7 +67,7 @@ Type: `int` This property can only be read, not written to. -### Name +### Name Gets or sets the name. @@ -87,7 +85,7 @@ Type: `string` This is a standard public property with get and set accessors. -### Value +### Value Gets or sets the value with a private setter. @@ -107,7 +105,7 @@ This property can be read publicly but only set within the class. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -127,7 +125,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -148,7 +146,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -211,7 +209,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -225,7 +223,7 @@ public virtual string ToString() Type: `string?` -### UpdateValue +### UpdateValue Updates the value property. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx index a3da30c..59b3996 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DerivedClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = derived.VirtualMethod(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = derived.VirtualMethod(); public DerivedClass() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -56,7 +54,7 @@ public DerivedClass() public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -68,7 +66,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Override Gets or sets the base property with overridden behavior. @@ -86,7 +84,7 @@ Type: `string` This property overrides the base implementation. -### BaseProperty +### BaseProperty Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -102,7 +100,7 @@ public virtual string BaseProperty { get; set; } Type: `string` -### DerivedProperty +### DerivedProperty Gets or sets the derived property. @@ -118,7 +116,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -130,7 +128,7 @@ A method in the base class. public void BaseMethod() ``` -### DerivedMethod +### DerivedMethod An additional method in the derived class. @@ -140,7 +138,7 @@ An additional method in the derived class. public void DerivedMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -160,7 +158,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -209,7 +207,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -223,7 +221,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -244,7 +242,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -258,7 +256,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Override Overrides the virtual method from the base class. @@ -277,7 +275,7 @@ A string indicating the derived implementation. This method provides custom behavior for the derived class. -### VirtualMethod +### VirtualMethod Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx index 5e97dfe..b0f7d27 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.DisposableClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'System.IDisposable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ using (var disposable = new DisposableClass()) ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ using (var disposable = new DisposableClass()) public DisposableClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Properties -### ResourceName +### ResourceName Gets or sets the resource name. @@ -76,7 +74,7 @@ Type: `string` ## Methods -### Dispose +### Dispose Disposes the resources used by this instance. @@ -90,7 +88,7 @@ public void Dispose() Implements the IDisposable pattern. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -110,7 +108,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -131,7 +129,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -145,7 +143,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -159,7 +157,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -173,7 +171,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -194,7 +192,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -208,7 +206,7 @@ public virtual string ToString() Type: `string?` -### UseResource +### UseResource Uses the resource. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx index 4223fec..aeb5dd9 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.ITestInterface.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -30,7 +28,7 @@ This interface is used to test extension methods on interfaces and to verify ## Properties -### TestValue +### TestValue Abstract Gets the test value. @@ -46,7 +44,7 @@ Type: `string` ## Methods -### GetFormattedValue +### GetFormattedValue Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` @@ -76,7 +74,7 @@ ITestInterface test = new TestImplementation(); var formatted = test.GetFormattedValue(); -### TestMethod +### TestMethod Abstract Performs a test operation. @@ -86,7 +84,7 @@ Performs a test operation. void TestMethod() ``` -### Validate +### Validate Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx index 6e0634e..20f90ce 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.SimpleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -39,7 +37,7 @@ simple.DoWork(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -47,7 +45,7 @@ simple.DoWork(); public SimpleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -59,7 +57,7 @@ public Object() ## Methods -### DoWork +### DoWork Performs some work. @@ -73,7 +71,7 @@ public void DoWork() This method doesn't actually do anything, but it has documentation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### IsValid +### IsValid Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -169,7 +167,7 @@ True if valid, otherwise false. This is a simple validation extension for demonstration purposes. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -183,7 +181,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -204,7 +202,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToDisplayString +### ToDisplayString Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -234,7 +232,7 @@ var simple = new SimpleClass(); var display = simple.ToDisplayString(); -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx index f0ed2df..80e74bd 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-BasicScenarios.TestImplementation.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -32,7 +30,7 @@ This class implements ITestInterface to demonstrate interface member inheritance ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class implements ITestInterface to demonstrate interface member inheritance public TestImplementation() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### TestValue +### TestValue Gets the test value. @@ -68,7 +66,7 @@ Type: `string` ## Methods -### AdditionalMethod +### AdditionalMethod An additional method specific to the implementation. @@ -78,7 +76,7 @@ An additional method specific to the implementation. public void AdditionalMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -98,7 +96,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -119,7 +117,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -133,7 +131,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -147,7 +145,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -161,7 +159,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -182,7 +180,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### TestMethod +### TestMethod Performs a test operation. @@ -192,7 +190,7 @@ Performs a test operation. public void TestMethod() ``` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx index 561c8db..54c2fd7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithFullDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ fullDocs.ComplexMethod("test", 42); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ fullDocs.ComplexMethod("test", 42); public ClassWithFullDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Properties -### Value +### Value Gets or sets the value property. @@ -79,7 +77,7 @@ This property stores important data. ## Methods -### ComplexMethod +### ComplexMethod A complex method with full documentation. @@ -133,7 +131,7 @@ Console.WriteLine(result); - `Object[])` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -153,7 +151,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -174,7 +172,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -188,7 +186,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -202,7 +200,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -216,7 +214,7 @@ protected internal object MemberwiseClone() Type: `object` -### ProcessNumbers +### ProcessNumbers Filters and transforms a collection of numbers. @@ -245,7 +243,7 @@ var numbers = Enumerable.Range(1, 10) .ToList(); -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -266,7 +264,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx index 1658ae7..79be5e2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithMinimalDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A class with minimal documentation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A class with minimal documentation. public ClassWithMinimalDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -63,7 +61,7 @@ Type: `string` ## Methods -### DoSomething +### DoSomething Does something. @@ -73,7 +71,7 @@ Does something. public void DoSomething() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -156,7 +154,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx index 138b0df..09b9bd5 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithNoDocs.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs ## Constructors -### .ctor +### .ctor #### Syntax @@ -30,7 +28,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs public ClassWithNoDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -42,7 +40,7 @@ public Object() ## Properties -### UndocumentedProperty +### UndocumentedProperty #### Syntax @@ -56,7 +54,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -76,7 +74,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -97,7 +95,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -111,7 +109,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -125,7 +123,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -139,7 +137,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -160,7 +158,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -174,7 +172,7 @@ public virtual string ToString() Type: `string?` -### UndocumentedMethod +### UndocumentedMethod #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx index d23fa11..d99e1a2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-EdgeCases.ClassWithSpecialCharacters.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ if (x > 0 && y < 10) { } ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ if (x > 0 && y < 10) { } public ClassWithSpecialCharacters() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -80,7 +78,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -101,7 +99,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -115,7 +113,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -129,7 +127,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -143,7 +141,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithSpecialChars +### MethodWithSpecialChars A method with special characters in docs: <T> generics. @@ -168,7 +166,7 @@ A string with & ampersands. This method handles <, >, & characters properly. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -189,7 +187,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx index 1d3fe8e..881ca58 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.ByteEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx index bef9fb6..be78bf2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.FlagsEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx index 70a414d..11d13cf 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.LongEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx index edac5c1..fe806ef 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Enums.SimpleEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx index 9955a4a..ad41304 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared-Parameters.ParameterVariations.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains methods with different parameter modifiers and types. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains methods with different parameter modifiers and types. public ParameterVariations() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -71,7 +69,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -92,7 +90,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GenericMethod +### GenericMethod A generic method with a type parameter. @@ -124,7 +122,7 @@ var result1 = GenericMethod<int>(42); var result2 = GenericMethod("hello"); -### GenericMethodWithMultipleTypes +### GenericMethodWithMultipleTypes A method with multiple generic type parameters. @@ -151,7 +149,7 @@ A key-value pair. - `TKey` - The type of the key. - `TValue` - The type of the value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -179,7 +177,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -193,7 +191,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithConstraints +### MethodWithConstraints A method demonstrating parameter constraints. @@ -218,7 +216,7 @@ The type name of the item. - `T` - The type parameter constrained to class types. -### MethodWithNullables +### MethodWithNullables A method with nullable parameters. @@ -240,7 +238,7 @@ public string MethodWithNullables(System.Nullable nullableInt, string nulla Type: `string` A description of the provided values. -### MethodWithOptionalParam +### MethodWithOptionalParam A method with an optional parameter. @@ -269,7 +267,7 @@ var result1 = MethodWithOptionalParam("test"); // Uses default value 42 var result2 = MethodWithOptionalParam("test", 100); // Uses provided value -### MethodWithOut +### MethodWithOut A method with an out parameter. @@ -291,7 +289,7 @@ public bool MethodWithOut(string input, out int value) Type: `bool` true if the parsing was successful; otherwise, false. -### MethodWithParams +### MethodWithParams A method with a params array. @@ -319,7 +317,7 @@ var sum1 = MethodWithParams(1, 2, 3); // Returns 6 var sum2 = MethodWithParams(new[] { 1, 2 }); // Returns 3 -### MethodWithRef +### MethodWithRef A method with a ref parameter. @@ -339,7 +337,7 @@ public void MethodWithRef(ref int value) This method doubles the input value. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -360,7 +358,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx index 35c89d8..11b163e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.DotNetDocsTestBase.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase ## Constructors -### .ctor +### .ctor #### Syntax @@ -32,7 +30,7 @@ public DotNetDocsTestBase() ## Properties -### TestContext +### TestContext #### Syntax @@ -46,7 +44,7 @@ Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` ## Methods -### GetTestsDotSharedAssembly +### GetTestsDotSharedAssembly #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx index a47efbd..634bff4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/CloudNimble-DotNetDocs-Tests-Shared.SampleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared.SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A sample class for testing documentation generation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A sample class for testing documentation generation. public SampleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -61,7 +59,7 @@ public string Name { get; set; } Type: `string` -### Value +### Value Gets or sets the value. @@ -77,7 +75,7 @@ Type: `int` ## Methods -### DoSomething +### DoSomething Performs a sample operation. @@ -98,7 +96,7 @@ public string DoSomething(string input) Type: `string` The result of the operation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -118,7 +116,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -139,7 +137,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetDisplay +### GetDisplay Gets the display value. @@ -154,7 +152,7 @@ public string GetDisplay() Type: `string` A formatted string containing the name and value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -168,7 +166,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -182,7 +180,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -196,7 +194,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithOptional +### MethodWithOptional Method with optional parameter. @@ -218,7 +216,7 @@ public string MethodWithOptional(string required, int optional = 42) Type: `string` Combined result. -### MethodWithParams +### MethodWithParams Method with params array. @@ -239,7 +237,7 @@ public int MethodWithParams(params int[] values) Type: `int` Sum of values. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -260,7 +258,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx index bde7908..64bbea7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/System-Collections-Generic.List.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['List', 'System.Collections.Generic.List', 'System.Collections.Generic', 'error'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Collections.dll @@ -29,7 +27,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.coll ## Methods -### AddMultiple +### AddMultiple Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -64,7 +62,7 @@ var numbers = new List<int>() .AddMultiple(1, 2, 3, 4, 5); -### IsNullOrEmpty +### IsNullOrEmpty Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -101,7 +99,7 @@ if (numbers.IsNullOrEmpty()) } -### Shuffle +### Shuffle Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/System.String.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/System.String.mdx index ea18303..f96c342 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/System.String.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/System.String.mdx @@ -6,8 +6,6 @@ tag: "SEALED" keywords: ['String', 'string', 'System', 'class'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Private.CoreLib.dll @@ -30,7 +28,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.stri ## Methods -### Repeat +### Repeat Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` @@ -61,7 +59,7 @@ var result = "ha".Repeat(3); // result = "hahaha" -### Reverse +### Reverse Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx deleted file mode 100644 index bd1d4c9..0000000 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FileMode/snippets/DocsBadge.jsx +++ /dev/null @@ -1,35 +0,0 @@ -/** - * DocsBadge Component for Mintlify Documentation - * - * A customizable badge component that matches Mintlify's design system. - * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). - * - * Usage: - * - * - * - * - * - */ - -export function DocsBadge({ text, variant = 'neutral' }) { - // Tailwind color classes for consistent theming - // Using standard Tailwind colors that work in both light and dark modes - const variantClasses = { - success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', - neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', - info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', - warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', - danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' - }; - - const classes = variantClasses[variant] || variantClasses.neutral; - - return ( - - {text} - - ); -} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx index 2e7efe1..3d76acc 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/AccessModifiers/MixedAccessClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers.MixedAccessClass', 'CloudNimble.DotNetDocs.Tests.Shared.AccessModifiers', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class tests the IncludedMembers filtering functionality. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class tests the IncludedMembers filtering functionality. public MixedAccessClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### PublicProperty +### PublicProperty Gets or sets the public property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -87,7 +85,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -108,7 +106,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -122,7 +120,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -136,7 +134,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -150,7 +148,7 @@ protected internal object MemberwiseClone() Type: `object` -### PublicMethod +### PublicMethod A public method. @@ -165,7 +163,7 @@ public string PublicMethod() Type: `string` A string indicating this is a public method. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -186,7 +184,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx index bc0e0e1..f0c0cfe 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/BaseClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class serves as the base for DerivedClass. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class serves as the base for DerivedClass. public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Virtual Gets or sets the base property. @@ -67,7 +65,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod A method in the base class. @@ -77,7 +75,7 @@ A method in the base class. public void BaseMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -97,7 +95,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -118,7 +116,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -132,7 +130,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -146,7 +144,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -160,7 +158,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Virtual A virtual method that can be overridden. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx index 34f1e3b..b4a4193 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithMethods.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithMethods', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = obj.Calculate(5, 10); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = obj.Calculate(5, 10); public ClassWithMethods() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Methods -### Calculate +### Calculate Calculates the sum of two numbers. @@ -86,7 +84,7 @@ The sum of a and b. var result = Calculate(3, 4); // Returns 7 -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -106,7 +104,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -127,7 +125,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetConditionalValue +### GetConditionalValue Gets a value based on a condition. @@ -148,7 +146,7 @@ public string GetConditionalValue(bool condition) Type: `string` Returns "Yes" if condition is true, "No" otherwise. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected internal object MemberwiseClone() Type: `object` -### PerformAction +### PerformAction A void method that performs an action. @@ -204,7 +202,7 @@ public void PerformAction() This method doesn't return anything. -### Process +### Process Processes the input string. @@ -235,7 +233,7 @@ The processed string in uppercase. This method performs a simple transformation for testing purposes. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -256,7 +254,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx index 629ebd6..1eed6c1 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ClassWithProperties.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ClassWithProperties', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains properties with different access modifiers and documentation ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains properties with different access modifiers and documentation public ClassWithProperties() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Properties -### Id +### Id Gets the read-only identifier. @@ -69,7 +67,7 @@ Type: `int` This property can only be read, not written to. -### Name +### Name Gets or sets the name. @@ -87,7 +85,7 @@ Type: `string` This is a standard public property with get and set accessors. -### Value +### Value Gets or sets the value with a private setter. @@ -107,7 +105,7 @@ This property can be read publicly but only set within the class. ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -127,7 +125,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -148,7 +146,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -162,7 +160,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -176,7 +174,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -190,7 +188,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -211,7 +209,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -225,7 +223,7 @@ public virtual string ToString() Type: `string?` -### UpdateValue +### UpdateValue Updates the value property. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx index a3da30c..59b3996 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DerivedClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DerivedClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ var result = derived.VirtualMethod(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ var result = derived.VirtualMethod(); public DerivedClass() ``` -### .ctor +### .ctor Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -56,7 +54,7 @@ public DerivedClass() public BaseClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -68,7 +66,7 @@ public Object() ## Properties -### BaseProperty +### BaseProperty Override Gets or sets the base property with overridden behavior. @@ -86,7 +84,7 @@ Type: `string` This property overrides the base implementation. -### BaseProperty +### BaseProperty Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -102,7 +100,7 @@ public virtual string BaseProperty { get; set; } Type: `string` -### DerivedProperty +### DerivedProperty Gets or sets the derived property. @@ -118,7 +116,7 @@ Type: `string` ## Methods -### BaseMethod +### BaseMethod Inherited Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` @@ -130,7 +128,7 @@ A method in the base class. public void BaseMethod() ``` -### DerivedMethod +### DerivedMethod An additional method in the derived class. @@ -140,7 +138,7 @@ An additional method in the derived class. public void DerivedMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -160,7 +158,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -181,7 +179,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -195,7 +193,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -209,7 +207,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -223,7 +221,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -244,7 +242,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -258,7 +256,7 @@ public virtual string ToString() Type: `string?` -### VirtualMethod +### VirtualMethod Override Overrides the virtual method from the base class. @@ -277,7 +275,7 @@ A string indicating the derived implementation. This method provides custom behavior for the derived class. -### VirtualMethod +### VirtualMethod Inherited Virtual Inherited from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.BaseClass` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx index 5e97dfe..b0f7d27 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/DisposableClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.DisposableClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'System.IDisposable'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ using (var disposable = new DisposableClass()) ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ using (var disposable = new DisposableClass()) public DisposableClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Properties -### ResourceName +### ResourceName Gets or sets the resource name. @@ -76,7 +74,7 @@ Type: `string` ## Methods -### Dispose +### Dispose Disposes the resources used by this instance. @@ -90,7 +88,7 @@ public void Dispose() Implements the IDisposable pattern. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -110,7 +108,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -131,7 +129,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -145,7 +143,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -159,7 +157,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -173,7 +171,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -194,7 +192,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -208,7 +206,7 @@ public virtual string ToString() Type: `string?` -### UseResource +### UseResource Uses the resource. diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx index 4223fec..aeb5dd9 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/ITestInterface.mdx @@ -5,8 +5,6 @@ icon: plug keywords: ['ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'interface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -30,7 +28,7 @@ This interface is used to test extension methods on interfaces and to verify ## Properties -### TestValue +### TestValue Abstract Gets the test value. @@ -46,7 +44,7 @@ Type: `string` ## Methods -### GetFormattedValue +### GetFormattedValue Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` @@ -76,7 +74,7 @@ ITestInterface test = new TestImplementation(); var formatted = test.GetFormattedValue(); -### TestMethod +### TestMethod Abstract Performs a test operation. @@ -86,7 +84,7 @@ Performs a test operation. void TestMethod() ``` -### Validate +### Validate Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_ITestInterfaceExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx index 6e0634e..20f90ce 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/SimpleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.SimpleClass', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -39,7 +37,7 @@ simple.DoWork(); ## Constructors -### .ctor +### .ctor #### Syntax @@ -47,7 +45,7 @@ simple.DoWork(); public SimpleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -59,7 +57,7 @@ public Object() ## Methods -### DoWork +### DoWork Performs some work. @@ -73,7 +71,7 @@ public void DoWork() This method doesn't actually do anything, but it has documentation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### IsValid +### IsValid Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -169,7 +167,7 @@ True if valid, otherwise false. This is a simple validation extension for demonstration purposes. -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -183,7 +181,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -204,7 +202,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToDisplayString +### ToDisplayString Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestsShared_SimpleClassExtensions` @@ -234,7 +232,7 @@ var simple = new SimpleClass(); var display = simple.ToDisplayString(); -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx index f0ed2df..80e74bd 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/BasicScenarios/TestImplementation.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.TestImplementation', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios', 'class', 'System.Object', 'CloudNimble.DotNetDocs.Tests.Shared.BasicScenarios.ITestInterface'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -32,7 +30,7 @@ This class implements ITestInterface to demonstrate interface member inheritance ## Constructors -### .ctor +### .ctor #### Syntax @@ -40,7 +38,7 @@ This class implements ITestInterface to demonstrate interface member inheritance public TestImplementation() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -52,7 +50,7 @@ public Object() ## Properties -### TestValue +### TestValue Gets the test value. @@ -68,7 +66,7 @@ Type: `string` ## Methods -### AdditionalMethod +### AdditionalMethod An additional method specific to the implementation. @@ -78,7 +76,7 @@ An additional method specific to the implementation. public void AdditionalMethod() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -98,7 +96,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -119,7 +117,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -133,7 +131,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -147,7 +145,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -161,7 +159,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -182,7 +180,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### TestMethod +### TestMethod Performs a test operation. @@ -192,7 +190,7 @@ Performs a test operation. public void TestMethod() ``` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx index 35c89d8..11b163e 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/DotNetDocsTestBase.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'CloudNimble.Breakdance.Extensions.MSTest2.BreakdanceMSTestBase'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.DotNetDocsTestBase ## Constructors -### .ctor +### .ctor #### Syntax @@ -32,7 +30,7 @@ public DotNetDocsTestBase() ## Properties -### TestContext +### TestContext #### Syntax @@ -46,7 +44,7 @@ Type: `Microsoft.VisualStudio.TestTools.UnitTesting.TestContext` ## Methods -### GetTestsDotSharedAssembly +### GetTestsDotSharedAssembly #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx index 561c8db..54c2fd7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithFullDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithFullDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -38,7 +36,7 @@ fullDocs.ComplexMethod("test", 42); ## Constructors -### .ctor +### .ctor #### Syntax @@ -46,7 +44,7 @@ fullDocs.ComplexMethod("test", 42); public ClassWithFullDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -58,7 +56,7 @@ public Object() ## Properties -### Value +### Value Gets or sets the value property. @@ -79,7 +77,7 @@ This property stores important data. ## Methods -### ComplexMethod +### ComplexMethod A complex method with full documentation. @@ -133,7 +131,7 @@ Console.WriteLine(result); - `Object[])` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -153,7 +151,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -174,7 +172,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -188,7 +186,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -202,7 +200,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -216,7 +214,7 @@ protected internal object MemberwiseClone() Type: `object` -### ProcessNumbers +### ProcessNumbers Filters and transforms a collection of numbers. @@ -245,7 +243,7 @@ var numbers = Enumerable.Range(1, 10) .ToList(); -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -266,7 +264,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx index 1658ae7..79be5e2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithMinimalDocs.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithMinimalDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A class with minimal documentation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A class with minimal documentation. public ClassWithMinimalDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -63,7 +61,7 @@ Type: `string` ## Methods -### DoSomething +### DoSomething Does something. @@ -73,7 +71,7 @@ Does something. public void DoSomething() ``` -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -93,7 +91,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -114,7 +112,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -128,7 +126,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -142,7 +140,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -156,7 +154,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -177,7 +175,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx index 138b0df..09b9bd5 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithNoDocs.mdx @@ -4,8 +4,6 @@ icon: file-brackets-curly keywords: ['ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -22,7 +20,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs ## Constructors -### .ctor +### .ctor #### Syntax @@ -30,7 +28,7 @@ CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithNoDocs public ClassWithNoDocs() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -42,7 +40,7 @@ public Object() ## Properties -### UndocumentedProperty +### UndocumentedProperty #### Syntax @@ -56,7 +54,7 @@ Type: `string` ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -76,7 +74,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -97,7 +95,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -111,7 +109,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -125,7 +123,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -139,7 +137,7 @@ protected internal object MemberwiseClone() Type: `object` -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -160,7 +158,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` @@ -174,7 +172,7 @@ public virtual string ToString() Type: `string?` -### UndocumentedMethod +### UndocumentedMethod #### Syntax diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx index d23fa11..d99e1a2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/EdgeCases/ClassWithSpecialCharacters.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases.ClassWithSpecialCharacters', 'CloudNimble.DotNetDocs.Tests.Shared.EdgeCases', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -40,7 +38,7 @@ if (x > 0 && y < 10) { } ## Constructors -### .ctor +### .ctor #### Syntax @@ -48,7 +46,7 @@ if (x > 0 && y < 10) { } public ClassWithSpecialCharacters() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -60,7 +58,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -80,7 +78,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -101,7 +99,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -115,7 +113,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -129,7 +127,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -143,7 +141,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithSpecialChars +### MethodWithSpecialChars A method with special characters in docs: <T> generics. @@ -168,7 +166,7 @@ A string with & ampersands. This method handles <, >, & characters properly. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -189,7 +187,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx index 1d3fe8e..881ca58 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/ByteEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.ByteEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx index bef9fb6..be78bf2 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/FlagsEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.FlagsEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx index 70a414d..11d13cf 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/LongEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.LongEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx index edac5c1..fe806ef 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Enums/SimpleEnum.mdx @@ -6,8 +6,6 @@ tag: "ENUM" keywords: ['SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums.SimpleEnum', 'CloudNimble.DotNetDocs.Tests.Shared.Enums', 'class', 'System.Enum'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx index 9955a4a..ad41304 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/Parameters/ParameterVariations.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters.ParameterVariations', 'CloudNimble.DotNetDocs.Tests.Shared.Parameters', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -31,7 +29,7 @@ This class contains methods with different parameter modifiers and types. ## Constructors -### .ctor +### .ctor #### Syntax @@ -39,7 +37,7 @@ This class contains methods with different parameter modifiers and types. public ParameterVariations() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -51,7 +49,7 @@ public Object() ## Methods -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -71,7 +69,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -92,7 +90,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GenericMethod +### GenericMethod A generic method with a type parameter. @@ -124,7 +122,7 @@ var result1 = GenericMethod<int>(42); var result2 = GenericMethod("hello"); -### GenericMethodWithMultipleTypes +### GenericMethodWithMultipleTypes A method with multiple generic type parameters. @@ -151,7 +149,7 @@ A key-value pair. - `TKey` - The type of the key. - `TValue` - The type of the value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -165,7 +163,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -179,7 +177,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -193,7 +191,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithConstraints +### MethodWithConstraints A method demonstrating parameter constraints. @@ -218,7 +216,7 @@ The type name of the item. - `T` - The type parameter constrained to class types. -### MethodWithNullables +### MethodWithNullables A method with nullable parameters. @@ -240,7 +238,7 @@ public string MethodWithNullables(System.Nullable nullableInt, string nulla Type: `string` A description of the provided values. -### MethodWithOptionalParam +### MethodWithOptionalParam A method with an optional parameter. @@ -269,7 +267,7 @@ var result1 = MethodWithOptionalParam("test"); // Uses default value 42 var result2 = MethodWithOptionalParam("test", 100); // Uses provided value -### MethodWithOut +### MethodWithOut A method with an out parameter. @@ -291,7 +289,7 @@ public bool MethodWithOut(string input, out int value) Type: `bool` true if the parsing was successful; otherwise, false. -### MethodWithParams +### MethodWithParams A method with a params array. @@ -319,7 +317,7 @@ var sum1 = MethodWithParams(1, 2, 3); // Returns 6 var sum2 = MethodWithParams(new[] { 1, 2 }); // Returns 3 -### MethodWithRef +### MethodWithRef A method with a ref parameter. @@ -339,7 +337,7 @@ public void MethodWithRef(ref int value) This method doubles the input value. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -360,7 +358,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx index a47efbd..634bff4 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/CloudNimble/DotNetDocs/Tests/Shared/SampleClass.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared.SampleClass', 'CloudNimble.DotNetDocs.Tests.Shared', 'class', 'System.Object'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** CloudNimble.DotNetDocs.Tests.Shared.dll @@ -27,7 +25,7 @@ A sample class for testing documentation generation. ## Constructors -### .ctor +### .ctor #### Syntax @@ -35,7 +33,7 @@ A sample class for testing documentation generation. public SampleClass() ``` -### .ctor +### .ctor Inherited Inherited from `object` @@ -47,7 +45,7 @@ public Object() ## Properties -### Name +### Name Gets or sets the name. @@ -61,7 +59,7 @@ public string Name { get; set; } Type: `string` -### Value +### Value Gets or sets the value. @@ -77,7 +75,7 @@ Type: `int` ## Methods -### DoSomething +### DoSomething Performs a sample operation. @@ -98,7 +96,7 @@ public string DoSomething(string input) Type: `string` The result of the operation. -### Equals +### Equals Inherited Virtual Inherited from `object` @@ -118,7 +116,7 @@ public virtual bool Equals(object obj) Type: `bool` -### Equals +### Equals Inherited Inherited from `object` @@ -139,7 +137,7 @@ public static bool Equals(object objA, object objB) Type: `bool` -### GetDisplay +### GetDisplay Gets the display value. @@ -154,7 +152,7 @@ public string GetDisplay() Type: `string` A formatted string containing the name and value. -### GetHashCode +### GetHashCode Inherited Virtual Inherited from `object` @@ -168,7 +166,7 @@ public virtual int GetHashCode() Type: `int` -### GetType +### GetType Inherited Inherited from `object` @@ -182,7 +180,7 @@ public System.Type GetType() Type: `System.Type` -### MemberwiseClone +### MemberwiseClone Inherited Inherited from `object` @@ -196,7 +194,7 @@ protected internal object MemberwiseClone() Type: `object` -### MethodWithOptional +### MethodWithOptional Method with optional parameter. @@ -218,7 +216,7 @@ public string MethodWithOptional(string required, int optional = 42) Type: `string` Combined result. -### MethodWithParams +### MethodWithParams Method with params array. @@ -239,7 +237,7 @@ public int MethodWithParams(params int[] values) Type: `int` Sum of values. -### ReferenceEquals +### ReferenceEquals Inherited Inherited from `object` @@ -260,7 +258,7 @@ public static bool ReferenceEquals(object objA, object objB) Type: `bool` -### ToString +### ToString Inherited Virtual Inherited from `object` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx index bde7908..64bbea7 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/System/Collections/Generic/List.mdx @@ -5,8 +5,6 @@ icon: file-brackets-curly keywords: ['List', 'System.Collections.Generic.List', 'System.Collections.Generic', 'error'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Collections.dll @@ -29,7 +27,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.coll ## Methods -### AddMultiple +### AddMultiple Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -64,7 +62,7 @@ var numbers = new List<int>() .AddMultiple(1, 2, 3, 4, 5); -### IsNullOrEmpty +### IsNullOrEmpty Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` @@ -101,7 +99,7 @@ if (numbers.IsNullOrEmpty()) } -### Shuffle +### Shuffle Extension Extension method from `System.Collections.Generic.TestsShared_ListExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/System/String.mdx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/System/String.mdx index ea18303..f96c342 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/System/String.mdx +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/System/String.mdx @@ -6,8 +6,6 @@ tag: "SEALED" keywords: ['String', 'string', 'System', 'class'] --- -import { DocsBadge } from '/snippets/DocsBadge.jsx'; - ## Definition **Assembly:** System.Private.CoreLib.dll @@ -30,7 +28,7 @@ See [Microsoft documentation](https://learn.microsoft.com/dotnet/api/system.stri ## Methods -### Repeat +### Repeat Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` @@ -61,7 +59,7 @@ var result = "ha".Repeat(3); // result = "hahaha" -### Reverse +### Reverse Extension Extension method from `CloudNimble.DotNetDocs.Tests.Shared.Extensions.StringExtensions` diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx deleted file mode 100644 index bd1d4c9..0000000 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Baselines/net9.0/MintlifyRenderer/FolderMode/snippets/DocsBadge.jsx +++ /dev/null @@ -1,35 +0,0 @@ -/** - * DocsBadge Component for Mintlify Documentation - * - * A customizable badge component that matches Mintlify's design system. - * Used to display member provenance (Extension, Inherited, Override, Virtual, Abstract). - * - * Usage: - * - * - * - * - * - */ - -export function DocsBadge({ text, variant = 'neutral' }) { - // Tailwind color classes for consistent theming - // Using standard Tailwind colors that work in both light and dark modes - const variantClasses = { - success: 'mint-bg-green-500/10 mint-text-green-600 dark:mint-text-green-400 mint-border-green-500/20', - neutral: 'mint-bg-slate-500/10 mint-text-slate-600 dark:mint-text-slate-400 mint-border-slate-500/20', - info: 'mint-bg-blue-500/10 mint-text-blue-600 dark:mint-text-blue-400 mint-border-blue-500/20', - warning: 'mint-bg-amber-500/10 mint-text-amber-600 dark:mint-text-amber-400 mint-border-amber-500/20', - danger: 'mint-bg-red-500/10 mint-text-red-600 dark:mint-text-red-400 mint-border-red-500/20' - }; - - const classes = variantClasses[variant] || variantClasses.neutral; - - return ( - - {text} - - ); -} \ No newline at end of file diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/MintlifyDocReferenceHandlerTests.cs b/src/CloudNimble.DotNetDocs.Tests.Mintlify/MintlifyDocReferenceHandlerTests.cs new file mode 100644 index 0000000..b884c0c --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/MintlifyDocReferenceHandlerTests.cs @@ -0,0 +1,458 @@ +using CloudNimble.DotNetDocs.Core; +using CloudNimble.DotNetDocs.Core.Configuration; +using CloudNimble.DotNetDocs.Mintlify; +using CloudNimble.DotNetDocs.Tests.Shared; +using FluentAssertions; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using System; +using System.IO; +using System.Threading.Tasks; + +namespace CloudNimble.DotNetDocs.Tests.Mintlify +{ + + /// + /// Tests for , covering Mintlify-specific + /// content rewriting patterns including ES imports, JSX attributes, and CSS url(). + /// + [TestClass] + public class MintlifyDocReferenceHandlerTests : DotNetDocsTestBase + { + + #region Private Fields + + private string? _tempDirectory; + + #endregion + + #region Test Lifecycle + + [TestInitialize] + public void TestInitialize() + { + _tempDirectory = Path.Combine(Path.GetTempPath(), $"MintlifyDocRefTests_{Guid.NewGuid()}"); + Directory.CreateDirectory(_tempDirectory); + } + + [TestCleanup] + public void TestCleanup() + { + if (_tempDirectory is not null && Directory.Exists(_tempDirectory)) + { + try + { + Directory.Delete(_tempDirectory, recursive: true); + } + catch + { + // Ignore cleanup errors in tests + } + } + } + + #endregion + + #region DocumentationType Tests + + [TestMethod] + public void DocumentationType_ReturnsMintlify() + { + var handler = new MintlifyDocReferenceHandler(); + + handler.DocumentationType.Should().Be(SupportedDocumentationType.Mintlify); + } + + #endregion + + #region RewriteMintlifyContent Tests - ES Import Rewriting + + [TestMethod] + public void RewriteMintlifyContent_EsImportDefault_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "import Component from '/snippets/Component.jsx'"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("import Component from '/snippets/my-project/Component.jsx'"); + } + + [TestMethod] + public void RewriteMintlifyContent_EsImportNamed_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "import { Button, Card } from '/snippets/components.jsx'"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("import { Button, Card } from '/snippets/my-project/components.jsx'"); + } + + [TestMethod] + public void RewriteMintlifyContent_EsImportNamespace_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "import * as Utils from '/snippets/utils.jsx'"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("import * as Utils from '/snippets/my-project/utils.jsx'"); + } + + [TestMethod] + public void RewriteMintlifyContent_EsImportWithSingleQuotes_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "import Component from '/snippets/Component.jsx'"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("/snippets/my-project/Component.jsx"); + } + + [TestMethod] + public void RewriteMintlifyContent_MultipleImports_RewritesAll() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = """ + import Header from '/snippets/Header.jsx' + import Footer from '/snippets/Footer.jsx' + """; + + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("/snippets/my-project/Header.jsx"); + result.Should().Contain("/snippets/my-project/Footer.jsx"); + } + + #endregion + + #region RewriteMintlifyContent Tests - JSX src Rewriting + + [TestMethod] + public void RewriteMintlifyContent_JsxSrcAttribute_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = ""; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be(""); + } + + [TestMethod] + public void RewriteMintlifyContent_JsxSrcWithSingleQuotes_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = ""; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("/images/my-project/banner.jpg"); + } + + [TestMethod] + public void RewriteMintlifyContent_JsxSrcWithSpaces_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = ""; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("/images/my-project/icon.svg"); + } + + #endregion + + #region RewriteMintlifyContent Tests - JSX href Rewriting + + [TestMethod] + public void RewriteMintlifyContent_JsxHrefAttribute_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "Get Started"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("Get Started"); + } + + [TestMethod] + public void RewriteMintlifyContent_JsxHrefWithAnchor_PreservesAnchor() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "Install"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("Install"); + } + + [TestMethod] + public void RewriteMintlifyContent_JsxHrefWithQueryString_PreservesQueryString() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "API"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("API"); + } + + #endregion + + #region RewriteMintlifyContent Tests - CSS url() Rewriting + + [TestMethod] + public void RewriteMintlifyContent_CssUrl_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "background: url(/images/bg.svg);"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("background: url(/images/my-project/bg.svg);"); + } + + [TestMethod] + public void RewriteMintlifyContent_CssUrlWithSingleQuotes_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "background: url('/images/pattern.png');"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("/images/my-project/pattern.png"); + } + + [TestMethod] + public void RewriteMintlifyContent_CssUrlWithDoubleQuotes_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "background: url(\"/images/texture.jpg\");"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("/images/my-project/texture.jpg"); + } + + #endregion + + #region RewriteMintlifyContent Tests - Code Block Preservation + + [TestMethod] + public void RewriteMintlifyContent_PathInCodeBlock_PreservesOriginalPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = """ + ```jsx + import Component from '/snippets/Component.jsx' + ``` + """; + + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("from '/snippets/Component.jsx'", "paths inside code blocks should not be rewritten"); + } + + [TestMethod] + public void RewriteMintlifyContent_MixedContentWithCodeBlock_OnlyRewritesOutsideCodeBlock() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = """ + import Header from '/snippets/Header.jsx' + + ```jsx + import Example from '/snippets/Example.jsx' + ``` + + import Footer from '/snippets/Footer.jsx' + """; + + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("from '/snippets/my-project/Header.jsx'"); + result.Should().Contain("from '/snippets/Example.jsx'"); // Inside code block - unchanged + result.Should().Contain("from '/snippets/my-project/Footer.jsx'"); + } + + #endregion + + #region RewriteMintlifyContent Tests - Combined Markdown and Mintlify Patterns + + [TestMethod] + public void RewriteMintlifyContent_MarkdownImage_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "![Screenshot](/images/screenshot.png)"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("![Screenshot](/images/my-project/screenshot.png)"); + } + + [TestMethod] + public void RewriteMintlifyContent_MarkdownLink_RewritesPath() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = "[Learn More](/docs/introduction)"; + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Be("[Learn More](/my-project/docs/introduction)"); + } + + [TestMethod] + public void RewriteMintlifyContent_MixedMarkdownAndJsx_RewritesAll() + { + var handler = new MintlifyDocReferenceHandler(); + + var content = """ + import Logo from '/snippets/Logo.jsx' + + ![Banner](/images/banner.png) + + [Read the docs](/docs/intro) + + + """; + + var result = handler.RewriteMintlifyContent(content, "my-project"); + + result.Should().Contain("from '/snippets/my-project/Logo.jsx'"); + result.Should().Contain("](/images/my-project/banner.png)"); + result.Should().Contain("](/my-project/docs/intro)"); + result.Should().Contain("href=\"/my-project/guides/tutorial\""); + } + + #endregion + + #region ProcessAsync Integration Tests + + [TestMethod] + public async Task ProcessAsync_CopiesAndRewritesContent() + { + var sourceDir = Path.Combine(_tempDirectory!, "source"); + var destRootDir = Path.Combine(_tempDirectory!, "docs"); + Directory.CreateDirectory(sourceDir); + Directory.CreateDirectory(Path.Combine(sourceDir, "images")); + + File.WriteAllText(Path.Combine(sourceDir, "index.mdx"), """ + import Component from '/snippets/Component.jsx' + + ![Logo](/images/logo.png) + + [Getting Started](/guides/quickstart) + """); + File.WriteAllText(Path.Combine(sourceDir, "images", "logo.png"), "PNG_DATA"); + + var handler = new MintlifyDocReferenceHandler(); + var reference = new DocumentationReference + { + DocumentationRoot = sourceDir, + DestinationPath = "my-lib", + DocumentationType = SupportedDocumentationType.Mintlify + }; + + await handler.ProcessAsync(reference, destRootDir); + + // Content should be copied to destRootDir/my-lib/ + var destFile = Path.Combine(destRootDir, "my-lib", "index.mdx"); + File.Exists(destFile).Should().BeTrue("content file should be copied"); + + var content = await File.ReadAllTextAsync(destFile); + content.Should().Contain("/snippets/my-lib/Component.jsx"); + content.Should().Contain("/images/my-lib/logo.png"); + content.Should().Contain("/my-lib/guides/quickstart"); + + // Images should be relocated to destRootDir/images/my-lib/ + File.Exists(Path.Combine(destRootDir, "images", "my-lib", "logo.png")).Should().BeTrue("image should be relocated"); + } + + [TestMethod] + public async Task ProcessAsync_RelocatesImagesDirectory() + { + var sourceDir = Path.Combine(_tempDirectory!, "source2"); + var destRootDir = Path.Combine(_tempDirectory!, "docs2"); + Directory.CreateDirectory(sourceDir); + Directory.CreateDirectory(Path.Combine(sourceDir, "images")); + Directory.CreateDirectory(Path.Combine(sourceDir, "images", "screenshots")); + + File.WriteAllText(Path.Combine(sourceDir, "images", "logo.png"), "PNG1"); + File.WriteAllText(Path.Combine(sourceDir, "images", "screenshots", "app.png"), "PNG2"); + + var handler = new MintlifyDocReferenceHandler(); + var reference = new DocumentationReference + { + DocumentationRoot = sourceDir, + DestinationPath = "my-lib", + DocumentationType = SupportedDocumentationType.Mintlify + }; + + await handler.ProcessAsync(reference, destRootDir); + + File.Exists(Path.Combine(destRootDir, "images", "my-lib", "logo.png")).Should().BeTrue(); + File.Exists(Path.Combine(destRootDir, "images", "my-lib", "screenshots", "app.png")).Should().BeTrue(); + } + + [TestMethod] + public async Task ProcessAsync_RelocatesSnippetsDirectory() + { + var sourceDir = Path.Combine(_tempDirectory!, "source3"); + var destRootDir = Path.Combine(_tempDirectory!, "docs3"); + Directory.CreateDirectory(sourceDir); + Directory.CreateDirectory(Path.Combine(sourceDir, "snippets")); + + File.WriteAllText(Path.Combine(sourceDir, "snippets", "Component.jsx"), "export default function Component() {}"); + + var handler = new MintlifyDocReferenceHandler(); + var reference = new DocumentationReference + { + DocumentationRoot = sourceDir, + DestinationPath = "my-lib", + DocumentationType = SupportedDocumentationType.Mintlify + }; + + await handler.ProcessAsync(reference, destRootDir); + + File.Exists(Path.Combine(destRootDir, "snippets", "my-lib", "Component.jsx")).Should().BeTrue(); + } + + [TestMethod] + public async Task ProcessAsync_ExcludesMintlifyConfigFiles() + { + var sourceDir = Path.Combine(_tempDirectory!, "source4"); + var destRootDir = Path.Combine(_tempDirectory!, "docs4"); + Directory.CreateDirectory(sourceDir); + + File.WriteAllText(Path.Combine(sourceDir, "index.mdx"), "# Welcome"); + File.WriteAllText(Path.Combine(sourceDir, "docs.json"), "{}"); + File.WriteAllText(Path.Combine(sourceDir, "style.css"), "body {}"); + File.WriteAllText(Path.Combine(sourceDir, "test.mdz"), "zone"); + File.WriteAllText(Path.Combine(sourceDir, "Project.docsproj"), ""); + + var handler = new MintlifyDocReferenceHandler(); + var reference = new DocumentationReference + { + DocumentationRoot = sourceDir, + DestinationPath = "my-lib", + DocumentationType = SupportedDocumentationType.Mintlify + }; + + await handler.ProcessAsync(reference, destRootDir); + + File.Exists(Path.Combine(destRootDir, "my-lib", "index.mdx")).Should().BeTrue("content should be copied"); + File.Exists(Path.Combine(destRootDir, "my-lib", "docs.json")).Should().BeFalse("docs.json should be excluded"); + File.Exists(Path.Combine(destRootDir, "my-lib", "style.css")).Should().BeFalse("CSS should be excluded"); + File.Exists(Path.Combine(destRootDir, "my-lib", "test.mdz")).Should().BeFalse("mdz should be excluded"); + File.Exists(Path.Combine(destRootDir, "my-lib", "Project.docsproj")).Should().BeFalse("docsproj should be excluded"); + } + + #endregion + + } + +} diff --git a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Renderers/MintlifyRendererTests.cs b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Renderers/MintlifyRendererTests.cs index 7f5b123..eba436a 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Mintlify/Renderers/MintlifyRendererTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Mintlify/Renderers/MintlifyRendererTests.cs @@ -177,13 +177,19 @@ public async Task RenderAsync_WithNamespaces_CreatesNamespaceFiles() } [TestMethod] - public async Task RenderAsync_WithNullModel_ThrowsArgumentNullException() + public async Task RenderAsync_WithNullModel_ReturnsWithoutError() { - // Act - Func act = async () => await GetMintlifyRenderer().RenderAsync(null!); + // Arrange + var renderer = GetMintlifyRenderer(); - // Assert - await act.Should().ThrowAsync(); + // Act - Documentation-only mode passes null model to renderers + Func act = async () => await renderer.RenderAsync(null); + + // Assert - Should not throw, should return gracefully + await act.Should().NotThrowAsync(); + + // For MintlifyRenderer, docs.json may still be generated even without API docs + // because it handles navigation merging for DocumentationReferences } [TestMethod] @@ -277,7 +283,7 @@ public async Task RenderAsync_UsesMintlifyIcons_ForTypes() var sampleClassFile = Directory.GetFiles(_testOutputPath, "*SampleClass.mdx").FirstOrDefault(); sampleClassFile.Should().NotBeNull(); - var content = await File.ReadAllTextAsync(sampleClassFile!, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(sampleClassFile!, TestContext.CancellationToken); content.Should().Contain("icon: file-brackets-curly", "Class should use file-code icon"); } @@ -300,7 +306,7 @@ public async Task RenderAsync_IncludesAssemblyUsage_WhenProvided() await GetMintlifyRenderer().RenderAsync(model); // Assert - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationToken); content.Should().Contain("## Usage"); content.Should().Contain("This is assembly usage documentation"); } @@ -320,7 +326,7 @@ public async Task RenderAsync_IncludesAssemblyExamples_WhenProvided() await GetMintlifyRenderer().RenderAsync(model); // Assert - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationToken); content.Should().Contain("## Examples"); content.Should().Contain("Example code here"); } @@ -334,13 +340,13 @@ public async Task RenderAsync_IncludesRelatedApis_WhenProvided() var context = GetService(); using var manager = new AssemblyManager(assemblyPath, xmlPath); var model = await manager.DocumentAsync(context); - model.RelatedApis = new List { "System.Object", "System.String" }; + model.RelatedApis = ["System.Object", "System.String"]; // Act await GetMintlifyRenderer().RenderAsync(model); // Assert - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationToken); content.Should().Contain("## Related APIs"); content.Should().Contain("- System.Object"); content.Should().Contain("- System.String"); @@ -361,13 +367,13 @@ public async Task RenderAsync_HandlesEmptyDocumentation_Gracefully() model.BestPractices = string.Empty; model.Patterns = string.Empty; model.Considerations = string.Empty; - model.RelatedApis = new List(); + model.RelatedApis = []; // Act await GetMintlifyRenderer().RenderAsync(model); // Assert - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationToken); content.Should().Contain("title: Overview"); content.Should().Contain("## Namespaces"); content.Should().NotContain("## Overview"); @@ -397,7 +403,7 @@ public async Task RenderAsync_IncludesMemberSignatures_InTypeFiles() var ns = model.Namespaces.First(n => n.Types.Any(t => t.Symbol.Name == "ClassWithMethods")); var namespaceName = string.IsNullOrEmpty(ns.Name) ? "global" : ns.Name; var typeFileName = $"{namespaceName.Replace('.', '-')}.ClassWithMethods.mdx"; - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, typeFileName), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, typeFileName), TestContext.CancellationToken); content.Should().Contain("```csharp"); content.Should().Contain("public"); @@ -675,7 +681,7 @@ await CompareWithFolderBaseline( private async Task CompareWithFolderBaseline(string actualFilePath, string baselineRelativePath) { // Read actual file - var actualContent = await File.ReadAllTextAsync(actualFilePath, TestContext.CancellationTokenSource.Token); + var actualContent = await File.ReadAllTextAsync(actualFilePath, TestContext.CancellationToken); // Construct baseline path var baselineDir = Path.Combine( @@ -694,12 +700,12 @@ private async Task CompareWithFolderBaseline(string actualFilePath, string basel { Directory.CreateDirectory(directory); } - await File.WriteAllTextAsync(baselinePath, actualContent, TestContext.CancellationTokenSource.Token); + await File.WriteAllTextAsync(baselinePath, actualContent, TestContext.CancellationToken); Assert.Inconclusive($"Baseline created at: {baselinePath}. Re-run test to verify."); } // Compare with baseline - normalize line endings for cross-platform compatibility - var baselineContent = await File.ReadAllTextAsync(baselinePath, TestContext.CancellationTokenSource.Token); + var baselineContent = await File.ReadAllTextAsync(baselinePath, TestContext.CancellationToken); // Normalize both to Environment.NewLine to handle any line ending differences var normalizedActual = actualContent.ReplaceLineEndings(Environment.NewLine); @@ -725,7 +731,7 @@ public async Task RenderAssemblyAsync_Should_Create_Index_File_With_Frontmatter( File.Exists(indexPath).Should().BeTrue(); // Check frontmatter - var content = await File.ReadAllTextAsync(indexPath, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(indexPath, TestContext.CancellationToken); content.Should().StartWith("---"); content.Should().Contain("title:"); content.Should().Contain("icon: cube"); @@ -739,7 +745,7 @@ public async Task RenderAssemblyAsync_Should_Include_Assembly_Name() await GetMintlifyRenderer().RenderAssemblyAsync(assembly, _testOutputPath); var indexPath = Path.Combine(_testOutputPath, "index.mdx"); - var content = await File.ReadAllTextAsync(indexPath, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(indexPath, TestContext.CancellationToken); content.Should().Contain("title: Overview"); content.Should().Contain("## Namespaces"); } @@ -752,7 +758,7 @@ public async Task RenderAssemblyAsync_Should_Include_Usage_When_Present() await GetMintlifyRenderer().RenderAssemblyAsync(assembly, _testOutputPath); - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationToken); content.Should().Contain("## Usage"); content.Should().Contain(assembly.Usage); } @@ -764,7 +770,7 @@ public async Task RenderAssemblyAsync_Should_List_Namespaces() await GetMintlifyRenderer().RenderAssemblyAsync(assembly, _testOutputPath); - var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(Path.Combine(_testOutputPath, "index.mdx"), TestContext.CancellationToken); content.Should().Contain("## Namespaces"); foreach (var ns in assembly.Namespaces) { @@ -796,7 +802,7 @@ public async Task RenderNamespaceAsync_Should_Create_Namespace_File_With_Frontma File.Exists(nsPath).Should().BeTrue(); // Check frontmatter - var content = await File.ReadAllTextAsync(nsPath, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(nsPath, TestContext.CancellationToken); content.Should().StartWith("---"); content.Should().Contain("title:"); content.Should().Contain("icon:"); @@ -815,7 +821,7 @@ public async Task RenderNamespaceAsync_Should_List_Types_By_Category() var namespaceName = string.IsNullOrEmpty(ns.Name) ? "global" : ns.Name; var nsPath = Path.Combine(_testOutputPath, $"{namespaceName.Replace('.', GetService().FileNamingOptions.NamespaceSeparator)}.mdx"); - var content = await File.ReadAllTextAsync(nsPath, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(nsPath, TestContext.CancellationToken); content.Should().Contain("## Types"); if (ns.Types.Any(t => t.Symbol.TypeKind == TypeKind.Class)) @@ -836,7 +842,7 @@ public async Task RenderNamespaceAsync_Should_List_Types_By_Category() public async Task RenderTypeAsync_Should_Create_Type_File_With_Frontmatter() { var assembly = GetTestsDotSharedAssembly(); - var ns = assembly.Namespaces.FirstOrDefault(n => n.Types.Any()); + var ns = assembly.Namespaces.FirstOrDefault(n => n.Types.Count is not 0); ns.Should().NotBeNull("Test assembly should contain a namespace with types"); @@ -855,7 +861,7 @@ public async Task RenderTypeAsync_Should_Create_Type_File_With_Frontmatter() File.Exists(typePath).Should().BeTrue(); // Check frontmatter - var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationToken); content.Should().StartWith("---"); content.Should().Contain("title:"); content.Should().Contain("icon:"); @@ -881,7 +887,7 @@ public async Task RenderTypeAsync_Should_Include_Type_Metadata() var separator = GetService().FileNamingOptions.NamespaceSeparator; var fileName = $"{safeNamespace.Replace('.', separator)}.{safeTypeName}.mdx"; var typePath = Path.Combine(_testOutputPath, fileName); - var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationToken); //content.Should().Contain($"# {type.Symbol.Name}"); content.Should().Contain("## Definition"); @@ -910,7 +916,7 @@ public async Task RenderTypeAsync_Should_Include_Type_Signature() var separator = GetService().FileNamingOptions.NamespaceSeparator; var fileName = $"{safeNamespace.Replace('.', separator)}.{safeTypeName}.mdx"; var typePath = Path.Combine(_testOutputPath, fileName); - var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationToken); content.Should().Contain("## Syntax"); content.Should().Contain("```csharp"); @@ -938,7 +944,7 @@ public async Task RenderTypeAsync_Should_Include_Members_By_Category() var separator = GetService().FileNamingOptions.NamespaceSeparator; var fileName = $"{safeNamespace.Replace('.', separator)}.{safeTypeName}.mdx"; var typePath = Path.Combine(_testOutputPath, fileName); - var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationTokenSource.Token); + var content = await File.ReadAllTextAsync(typePath, TestContext.CancellationToken); content.Should().Contain("## Constructors"); content.Should().Contain("## Methods"); @@ -965,7 +971,7 @@ public void RenderMember_Should_Include_Member_Name() GetMintlifyRenderer().RenderMember(sb, member!); var result = sb.ToString(); - result.Should().Contain($$$"""### {{{member!.Symbol.Name}}}"""); + result.Should().Contain($$$"""### {{{member!.Symbol.Name}}}"""); } [TestMethod] @@ -1131,12 +1137,12 @@ public async Task RenderAsync_WithAdditionalMdxFiles_IncludesThemInNavigation() { // Arrange - Create additional MDX files in the documentation root var testMdxFile = Path.Combine(_testOutputPath, "getting-started.mdx"); - await File.WriteAllTextAsync(testMdxFile, "---\ntitle: Getting Started\n---\n# Getting Started\n\nThis is additional content.", TestContext.CancellationTokenSource.Token); + await File.WriteAllTextAsync(testMdxFile, "---\ntitle: Getting Started\n---\n# Getting Started\n\nThis is additional content.", TestContext.CancellationToken); var subDir = Path.Combine(_testOutputPath, "guides"); Directory.CreateDirectory(subDir); var guideMdxFile = Path.Combine(subDir, "tutorial.mdx"); - await File.WriteAllTextAsync(guideMdxFile, "---\ntitle: Tutorial\n---\n# Tutorial\n\nThis is a tutorial.", TestContext.CancellationTokenSource.Token); + await File.WriteAllTextAsync(guideMdxFile, "---\ntitle: Tutorial\n---\n# Tutorial\n\nThis is a tutorial.", TestContext.CancellationToken); var assemblyPath = typeof(SampleClass).Assembly.Location; var xmlPath = Path.ChangeExtension(assemblyPath, ".xml"); @@ -1152,7 +1158,7 @@ public async Task RenderAsync_WithAdditionalMdxFiles_IncludesThemInNavigation() var docsJsonPath = Path.Combine(_testOutputPath, "docs.json"); File.Exists(docsJsonPath).Should().BeTrue("docs.json should be created"); - var docsJsonContent = await File.ReadAllTextAsync(docsJsonPath, TestContext.CancellationTokenSource.Token); + var docsJsonContent = await File.ReadAllTextAsync(docsJsonPath, TestContext.CancellationToken); docsJsonContent.Should().Contain("getting-started", "Additional MDX file should be included in navigation"); docsJsonContent.Should().Contain("guides", "Subdirectory with MDX files should be included in navigation"); docsJsonContent.Should().Contain("tutorial", "Tutorial file should be included in navigation"); @@ -1163,7 +1169,7 @@ public async Task RenderAsync_WithExistingIndexMdx_DoesNotDuplicateIndex() { // Arrange - Create an existing index.mdx file in the root var existingIndexFile = Path.Combine(_testOutputPath, "index.mdx"); - await File.WriteAllTextAsync(existingIndexFile, "---\ntitle: Custom Index\n---\n# Custom Index\n\nThis is a custom index page.", TestContext.CancellationTokenSource.Token); + await File.WriteAllTextAsync(existingIndexFile, "---\ntitle: Custom Index\n---\n# Custom Index\n\nThis is a custom index page.", TestContext.CancellationToken); var assemblyPath = typeof(SampleClass).Assembly.Location; var xmlPath = Path.ChangeExtension(assemblyPath, ".xml"); @@ -1179,7 +1185,7 @@ public async Task RenderAsync_WithExistingIndexMdx_DoesNotDuplicateIndex() var docsJsonPath = Path.Combine(_testOutputPath, "docs.json"); File.Exists(docsJsonPath).Should().BeTrue("docs.json should be created"); - var docsJsonContent = await File.ReadAllTextAsync(docsJsonPath, TestContext.CancellationTokenSource.Token); + var docsJsonContent = await File.ReadAllTextAsync(docsJsonPath, TestContext.CancellationToken); // Count occurrences of "index" in the navigation var indexCount = docsJsonContent.Split("\"index\"").Length - 1; @@ -1193,13 +1199,13 @@ public async Task RenderAsync_WithApiReferenceFolder_ExcludesFromDiscovery() var apiReferenceDir = Path.Combine(_testOutputPath, "api-reference"); Directory.CreateDirectory(apiReferenceDir); var apiFile = Path.Combine(apiReferenceDir, "some-api.mdx"); - await File.WriteAllTextAsync(apiFile, "---\ntitle: Some API\n---\n# Some API\n\nThis should be excluded.", TestContext.CancellationTokenSource.Token); + await File.WriteAllTextAsync(apiFile, "---\ntitle: Some API\n---\n# Some API\n\nThis should be excluded.", TestContext.CancellationToken); // Also add a legitimate additional file var guidesDir = Path.Combine(_testOutputPath, "guides"); Directory.CreateDirectory(guidesDir); var guideFile = Path.Combine(guidesDir, "tutorial.mdx"); - await File.WriteAllTextAsync(guideFile, "---\ntitle: Tutorial\n---\n# Tutorial\n\nThis should be included.", TestContext.CancellationTokenSource.Token); + await File.WriteAllTextAsync(guideFile, "---\ntitle: Tutorial\n---\n# Tutorial\n\nThis should be included.", TestContext.CancellationToken); var assemblyPath = typeof(SampleClass).Assembly.Location; var xmlPath = Path.ChangeExtension(assemblyPath, ".xml"); @@ -1215,7 +1221,7 @@ public async Task RenderAsync_WithApiReferenceFolder_ExcludesFromDiscovery() var docsJsonPath = Path.Combine(_testOutputPath, "docs.json"); File.Exists(docsJsonPath).Should().BeTrue("docs.json should be created"); - var docsJsonContent = await File.ReadAllTextAsync(docsJsonPath, TestContext.CancellationTokenSource.Token); + var docsJsonContent = await File.ReadAllTextAsync(docsJsonPath, TestContext.CancellationToken); // Should contain the guides content but NOT the api-reference content from discovery docsJsonContent.Should().Contain("guides", "Guides folder should be discovered"); @@ -1249,7 +1255,7 @@ public async Task RenderAsync_WithEmptyDocumentationRoot_WorksAsBeforeWithOnlyGe var docsJsonPath = Path.Combine(_testOutputPath, "docs.json"); File.Exists(docsJsonPath).Should().BeTrue("docs.json should be created"); - var docsJsonContent = await File.ReadAllTextAsync(docsJsonPath, TestContext.CancellationTokenSource.Token); + var docsJsonContent = await File.ReadAllTextAsync(docsJsonPath, TestContext.CancellationToken); // Should contain the generated index and API reference content, but no additional content docsJsonContent.Should().Contain("\"index\"", "Generated index should be present"); @@ -1276,49 +1282,49 @@ public void EndToEnd_TemplateLoading_PreservesIconsAndStructure() Colors = new ColorsConfig { Primary = "#0D9373" }, Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ new GroupConfig { Group = "Getting Started", Icon = "stars", - Pages = new List { "index", "quickstart" } + Pages = ["index", "quickstart"] }, new GroupConfig { Group = "Guides", Icon = "dog-leashed", - Pages = new List { "guides/index", "guides/conceptual-docs" } + Pages = ["guides/index", "guides/conceptual-docs"] }, new GroupConfig { Group = "Providers", Icon = "books", - Pages = new List - { + Pages = + [ "providers/index", new GroupConfig { Group = "Mintlify", Icon = "/mintlify.svg", Tag = "PARTNER", - Pages = new List { "providers/mintlify/index" } + Pages = ["providers/mintlify/index"] } - } + ] }, new GroupConfig { Group = "Plugins", Icon = "outlet", - Pages = new List { "plugins/index" } + Pages = ["plugins/index"] }, new GroupConfig { Group = "Learnings", Icon = "", // Empty icon should be preserved - Pages = new List { "learnings/bridge-assemblies" } + Pages = ["learnings/bridge-assemblies"] } - } + ] } }; @@ -1405,7 +1411,7 @@ public void CombineReferencedNavigation_NoReferences_DoesNotThrow() var collectionConfig = new DocsJsonConfig { Name = "Collection", - Navigation = new NavigationConfig { Pages = new List { "introduction" } } + Navigation = new NavigationConfig { Pages = ["introduction"] } }; var collectionJson = JsonSerializer.Serialize(collectionConfig, MintlifyConstants.JsonSerializerOptions); docsJsonManager.Load(collectionJson); @@ -1462,7 +1468,7 @@ public void CombineReferencedNavigation_AddToTabs_CombinesNavigationCorrectly() Name = "Collection", Navigation = new NavigationConfig { - Pages = new List { "introduction" } + Pages = ["introduction"] } }; var collectionJson = JsonSerializer.Serialize(collectionConfig, MintlifyConstants.JsonSerializerOptions); @@ -1476,7 +1482,7 @@ public void CombineReferencedNavigation_AddToTabs_CombinesNavigationCorrectly() Name = "Service A", Navigation = new NavigationConfig { - Pages = new List { "overview", "getting-started" } + Pages = ["overview", "getting-started"] } }; var refJson = JsonSerializer.Serialize(refConfig, MintlifyConstants.JsonSerializerOptions); @@ -1495,13 +1501,13 @@ public void CombineReferencedNavigation_AddToTabs_CombinesNavigationCorrectly() renderer.CombineReferencedNavigation(); renderer._docsJsonManager!.Configuration!.Navigation!.Tabs.Should().NotBeNull(); - renderer._docsJsonManager!.Configuration!.Navigation!.Tabs!.Count.Should().Be(1); + renderer._docsJsonManager!.Configuration!.Navigation!.Tabs!.Should().ContainSingle(); var tab = renderer._docsJsonManager!.Configuration!.Navigation!.Tabs![0]; tab.Tab.Should().Be("ServiceA"); tab.Href.Should().Be("services/service-a"); tab.Pages.Should().NotBeNull(); - tab.Pages!.Count.Should().Be(2); + tab.Pages!.Should().HaveCount(2); VerifyPagePrefixes(tab.Pages, "services/service-a/"); } @@ -1518,7 +1524,7 @@ public void CombineReferencedNavigation_AddToProducts_CombinesNavigationCorrectl Name = "Collection", Navigation = new NavigationConfig { - Pages = new List { "introduction" } + Pages = ["introduction"] } }; var collectionJson = JsonSerializer.Serialize(collectionConfig, MintlifyConstants.JsonSerializerOptions); @@ -1532,7 +1538,7 @@ public void CombineReferencedNavigation_AddToProducts_CombinesNavigationCorrectl Name = "Product A", Navigation = new NavigationConfig { - Pages = new List { "overview", "getting-started" } + Pages = ["overview", "getting-started"] } }; var refJson = JsonSerializer.Serialize(refConfig, MintlifyConstants.JsonSerializerOptions); @@ -1551,13 +1557,13 @@ public void CombineReferencedNavigation_AddToProducts_CombinesNavigationCorrectl renderer.CombineReferencedNavigation(); renderer._docsJsonManager!.Configuration!.Navigation!.Products.Should().NotBeNull(); - renderer._docsJsonManager!.Configuration!.Navigation!.Products!.Count.Should().Be(1); + renderer._docsJsonManager!.Configuration!.Navigation!.Products!.Should().ContainSingle(); var product = renderer._docsJsonManager!.Configuration!.Navigation!.Products![0]; product.Product.Should().Be("ProductA"); product.Href.Should().Be("products/product-a"); product.Pages.Should().NotBeNull(); - product.Pages!.Count.Should().Be(2); + product.Pages!.Should().HaveCount(2); VerifyPagePrefixes(product.Pages, "products/product-a/"); } @@ -1574,7 +1580,7 @@ public void CombineReferencedNavigation_MultipleReferences_CombinesAll() Name = "Collection", Navigation = new NavigationConfig { - Pages = new List { "introduction" } + Pages = ["introduction"] } }; var collectionJson = JsonSerializer.Serialize(collectionConfig, MintlifyConstants.JsonSerializerOptions); @@ -1586,7 +1592,7 @@ public void CombineReferencedNavigation_MultipleReferences_CombinesAll() var ref1Config = new DocsJsonConfig { Name = "Service A", - Navigation = new NavigationConfig { Pages = new List { "overview" } } + Navigation = new NavigationConfig { Pages = ["overview"] } }; var ref1Json = JsonSerializer.Serialize(ref1Config, MintlifyConstants.JsonSerializerOptions); File.WriteAllText(ref1DocsPath, ref1Json); @@ -1595,7 +1601,7 @@ public void CombineReferencedNavigation_MultipleReferences_CombinesAll() var ref2Config = new DocsJsonConfig { Name = "Service B", - Navigation = new NavigationConfig { Pages = new List { "getting-started" } } + Navigation = new NavigationConfig { Pages = ["getting-started"] } }; var ref2Json = JsonSerializer.Serialize(ref2Config, MintlifyConstants.JsonSerializerOptions); File.WriteAllText(ref2DocsPath, ref2Json); @@ -1621,7 +1627,7 @@ public void CombineReferencedNavigation_MultipleReferences_CombinesAll() renderer.CombineReferencedNavigation(); renderer._docsJsonManager!.Configuration!.Navigation!.Tabs.Should().NotBeNull(); - renderer._docsJsonManager!.Configuration!.Navigation!.Tabs!.Count.Should().Be(2); + renderer._docsJsonManager!.Configuration!.Navigation!.Tabs!.Should().HaveCount(2); var tab1 = renderer._docsJsonManager!.Configuration!.Navigation!.Tabs![0]; tab1.Tab.Should().Be("ServiceA"); @@ -1675,7 +1681,7 @@ public void CombineReferencedNavigation_AppliesUrlPrefixToNestedGroups() var collectionConfig = new DocsJsonConfig { Name = "Collection", - Navigation = new NavigationConfig { Pages = new List { "introduction" } } + Navigation = new NavigationConfig { Pages = ["introduction"] } }; var collectionJson = JsonSerializer.Serialize(collectionConfig, MintlifyConstants.JsonSerializerOptions); docsJsonManager.Load(collectionJson); @@ -1688,23 +1694,23 @@ public void CombineReferencedNavigation_AppliesUrlPrefixToNestedGroups() Name = "Service A", Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ "overview", new GroupConfig { Group = "API", - Pages = new List - { + Pages = + [ "api/getting-started", new GroupConfig { Group = "Endpoints", - Pages = new List { "api/endpoints/users", "api/endpoints/products" } + Pages = ["api/endpoints/users", "api/endpoints/products"] } - } + ] } - } + ] } }; var refJson = JsonSerializer.Serialize(refConfig, MintlifyConstants.JsonSerializerOptions); @@ -1723,7 +1729,7 @@ public void CombineReferencedNavigation_AppliesUrlPrefixToNestedGroups() renderer.CombineReferencedNavigation(); renderer._docsJsonManager!.Configuration!.Navigation!.Tabs.Should().NotBeNull(); - renderer._docsJsonManager!.Configuration!.Navigation!.Tabs!.Count.Should().Be(1); + renderer._docsJsonManager!.Configuration!.Navigation!.Tabs!.Should().ContainSingle(); var tab = renderer._docsJsonManager!.Configuration!.Navigation!.Tabs![0]; tab.Tab.Should().Be("ServiceA"); diff --git a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/CloudNimble.DotNetDocs.Tests.Sdk.Tasks.csproj b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/CloudNimble.DotNetDocs.Tests.Sdk.Tasks.csproj index 3aef87b..a20c04c 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/CloudNimble.DotNetDocs.Tests.Sdk.Tasks.csproj +++ b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/CloudNimble.DotNetDocs.Tests.Sdk.Tasks.csproj @@ -4,13 +4,11 @@ net10.0;net9.0;net8.0 $(NoWarn);NU1701 + true - - - - + diff --git a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/DiscoverDocumentedProjectsTaskTests.cs b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/DiscoverDocumentedProjectsTaskTests.cs index de8a1f5..29f6108 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/DiscoverDocumentedProjectsTaskTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/DiscoverDocumentedProjectsTaskTests.cs @@ -89,7 +89,7 @@ public void DiscoverProjectFiles_WithExcludePatterns_ExcludesMatchingProjects() var excludePatterns = new[] { "Tests", "IntegrationTests" }; var result = _task.DiscoverProjectFiles(_tempDirectory, excludePatterns); - result.Should().HaveCount(1); + result.Should().ContainSingle(); result.Should().Contain(p => p.EndsWith("MyProject.csproj")); } diff --git a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/DocumentationReferenceResolverTaskTests.cs b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/DocumentationReferenceResolverTaskTests.cs index f8f51cd..1c73875 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/DocumentationReferenceResolverTaskTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/DocumentationReferenceResolverTaskTests.cs @@ -153,7 +153,7 @@ public void Execute_WithValidMintlifyReference_ResolvesSuccessfully() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); var resolved = _task.ResolvedDocumentationReferences[0]; resolved.GetMetadata("ProjectPath").Should().EndWith("ServiceA.docsproj"); @@ -189,7 +189,7 @@ public void Execute_WithMissingDestinationPath_DefaultsToProjectName() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _task.ResolvedDocumentationReferences[0].GetMetadata("DestinationPath").Should().Be("MyService"); } finally @@ -219,7 +219,7 @@ public void Execute_WithMissingIntegrationType_DefaultsToTabs() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _task.ResolvedDocumentationReferences[0].GetMetadata("IntegrationType").Should().Be("Tabs"); } finally @@ -482,7 +482,7 @@ public void Execute_WithMatchingDocumentationType_Resolves() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _buildEngine.LoggedWarnings.Where(w => w.Message != null).Should().NotContain(w => w.Message!.Contains("Skipping")); } finally @@ -511,7 +511,7 @@ public void Execute_WithNullCollectionDocumentationType_SkipsValidation() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _buildEngine.LoggedWarnings.Should().BeEmpty(); } finally @@ -540,7 +540,7 @@ public void Execute_WithCaseInsensitiveDocumentationType_Matches() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _buildEngine.LoggedWarnings.Where(w => w.Message != null).Should().NotContain(w => w.Message!.Contains("Skipping")); } finally @@ -629,7 +629,7 @@ public void Execute_WithMissingNavigationFile_LogsWarningAndContinues() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _task.ResolvedDocumentationReferences[0]!.GetMetadata("NavigationFilePath").Should().BeEmpty(); _buildEngine.LoggedWarnings.Where(w => w.Message != null).Should().Contain(w => w.Message!.Contains("Navigation file not found")); } @@ -692,7 +692,7 @@ public void Execute_WithRelativePath_ConvertsToAbsolute() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); Path.IsPathRooted(_task.ResolvedDocumentationReferences[0].GetMetadata("ProjectPath")).Should().BeTrue(); } finally @@ -721,7 +721,7 @@ public void Execute_WithAbsolutePath_UsesAsIs() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _task.ResolvedDocumentationReferences[0].GetMetadata("ProjectPath").Should().Be(projectPath); } finally @@ -818,7 +818,7 @@ public void Execute_WithNameMetadata_PreservesValue() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _task.ResolvedDocumentationReferences[0].GetMetadata("Name").Should().Be("My Custom Service Name"); _buildEngine.LoggedMessages.Where(m => m.Message != null).Should().Contain(m => m.Message!.Contains("Name: My Custom Service Name")); } @@ -850,7 +850,7 @@ public void Execute_WithoutNameMetadata_DoesNotSetName() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _task.ResolvedDocumentationReferences[0].GetMetadata("Name").Should().BeEmpty(); _buildEngine.LoggedMessages.Where(m => m.Message != null).Should().NotContain(m => m.Message!.Contains("Name:")); } @@ -882,7 +882,7 @@ public void Execute_WithEmptyNameMetadata_DoesNotSetName() // Assert result.Should().BeTrue(); - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _task.ResolvedDocumentationReferences[0].GetMetadata("Name").Should().BeEmpty(); } finally diff --git a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/GenerateDocumentationTaskTests.cs b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/GenerateDocumentationTaskTests.cs index 52d7b7d..4e1f712 100644 --- a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/GenerateDocumentationTaskTests.cs +++ b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/GenerateDocumentationTaskTests.cs @@ -167,7 +167,7 @@ public void ParseGroupConfig_WithNestedGroups_ParsesHierarchy() mintlifyGroup!.Group.Should().Be("Mintlify"); mintlifyGroup.Icon!.Name.Should().Be("/mintlify.svg"); mintlifyGroup.Tag.Should().Be("PARTNER"); - mintlifyGroup.Pages.Should().HaveCount(1); + mintlifyGroup.Pages.Should().ContainSingle(); mintlifyGroup.Pages![0].Should().Be("providers/mintlify/index"); // Third item should be the nested GitHub group @@ -869,7 +869,7 @@ public void Task_CanAcceptResolvedDocumentationReferences() _task.ResolvedDocumentationReferences = references; - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); _task.ResolvedDocumentationReferences[0].GetMetadata("ProjectPath").Should().Be(@"D:\projects\ServiceA\ServiceA.docsproj"); _task.ResolvedDocumentationReferences[0].GetMetadata("DocumentationRoot").Should().Be(@"D:\projects\ServiceA\docs"); _task.ResolvedDocumentationReferences[0].GetMetadata("DestinationPath").Should().Be("services/service-a"); @@ -1040,7 +1040,7 @@ public void Task_ResolvedDocumentationReferences_CanBeSetMultipleTimes() }; _task.ResolvedDocumentationReferences = references1; - _task.ResolvedDocumentationReferences.Should().HaveCount(1); + _task.ResolvedDocumentationReferences.Should().ContainSingle(); var references2 = new ITaskItem[] { diff --git a/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/ModuleInitializer.cs b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/ModuleInitializer.cs new file mode 100644 index 0000000..ae8f86e --- /dev/null +++ b/src/CloudNimble.DotNetDocs.Tests.Sdk.Tasks/ModuleInitializer.cs @@ -0,0 +1,26 @@ +using System.Runtime.CompilerServices; +using CloudNimble.EasyAF.MSBuild; + +namespace CloudNimble.DotNetDocs.Tests.Sdk.Tasks +{ + + /// + /// Module initializer that registers MSBuild when the assembly is loaded. + /// This runs before test discovery, ensuring MSBuildLocator can redirect + /// assembly resolution to the SDK before any MSBuild types are loaded. + /// + internal static class ModuleInitializer + { + + /// + /// Registers MSBuild when the assembly is loaded, before test discovery. + /// + [ModuleInitializer] + internal static void Initialize() + { + MSBuildProjectManager.EnsureMSBuildRegistered(); + } + + } + +} diff --git a/src/CloudNimble.DotNetDocs.Tools/Commands/AddCommand.cs b/src/CloudNimble.DotNetDocs.Tools/Commands/AddCommand.cs index ceae424..f9b8bc4 100644 --- a/src/CloudNimble.DotNetDocs.Tools/Commands/AddCommand.cs +++ b/src/CloudNimble.DotNetDocs.Tools/Commands/AddCommand.cs @@ -55,6 +55,12 @@ public class AddCommand : DocsCommandBase [Option("--prerelease", Description = "Optional. Use the latest prerelease version of DotNetDocs.Sdk instead of the latest stable version.")] public bool UsePrerelease { get; set; } + /// + /// Gets or sets whether to skip adding the project to the solution file. + /// + [Option("--skip-solution", Description = "Optional. Skip adding the project to the solution file. Useful for CI/CD or standalone documentation projects.")] + public bool SkipSolution { get; set; } + #endregion #region Public Methods @@ -76,22 +82,42 @@ public async Task OnExecute(CommandLineApplication app) WriteHeader(); try { - // Find solution file if not specified - string? solutionFile = SolutionPath ?? FindSolutionFile(); - if (string.IsNullOrEmpty(solutionFile)) + // Validate mutually exclusive options + if (SkipSolution && !string.IsNullOrEmpty(SolutionPath)) { - Console.WriteLine("❌ No solution file (.sln or .slnx) found in current directory"); + Console.WriteLine("❌ Cannot use --skip-solution with --solution"); return 1; } - Console.WriteLine($"📁 Found solution: {solutionFile}"); + // Find solution file if not skipping + string? solutionFile = null; + if (!SkipSolution) + { + solutionFile = SolutionPath ?? FindSolutionFile(); + if (string.IsNullOrEmpty(solutionFile)) + { + Console.WriteLine("❌ No solution file (.sln or .slnx) found in current directory"); + Console.WriteLine(" Use --skip-solution to create a standalone documentation project"); + return 1; + } + Console.WriteLine($"📁 Found solution: {solutionFile}"); + } + + // Determine project name (use solution name if available, otherwise require --name) + string? solutionName = solutionFile is not null ? Path.GetFileNameWithoutExtension(solutionFile) : null; + string? docsProjectName = ProjectName ?? (solutionName is not null ? $"{solutionName}.Docs" : null); - // Determine project name - string solutionName = Path.GetFileNameWithoutExtension(solutionFile); - string docsProjectName = ProjectName ?? $"{solutionName}.Docs"; + if (string.IsNullOrEmpty(docsProjectName)) + { + Console.WriteLine("❌ Project name is required when using --skip-solution without a solution file"); + Console.WriteLine(" Use --name to specify the documentation project name"); + return 1; + } // Determine output directory - string outputDir = OutputDirectory ?? Path.Combine(Path.GetDirectoryName(solutionFile)!, docsProjectName); + string outputDir = OutputDirectory ?? (solutionFile is not null + ? Path.Combine(Path.GetDirectoryName(solutionFile)!, docsProjectName) + : Path.Combine(Directory.GetCurrentDirectory(), docsProjectName)); // Determine documentation type (default to Mintlify) string docType = DocumentationType ?? "Mintlify"; @@ -117,23 +143,31 @@ public async Task OnExecute(CommandLineApplication app) // Create the docs project directory Directory.CreateDirectory(outputDir); - // Create the .docsproj file + // Create the .docsproj file (use docsProjectName as fallback for display name) + string displayName = solutionName ?? docsProjectName; string docsProjPath = Path.Combine(outputDir, $"{docsProjectName}.docsproj"); - await CreateDocsProjectFile(docsProjPath, solutionName, docType, sdkVersion); + await CreateDocsProjectFile(docsProjPath, displayName, docType, sdkVersion); Console.WriteLine($"✅ Created {docsProjPath}"); // Create default .mdx files for Mintlify projects if (docType.Equals("Mintlify", StringComparison.OrdinalIgnoreCase)) { - await CreateDefaultMintlifyFilesAsync(outputDir, solutionName); + await CreateDefaultMintlifyFilesAsync(outputDir, displayName); Console.WriteLine($"✅ Created default documentation files"); } - // Add to solution - await AddProjectToSolution(solutionFile, docsProjPath, docsProjectName); + // Add to solution (unless --skip-solution was specified) + if (!SkipSolution && solutionFile is not null) + { + await AddProjectToSolution(solutionFile, docsProjPath, docsProjectName); + Console.WriteLine($"✅ Added {docsProjectName} to solution"); + } + else if (SkipSolution) + { + Console.WriteLine($"⏭️ Skipped adding to solution (--skip-solution)"); + } - Console.WriteLine($"✅ Added {docsProjectName} to solution"); Console.WriteLine($"🎉 Documentation project setup complete!"); return 0; diff --git a/src/CloudNimble.DotNetDocs.Tools/Commands/Base/DocsCommandBase.cs b/src/CloudNimble.DotNetDocs.Tools/Commands/Base/DocsCommandBase.cs index feed536..39354a4 100644 --- a/src/CloudNimble.DotNetDocs.Tools/Commands/Base/DocsCommandBase.cs +++ b/src/CloudNimble.DotNetDocs.Tools/Commands/Base/DocsCommandBase.cs @@ -167,6 +167,7 @@ internal static string GetVersion() } #endregion + #region Helper Classes #endregion diff --git a/src/CloudNimble.DotNetDocs.Tools/Program.cs b/src/CloudNimble.DotNetDocs.Tools/Program.cs index 6c9dbd5..ec525cc 100644 --- a/src/CloudNimble.DotNetDocs.Tools/Program.cs +++ b/src/CloudNimble.DotNetDocs.Tools/Program.cs @@ -32,4 +32,5 @@ public static Task Main(string[] args) => .RunCommandLineApplicationAsync(args); } + } diff --git a/src/CloudNimble.DotNetDocs.slnx b/src/CloudNimble.DotNetDocs.slnx index fae5211..8c1932f 100644 --- a/src/CloudNimble.DotNetDocs.slnx +++ b/src/CloudNimble.DotNetDocs.slnx @@ -1,3 +1,4 @@ + @@ -61,4 +62,4 @@ - + \ No newline at end of file diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 86e6f9f..986a751 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -32,7 +32,7 @@ $(MSBuildProjectName.Replace('CloudNimble.', '')) DotNetDocs 1.1.0.0 - 1.1.0-preview.14 + 1.2.0-preview.5 CloudNimble CloudNimble, Inc. CloudNimble diff --git a/src/Mintlify.Tests.Core/Converters/JsonConverterTests.cs b/src/Mintlify.Tests.Core/Converters/JsonConverterTests.cs index c182889..5b78646 100644 --- a/src/Mintlify.Tests.Core/Converters/JsonConverterTests.cs +++ b/src/Mintlify.Tests.Core/Converters/JsonConverterTests.cs @@ -39,15 +39,15 @@ public void GroupConfig_FullSerializationRoundTrip_MaintainsData() Icon = "api", AsyncApi = "https://api.example.com/asyncapi.json", OpenApi = new List { "spec1.json", "spec2.json" }, - Pages = new List - { + Pages = + [ "api/overview", new GroupConfig { Group = "Endpoints", - Pages = new List { "api/users", "api/orders" } + Pages = ["api/users", "api/orders"] } - } + ] }; var json = JsonSerializer.Serialize(original, _jsonOptions); @@ -70,7 +70,7 @@ public void NavigationConfig_CamelCaseNaming_WorksCorrectly() { var config = new NavigationConfig { - Pages = new List { "index", "getting-started" } + Pages = ["index", "getting-started"] }; var json = JsonSerializer.Serialize(config, _jsonOptions); diff --git a/src/Mintlify.Tests.Core/Converters/NavigationPageConverterTests.cs b/src/Mintlify.Tests.Core/Converters/NavigationPageConverterTests.cs index baad871..5603f29 100644 --- a/src/Mintlify.Tests.Core/Converters/NavigationPageConverterTests.cs +++ b/src/Mintlify.Tests.Core/Converters/NavigationPageConverterTests.cs @@ -1,4 +1,3 @@ -using System.Collections.Generic; using System.Text.Json; using FluentAssertions; using Microsoft.VisualStudio.TestTools.UnitTesting; @@ -39,7 +38,7 @@ public void NavigationPageConverter_DeserializeString_ReturnsString() var result = JsonSerializer.Deserialize(json, _jsonOptions); result.Should().NotBeNull(); - result!.Pages.Should().HaveCount(1); + result!.Pages.Should().ContainSingle(); result!.Pages![0].Should().BeOfType(); result!.Pages![0].Should().Be("cli/index"); } @@ -101,7 +100,7 @@ public void NavigationPageConverter_SerializeGroupConfig_ReturnsJsonObject() var value = new GroupConfig { Group = "CLI Tools", - Pages = new List { "cli/index", "cli/commands" } + Pages = ["cli/index", "cli/commands"] }; var json = JsonSerializer.Serialize(value, _jsonOptions); diff --git a/src/Mintlify.Tests.Core/Converters/NavigationPageListConverterTests.cs b/src/Mintlify.Tests.Core/Converters/NavigationPageListConverterTests.cs index b744f9c..076fd0c 100644 --- a/src/Mintlify.Tests.Core/Converters/NavigationPageListConverterTests.cs +++ b/src/Mintlify.Tests.Core/Converters/NavigationPageListConverterTests.cs @@ -64,7 +64,7 @@ public void NavigationPageListConverter_SerializeMixedArray_ReturnsJsonArray() new GroupConfig { Group = "Advanced", - Pages = new List { "advanced/topic1" } + Pages = ["advanced/topic1"] } }; diff --git a/src/Mintlify.Tests.Core/DocsJsonManagerInternalTests.cs b/src/Mintlify.Tests.Core/DocsJsonManagerInternalTests.cs index e4d42aa..34ff749 100644 --- a/src/Mintlify.Tests.Core/DocsJsonManagerInternalTests.cs +++ b/src/Mintlify.Tests.Core/DocsJsonManagerInternalTests.cs @@ -55,7 +55,7 @@ public void LoadInternal_InvalidJson_AddsJsonError() manager.LoadInternal(invalidJson); manager.Configuration.Should().BeNull(); - manager.ConfigurationErrors.Should().HaveCount(1); + manager.ConfigurationErrors.Should().ContainSingle(); manager.ConfigurationErrors[0].ErrorNumber.Should().Be("JSON"); } @@ -71,7 +71,7 @@ public void LoadInternal_NullDeserialization_AddsError() manager.LoadInternal(nullJson); manager.Configuration.Should().BeNull(); - manager.ConfigurationErrors.Should().HaveCount(1); + manager.ConfigurationErrors.Should().ContainSingle(); manager.ConfigurationErrors[0].ErrorNumber.Should().Be("JSON"); manager.ConfigurationErrors[0].ErrorText.Should().Contain("Failed to deserialize"); } @@ -86,7 +86,7 @@ public void LoadInternal_ClearsPreviousErrors() // First load with invalid JSON manager.LoadInternal("{ invalid }"); - manager.ConfigurationErrors.Should().HaveCount(1); + manager.ConfigurationErrors.Should().ContainSingle(); // Second load with valid JSON var validJson = """{"name": "Test", "navigation": {"pages": ["index"]}}"""; @@ -141,7 +141,7 @@ public void ValidateConfiguration_MissingNavigation_AddsWarning() //manager.ValidateConfiguration(); // Method removed - validation moved to DocsJsonValidator - manager.ConfigurationErrors.Should().HaveCount(1); + manager.ConfigurationErrors.Should().ContainSingle(); manager.ConfigurationErrors[0].IsWarning.Should().BeTrue(); manager.ConfigurationErrors[0].ErrorText.Should().Contain("Navigation"); } @@ -161,7 +161,7 @@ public void ValidateConfiguration_EmptyNavigation_AddsWarning() //manager.ValidateConfiguration(); // Method removed - validation moved to DocsJsonValidator - manager.ConfigurationErrors.Should().HaveCount(1); + manager.ConfigurationErrors.Should().ContainSingle(); manager.ConfigurationErrors[0].IsWarning.Should().BeTrue(); } @@ -177,7 +177,7 @@ public void ValidateConfiguration_ValidConfiguration_NoErrors() Name = "Test API", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }; @@ -203,7 +203,7 @@ public void MergeNavigation_NullSource_DoesNotModifyTarget() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); var target = manager.Configuration!.Navigation; @@ -227,19 +227,19 @@ public void MergeNavigation_AllProperties_MergesCorrectly() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" }, - Groups = new List { new GroupConfig { Group = "API" } }, - Tabs = new List { new TabConfig { Tab = "Docs" } }, - Anchors = new List { new AnchorConfig { Anchor = "anchor1" } } + Pages = ["index"], + Groups = [new GroupConfig { Group = "API" }], + Tabs = [new TabConfig { Tab = "Docs" }], + Anchors = [new AnchorConfig { Anchor = "anchor1" }] } }); var source = new NavigationConfig { - Pages = new List { "quickstart" }, - Groups = new List { new GroupConfig { Group = "Guides" } }, - Tabs = new List { new TabConfig { Tab = "Examples" } }, - Anchors = new List { new AnchorConfig { Anchor = "anchor2" } }, + Pages = ["quickstart"], + Groups = [new GroupConfig { Group = "Guides" }], + Tabs = [new TabConfig { Tab = "Examples" }], + Anchors = [new AnchorConfig { Anchor = "anchor2" }], Global = new GlobalNavigationConfig() }; @@ -284,7 +284,7 @@ public void MergePagesList_SameGroupNames_MergesGroups() new GroupConfig { Group = "API", - Pages = new List { "api/overview" } + Pages = ["api/overview"] } }; @@ -293,7 +293,7 @@ public void MergePagesList_SameGroupNames_MergesGroups() new GroupConfig { Group = "API", - Pages = new List { "api/reference" } + Pages = ["api/reference"] } }; @@ -351,7 +351,7 @@ public void MergeGroupsList_SameNames_CombinesGroups() new GroupConfig { Group = "API", - Pages = new List { "api/overview" } + Pages = ["api/overview"] } }; @@ -360,14 +360,14 @@ public void MergeGroupsList_SameNames_CombinesGroups() new GroupConfig { Group = "API", - Pages = new List { "api/reference" } + Pages = ["api/reference"] } }; var manager = new DocsJsonManager(); manager.MergeGroupsList(sourceGroups, targetGroups); - targetGroups.Should().HaveCount(1); + targetGroups.Should().ContainSingle(); var apiGroup = targetGroups.FirstOrDefault(g => g.Group == "API"); apiGroup.Should().NotBeNull(); apiGroup!.Pages.Should().HaveCount(2); @@ -469,16 +469,16 @@ public void MergeGroupsList_WithMatchingGroups_PreservesTemplateOrder() // Template groups in specific order var targetGroups = new List { - new GroupConfig { Group = "Zebra", Pages = new List { "z1" } }, - new GroupConfig { Group = "Apple", Pages = new List { "a1" } }, - new GroupConfig { Group = "Middle", Pages = new List { "m1" } } + new GroupConfig { Group = "Zebra", Pages = ["z1"] }, + new GroupConfig { Group = "Apple", Pages = ["a1"] }, + new GroupConfig { Group = "Middle", Pages = ["m1"] } }; // Source groups with some matching names var sourceGroups = new List { - new GroupConfig { Group = "Apple", Pages = new List { "a2" } }, - new GroupConfig { Group = "New Group", Pages = new List { "n1" } } + new GroupConfig { Group = "Apple", Pages = ["a2"] }, + new GroupConfig { Group = "New Group", Pages = ["n1"] } }; var manager = new DocsJsonManager(); @@ -515,7 +515,7 @@ public void MergeTabsList_SameNames_CombinesTabs() new TabConfig { Tab = "API", - Pages = new List { "api/overview" } + Pages = ["api/overview"] } }; @@ -524,7 +524,7 @@ public void MergeTabsList_SameNames_CombinesTabs() new TabConfig { Tab = "API", - Pages = new List { "api/reference" } + Pages = ["api/reference"] } }; @@ -537,7 +537,7 @@ public void MergeTabsList_SameNames_CombinesTabs() }); manager.MergeTabsList(sourceTabs, targetTabs); - targetTabs.Should().HaveCount(1); + targetTabs.Should().ContainSingle(); var apiTab = targetTabs.FirstOrDefault(t => t.Tab == "API"); apiTab.Should().NotBeNull(); apiTab!.Pages.Should().HaveCount(2); @@ -555,7 +555,7 @@ public void MergeTabsList_SameHref_CombinesTabs() { Tab = "Documentation", Href = "/docs", - Pages = new List { "intro" } + Pages = ["intro"] } }; @@ -565,7 +565,7 @@ public void MergeTabsList_SameHref_CombinesTabs() { Tab = "Docs", Href = "/docs", - Pages = new List { "quickstart" } + Pages = ["quickstart"] } }; @@ -578,7 +578,7 @@ public void MergeTabsList_SameHref_CombinesTabs() }); manager.MergeTabsList(sourceTabs, targetTabs); - targetTabs.Should().HaveCount(1); + targetTabs.Should().ContainSingle(); var tab = targetTabs[0]; tab.Tab.Should().Be("Docs"); // Source takes precedence tab.Href.Should().Be("/docs"); @@ -630,7 +630,7 @@ public void MergeGroupConfig_AllProperties_MergesCorrectly() var target = new GroupConfig { Group = "API", - Pages = new List { "api/overview" } + Pages = ["api/overview"] }; var source = new GroupConfig @@ -641,7 +641,7 @@ public void MergeGroupConfig_AllProperties_MergesCorrectly() Icon = "api-icon", AsyncApi = "async-config", OpenApi = "openapi-config", - Pages = new List { "api/reference" } + Pages = ["api/reference"] }; var manager = new DocsJsonManager(); @@ -665,13 +665,13 @@ public void MergeGroupConfig_NullTargetPages_CopiesSourcePages() var target = new GroupConfig { Group = "API" }; var source = new GroupConfig { - Pages = new List { "api/reference" } + Pages = ["api/reference"] }; var manager = new DocsJsonManager(); manager.MergeGroupConfig(target, source); - target.Pages.Should().HaveCount(1); + target.Pages.Should().ContainSingle(); target.Pages.Should().Contain("api/reference"); } @@ -688,7 +688,7 @@ public void MergeTabConfig_AllProperties_MergesCorrectly() var target = new TabConfig { Tab = "API", - Pages = new List { "api/overview" } + Pages = ["api/overview"] }; var source = new TabConfig @@ -698,12 +698,12 @@ public void MergeTabConfig_AllProperties_MergesCorrectly() Icon = "api-icon", AsyncApi = "async-config", OpenApi = "openapi-config", - Pages = new List { "api/reference" }, - Groups = new List { new GroupConfig { Group = "Endpoints" } }, - Anchors = new List { new AnchorConfig { Anchor = "test" } }, - Dropdowns = new List { new DropdownConfig { Dropdown = "dropdown" } }, - Languages = new List { new LanguageConfig { Language = "en" } }, - Versions = new List { new VersionConfig { Version = "v1" } }, + Pages = ["api/reference"], + Groups = [new GroupConfig { Group = "Endpoints" }], + Anchors = [new AnchorConfig { Anchor = "test" }], + Dropdowns = [new DropdownConfig { Dropdown = "dropdown" }], + Languages = [new LanguageConfig { Language = "en" }], + Versions = [new VersionConfig { Version = "v1" }], Global = new GlobalNavigationConfig() }; @@ -716,11 +716,11 @@ public void MergeTabConfig_AllProperties_MergesCorrectly() ((string?)target.AsyncApi).Should().Be("async-config"); ((string?)target.OpenApi).Should().Be("openapi-config"); target.Pages.Should().HaveCount(2); - target.Groups.Should().HaveCount(1); - target.Anchors.Should().HaveCount(1); - target.Dropdowns.Should().HaveCount(1); - target.Languages.Should().HaveCount(1); - target.Versions.Should().HaveCount(1); + target.Groups.Should().ContainSingle(); + target.Anchors.Should().ContainSingle(); + target.Dropdowns.Should().ContainSingle(); + target.Languages.Should().ContainSingle(); + target.Versions.Should().ContainSingle(); target.Global.Should().NotBeNull(); } @@ -733,17 +733,17 @@ public void MergeTabConfig_NullCollections_InitializesCollections() var target = new TabConfig { Tab = "API" }; var source = new TabConfig { - Pages = new List { "page1" }, - Groups = new List { new GroupConfig { Group = "group1" } }, - Anchors = new List { new AnchorConfig { Anchor = "anchor1" } } + Pages = ["page1"], + Groups = [new GroupConfig { Group = "group1" }], + Anchors = [new AnchorConfig { Anchor = "anchor1" }] }; var manager = new DocsJsonManager(); manager.MergeTabConfig(target, source); - target.Pages.Should().HaveCount(1); - target.Groups.Should().HaveCount(1); - target.Anchors.Should().HaveCount(1); + target.Pages.Should().ContainSingle(); + target.Groups.Should().ContainSingle(); + target.Anchors.Should().ContainSingle(); } #endregion @@ -796,7 +796,7 @@ public void ApplyUrlPrefixToPages_MixedContent_AppliesPrefixToAll() new GroupConfig { Group = "API", - Pages = new List { "api/endpoint" } + Pages = ["api/endpoint"] } }; @@ -830,7 +830,7 @@ public void ApplyUrlPrefixToGroup_ValidGroup_PrefixesRootAndPages() { Group = "API", Root = "api", - Pages = new List { "overview", "reference" } + Pages = ["overview", "reference"] }; manager.ApplyUrlPrefixToGroup(group, "/docs"); @@ -863,15 +863,15 @@ public void ApplyUrlPrefixToTab_ValidTab_PrefixesAllUrls() { Tab = "Examples", Href = "examples", - Pages = new List { "basic" }, - Groups = new List - { + Pages = ["basic"], + Groups = + [ new GroupConfig { Group = "Advanced", - Pages = new List { "advanced/topic" } + Pages = ["advanced/topic"] } - } + ] }; manager.ApplyUrlPrefixToTab(tab, "/docs"); @@ -892,24 +892,24 @@ public void ApplyUrlPrefixToAnchor_NestedStructure_PrefixesAllLevels() { Anchor = "Resources", Href = "resources", - Pages = new List { "links" }, - Groups = new List - { + Pages = ["links"], + Groups = + [ new GroupConfig { Group = "External", - Pages = new List { "external/apis" } + Pages = ["external/apis"] } - }, - Tabs = new List - { + ], + Tabs = + [ new TabConfig { Tab = "Tools", Href = "tools", - Pages = new List { "tools/cli" } + Pages = ["tools/cli"] } - } + ] }; manager.ApplyUrlPrefixToAnchor(anchor, "/v2"); @@ -983,13 +983,13 @@ public void RemoveNullGroups_GroupsWithNullNames_RemovesGroups() Name = "Test", Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ "index", new GroupConfig { Group = null! }, new GroupConfig { Group = "Valid Group" }, "quickstart" - } + ] } }; @@ -1000,7 +1000,7 @@ public void RemoveNullGroups_GroupsWithNullNames_RemovesGroups() manager.Configuration.Navigation.Pages.Should().Contain("quickstart"); manager.Configuration.Navigation.Pages?.OfType().Should().HaveCount(1); manager.Configuration.Navigation.Pages?.OfType().First().Group.Should().Be("Valid Group"); - manager.ConfigurationErrors.Should().HaveCount(1); + manager.ConfigurationErrors.Should().ContainSingle(); manager.ConfigurationErrors[0].ErrorText.Should().Contain("Group with null name found and removed"); } @@ -1016,12 +1016,12 @@ public void RemoveNullGroups_EmptyGroupNames_AddsWarnings() Name = "Test", Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ new GroupConfig { Group = "" }, new GroupConfig { Group = " " }, new GroupConfig { Group = "Valid Group" } - } + ] } }; @@ -1029,8 +1029,8 @@ public void RemoveNullGroups_EmptyGroupNames_AddsWarnings() manager.Configuration.Navigation.Pages.Should().HaveCount(3); manager.ConfigurationErrors.Should().HaveCount(2); - manager.ConfigurationErrors.All(e => e.IsWarning).Should().BeTrue(); - manager.ConfigurationErrors.All(e => e.ErrorText.Contains("Empty group name found")).Should().BeTrue(); + manager.ConfigurationErrors.Should().OnlyContain(e => e.IsWarning); + manager.ConfigurationErrors.Should().OnlyContain(e => e.ErrorText.Contains("Empty group name found")); } /// @@ -1045,20 +1045,20 @@ public void RemoveNullGroups_NestedGroups_CleansRecursively() Name = "Test", Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ new GroupConfig { Group = "Parent Group", - Pages = new List - { + Pages = + [ "page1", new GroupConfig { Group = null! }, new GroupConfig { Group = "Valid Nested" }, "page2" - } + ] } - } + ] } }; @@ -1068,9 +1068,9 @@ public void RemoveNullGroups_NestedGroups_CleansRecursively() parentGroup!.Pages.Should().HaveCount(3); parentGroup.Pages!.Should().Contain("page1"); parentGroup.Pages.Should().Contain("page2"); - parentGroup.Pages!.OfType().Should().HaveCount(1); + parentGroup.Pages!.OfType().Should().ContainSingle(); parentGroup.Pages!.OfType().First().Group.Should().Be("Valid Nested"); - manager.ConfigurationErrors.Should().HaveCount(1); + manager.ConfigurationErrors.Should().ContainSingle(); manager.ConfigurationErrors[0].ErrorText.Should().Contain("Nested group with null name found and removed"); } @@ -1086,13 +1086,13 @@ public void RemoveNullGroups_NavigationGroups_CleansGroupsList() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" }, - Groups = new List - { + Pages = ["index"], + Groups = + [ new GroupConfig { Group = "Valid Group" }, new GroupConfig { Group = null! }, new GroupConfig { Group = "" } - } + ] } }; @@ -1118,16 +1118,16 @@ public void RemoveNullGroups_ValidConfiguration_PreservesUnchanged() Name = "Test", Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ "index", new GroupConfig { Group = "API Reference", - Pages = new List { "api/overview" } + Pages = ["api/overview"] }, "quickstart" - } + ] } }; @@ -1153,21 +1153,21 @@ public void RemoveNullGroups_MixedInvalidScenarios_HandlesCorrectly() Name = "Test", Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ "index", new GroupConfig { Group = null! }, new GroupConfig { Group = "Parent", - Pages = new List - { + Pages = + [ new GroupConfig { Group = "" }, new GroupConfig { Group = null! } - } + ] }, new GroupConfig { Group = "Valid" } - } + ] } }; @@ -1177,7 +1177,7 @@ public void RemoveNullGroups_MixedInvalidScenarios_HandlesCorrectly() manager.Configuration.Navigation.Pages.Should().Contain("index"); var parentGroup = manager.Configuration.Navigation.Pages?.OfType().First(g => g.Group == "Parent"); - parentGroup!.Pages!.Should().HaveCount(1); // Only empty group remains + parentGroup!.Pages!.Should().ContainSingle(); // Only empty group remains manager.ConfigurationErrors.Should().HaveCount(3); // 1 root null + 1 nested null + 1 nested empty warning manager.ConfigurationErrors.Count(e => !e.IsWarning).Should().Be(2); // 2 null groups @@ -1248,14 +1248,14 @@ public void PopulateNavigationFromPath_ExistingGroupPartialPages_AddsMissingPage Name = "Test", Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ new GroupConfig { Group = "Learnings", - Pages = new List { "learnings/bridge-assemblies" } + Pages = ["learnings/bridge-assemblies"] } - } + ] } }); @@ -1350,7 +1350,7 @@ public void PopulateNavigationFromPath_NewDirectories_CreatesNewGroups() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); @@ -1475,7 +1475,7 @@ public void PopulateNavigationFromPath_NavigationJsonOverride_UsesCustomNavigati Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); @@ -1528,7 +1528,7 @@ public void PopulateNavigationFromPath_NonMatchingExtensions_Ignored() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); @@ -1548,7 +1548,7 @@ public void PopulateNavigationFromPath_NonMatchingExtensions_Ignored() // Should only include the MDX file in Getting Started var gettingStartedGroup = manager.Configuration!.Navigation.Pages?.OfType().FirstOrDefault(g => g.Group == "Getting Started"); gettingStartedGroup.Should().NotBeNull(); - gettingStartedGroup!.Pages.Should().HaveCount(1); + gettingStartedGroup!.Pages.Should().ContainSingle(); gettingStartedGroup.Pages.Should().Contain("valid"); } finally @@ -1569,7 +1569,7 @@ public void PopulateNavigationFromPath_EmptyDirectories_NoGroupsCreated() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); @@ -1613,7 +1613,7 @@ public void PopulateNavigationFromPath_RootFiles_GroupedUnderGettingStarted() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); @@ -1654,7 +1654,7 @@ public void PopulateNavigationFromPath_ApiReferenceExcluded_WhenIncludeApiRefere Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); @@ -1672,7 +1672,7 @@ public void PopulateNavigationFromPath_ApiReferenceExcluded_WhenIncludeApiRefere manager.PopulateNavigationFromPath(tempDir, [".mdx"], includeApiReference: false, preserveExisting: true); // Should not include api-reference directory - manager.Configuration!.Navigation.Pages.Should().HaveCount(1); // only index + manager.Configuration!.Navigation.Pages.Should().ContainSingle(); // only index manager.Configuration.Navigation.Pages.Should().Contain("index"); } finally @@ -1733,7 +1733,7 @@ public void PopulateNavigationFromPath_DotDirectories_Excluded() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); @@ -1779,7 +1779,7 @@ public void PopulateNavigationFromPath_IndexFiles_SortedFirst() Name = "Test", Navigation = new NavigationConfig { - Pages = new List { "index" } + Pages = ["index"] } }); @@ -1826,15 +1826,15 @@ public void PopulateNavigationFromPath_PreserveExistingFalse_ReplacesNavigation( Name = "Test", Navigation = new NavigationConfig { - Pages = new List - { + Pages = + [ "old-index", new GroupConfig { Group = "Old Group", - Pages = new List { "old/page" } + Pages = ["old/page"] } - } + ] } }); diff --git a/src/Mintlify.Tests.Core/DocsJsonManagerTests.cs b/src/Mintlify.Tests.Core/DocsJsonManagerTests.cs index d727bf7..ed1625f 100644 --- a/src/Mintlify.Tests.Core/DocsJsonManagerTests.cs +++ b/src/Mintlify.Tests.Core/DocsJsonManagerTests.cs @@ -228,7 +228,7 @@ public void Load_InvalidJson_AddsError() manager.Load(invalidJson); manager.Configuration.Should().BeNull(); - manager.ConfigurationErrors.Should().HaveCount(1); + manager.ConfigurationErrors.Should().ContainSingle(); manager.ConfigurationErrors[0].ErrorNumber.Should().Be("JSON"); manager.IsLoaded.Should().BeFalse(); } @@ -458,7 +458,7 @@ public void Merge_NavigationWithDuplicateStringPages_DeduplicatesPages() manager.Configuration!.Navigation!.Pages!.Should().NotBeNull(); manager.Configuration!.Navigation!.Pages!.Should().HaveCount(4); - manager.Configuration!.Navigation!.Pages!.Should().BeEquivalentTo(new[] { "index", "quickstart", "api/overview", "api/reference" }); + manager.Configuration!.Navigation!.Pages!.Should().BeEquivalentTo(["index", "quickstart", "api/overview", "api/reference"]); } /// @@ -515,7 +515,7 @@ public void Merge_NavigationWithDuplicateGroups_MergesGroupsIntelligently() apiGroup.Should().NotBeNull(); apiGroup!.Group.Should().Be("API Reference"); apiGroup!.Pages.Should().HaveCount(4); - apiGroup.Pages.Should().BeEquivalentTo(new[] { "api/overview", "api/authentication", "api/endpoints", "api/errors" }); + apiGroup.Pages.Should().BeEquivalentTo(["api/overview", "api/authentication", "api/endpoints", "api/errors"]); var guidesGroup = manager.Configuration!.Navigation!.Pages![2] as GroupConfig; guidesGroup.Should().NotBeNull(); @@ -796,9 +796,9 @@ public void Merge_GroupsWithNullOrEmptyNames_DefaultBehaviorKeepsSeparate() .ToList(); emptyGroups.Should().HaveCount(3); // Empty groups NOT merged (page1, page2, page5) // The group with page1 still exists but with empty string (null was cleaned to empty) - emptyGroups.Any(g => g.Pages?.Contains("page1") == true).Should().BeTrue(); - emptyGroups.Any(g => g.Pages?.Contains("page2") == true).Should().BeTrue(); - emptyGroups.Any(g => g.Pages?.Contains("page5") == true).Should().BeTrue(); + emptyGroups.Should().Contain(g => g.Pages != null && g.Pages.Contains("page1")); + emptyGroups.Should().Contain(g => g.Pages != null && g.Pages.Contains("page2")); + emptyGroups.Should().Contain(g => g.Pages != null && g.Pages.Contains("page5")); } /// @@ -856,7 +856,7 @@ public void Merge_WithCombineEmptyGroupsOption_MergesEmptyGroups() .OfType() .Where(g => string.IsNullOrWhiteSpace(g.Group)) .ToList(); - emptyGroups.Should().HaveCount(1); // Empty groups merged into one + emptyGroups.Should().ContainSingle(); // Empty groups merged into one emptyGroups[0].Pages.Should().HaveCount(3); // page1, page2 and page5 merged } @@ -1115,7 +1115,7 @@ public void Merge_TabsWithSameHref_CombinesIntelligently() manager.Merge(config2); - manager.Configuration!.Navigation!.Tabs!.Should().HaveCount(1); + manager.Configuration!.Navigation!.Tabs!.Should().ContainSingle(); var mergedTab = manager.Configuration!.Navigation!.Tabs![0]; mergedTab.Tab.Should().Be("Docs"); // Source takes precedence @@ -1518,12 +1518,12 @@ public void PopulateNavigationFromPath_CustomExtensions_OnlyIncludesSpecifiedFil var manager = new DocsJsonManager(); manager.Load("""{"name": "Test"}"""); - manager.PopulateNavigationFromPath(tempPath, new[] { ".mdx" }); + manager.PopulateNavigationFromPath(tempPath, [".mdx"]); - manager.Configuration!.Navigation!.Pages!.Should().HaveCount(1); + manager.Configuration!.Navigation!.Pages!.Should().ContainSingle(); // Root files get grouped into "Getting Started" group var groups = manager.Configuration!.Navigation!.Pages?.OfType().ToList(); - groups.Should().HaveCount(1); + groups.Should().ContainSingle(); var gettingStartedGroup = groups?.FirstOrDefault(g => g.Group == "Getting Started"); gettingStartedGroup.Should().NotBeNull(); gettingStartedGroup!.Pages.Should().Contain("doc2"); @@ -1703,7 +1703,7 @@ public void PopulateNavigationFromPath_DotDirectories_ExcludesFromNavigation() manager.PopulateNavigationFromPath(tempPath, preserveExisting: false); var pages = manager.Configuration!.Navigation!.Pages!; - pages.Should().HaveCount(1); + pages.Should().ContainSingle(); var docsGroup = pages?.OfType().FirstOrDefault(g => g.Group == "Docs"); docsGroup.Should().NotBeNull(); @@ -1739,13 +1739,15 @@ public void PopulateNavigationFromPath_ExcludedDirectories_ExcludesFromNavigatio File.WriteAllText(Path.Combine(tempPath, "CONCEPTUAL", "concept2.mdx"), "# Concept2"); File.WriteAllText(Path.Combine(tempPath, "docs", "index.mdx"), "# Index"); - var manager = new DocsJsonManager(); - manager.Configuration = DocsJsonManager.CreateDefault("Test"); + var manager = new DocsJsonManager + { + Configuration = DocsJsonManager.CreateDefault("Test") + }; manager.PopulateNavigationFromPath(tempPath, preserveExisting: false); var pages = manager.Configuration!.Navigation!.Pages!; - pages.Should().HaveCount(1); + pages.Should().ContainSingle(); var docsGroup = pages?.OfType().FirstOrDefault(g => g.Group == "Docs"); docsGroup.Should().NotBeNull(); @@ -1774,14 +1776,16 @@ public void PopulateNavigationFromPath_MdxOnlySupport_IncludesMdxWarnsAboutMd() File.WriteAllText(Path.Combine(tempPath, "readme.md"), "# Readme MD"); File.WriteAllText(Path.Combine(tempPath, "doc.md"), "# Doc MD"); - var manager = new DocsJsonManager(); - manager.Configuration = DocsJsonManager.CreateDefault("Test"); + var manager = new DocsJsonManager + { + Configuration = DocsJsonManager.CreateDefault("Test") + }; manager.PopulateNavigationFromPath(tempPath, preserveExisting: false); // Should include .mdx files var pages = manager.Configuration!.Navigation!.Pages!; - pages.Should().HaveCount(1); // Root files get grouped into "Getting Started" + pages.Should().ContainSingle(); // Root files get grouped into "Getting Started" var gettingStartedGroup = pages?.OfType().FirstOrDefault(g => g.Group == "Getting Started"); gettingStartedGroup.Should().NotBeNull(); @@ -1895,7 +1899,7 @@ public void PopulateNavigationFromPath_NavigationJsonOverride_ReplacesAutoGenera manager.PopulateNavigationFromPath(tempPath, preserveExisting: false); var pages = manager.Configuration!.Navigation!.Pages!; - pages.Should().HaveCount(1); + pages.Should().ContainSingle(); var cliGroup = pages?.OfType().FirstOrDefault(); cliGroup.Should().NotBeNull(); @@ -1941,12 +1945,12 @@ public void PopulateNavigationFromPath_MalformedNavigationJson_FallsBackToAutoGe // Should have warning about malformed JSON var jsonWarnings = manager.ConfigurationErrors.Where(e => e.ErrorNumber == "NAVIGATION_JSON"); - jsonWarnings.Should().HaveCount(1); + jsonWarnings.Should().ContainSingle(); jsonWarnings.First().ErrorText.Should().Contain("Invalid navigation.json file"); // Should fall back to auto-generation var pages = manager.Configuration!.Navigation!.Pages!; - pages.Should().HaveCount(1); + pages.Should().ContainSingle(); var docsGroup = pages?.OfType().FirstOrDefault(g => g.Group == "Docs"); docsGroup.Should().NotBeNull(); @@ -2014,7 +2018,7 @@ public void PopulateNavigationFromPath_CliStructure_ReplicatesActualStructure() manager.PopulateNavigationFromPath(tempPath, preserveExisting: false); var pages = manager.Configuration!.Navigation!.Pages!; - pages.Should().HaveCount(1); + pages.Should().ContainSingle(); // CLI root should use navigation.json override completely (no auto-generated subdirectories) var cliGroup = pages?.OfType().FirstOrDefault(); @@ -2254,7 +2258,7 @@ public void PopulateNavigationFromPath_NoRootFiles_DoesNotCreateGettingStartedGr manager.PopulateNavigationFromPath(tempPath, preserveExisting: false); var pages = manager.Configuration!.Navigation!.Pages!; - pages.Should().HaveCount(1); // Only Guides group + pages.Should().ContainSingle(); // Only Guides group // Should not have Getting Started group var gettingStartedGroup = pages?.OfType().FirstOrDefault(g => g.Group == "Getting Started"); @@ -2296,7 +2300,7 @@ public void PopulateNavigationFromPath_RootFilesWithIndex_IndexAppearsFirstInGet manager.PopulateNavigationFromPath(tempPath, preserveExisting: false); var pages = manager.Configuration!.Navigation!.Pages!; - pages.Should().HaveCount(1); // Getting Started group only + pages.Should().ContainSingle(); // Getting Started group only var gettingStartedGroup = pages?.OfType().FirstOrDefault(g => g.Group == "Getting Started"); gettingStartedGroup.Should().NotBeNull(); @@ -2589,7 +2593,7 @@ public void ApplyUrlPrefixToPages_WithGroupConfig_AppliesPrefixToGroupPages() var group = new GroupConfig { Group = "Getting Started", - Pages = new List { "index", "quickstart" } + Pages = ["index", "quickstart"] }; var pages = new List { group }; @@ -2609,12 +2613,12 @@ public void ApplyUrlPrefixToPages_WithNestedGroups_AppliesPrefixRecursively() var innerGroup = new GroupConfig { Group = "API Reference", - Pages = new List { "api/overview", "api/methods" } + Pages = ["api/overview", "api/methods"] }; var outerGroup = new GroupConfig { Group = "Documentation", - Pages = new List { "index", innerGroup } + Pages = ["index", innerGroup] }; var pages = new List { outerGroup }; @@ -2637,7 +2641,7 @@ public void ApplyUrlPrefixToPages_WithMixedPagesAndGroups_AppliesPrefixCorrectly var group = new GroupConfig { Group = "Advanced", - Pages = new List { "advanced/configuration" } + Pages = ["advanced/configuration"] }; var pages = new List { "index", group, "faq" }; @@ -2658,7 +2662,7 @@ public void ApplyUrlPrefixToGroup_WithPages_AppliesPrefix() var group = new GroupConfig { Group = "Getting Started", - Pages = new List { "index", "quickstart", "installation" } + Pages = ["index", "quickstart", "installation"] }; manager.ApplyUrlPrefixToGroup(group, "services/auth"); @@ -2677,7 +2681,7 @@ public void ApplyUrlPrefixToTab_WithHrefAndPages_AppliesPrefixToBoth() { Tab = "API", Href = "api", - Pages = new List { "api/overview", "api/reference" } + Pages = ["api/overview", "api/reference"] }; manager.ApplyUrlPrefixToTab(tab, "services/auth"); @@ -2695,14 +2699,14 @@ public void ApplyUrlPrefixToTab_WithGroups_AppliesPrefixToGroupPages() var tab = new TabConfig { Tab = "Documentation", - Groups = new List - { + Groups = + [ new GroupConfig { Group = "Guides", - Pages = new List { "guides/intro", "guides/advanced" } + Pages = ["guides/intro", "guides/advanced"] } - } + ] }; manager.ApplyUrlPrefixToTab(tab, "services/auth"); @@ -2718,15 +2722,15 @@ public void ApplyUrlPrefixToTab_WithAnchors_AppliesPrefixToAnchorPages() var tab = new TabConfig { Tab = "Documentation", - Anchors = new List - { + Anchors = + [ new AnchorConfig { Anchor = "Resources", Icon = "book", - Pages = new List { "resources/overview" } + Pages = ["resources/overview"] } - } + ] }; manager.ApplyUrlPrefixToTab(tab, "services/auth"); @@ -2743,7 +2747,7 @@ public void ApplyUrlPrefixToAnchor_WithHrefAndPages_AppliesPrefixToBoth() Anchor = "Resources", Icon = "book", Href = "resources", - Pages = new List { "resources/docs", "resources/tutorials" } + Pages = ["resources/docs", "resources/tutorials"] }; manager.ApplyUrlPrefixToAnchor(anchor, "services/auth"); @@ -2761,23 +2765,23 @@ public void ApplyUrlPrefixToAnchor_WithGroupsAndTabs_AppliesPrefixRecursively() { Anchor = "Documentation", Icon = "book", - Groups = new List - { + Groups = + [ new GroupConfig { Group = "Guides", - Pages = new List { "guides/intro" } + Pages = ["guides/intro"] } - }, - Tabs = new List - { + ], + Tabs = + [ new TabConfig { Tab = "API", Href = "api", - Pages = new List { "api/reference" } + Pages = ["api/reference"] } - } + ] }; manager.ApplyUrlPrefixToAnchor(anchor, "services/auth"); @@ -2901,17 +2905,17 @@ public void ApplyUrlPrefixToPages_WithMultipleLevelsOfNesting_AppliesPrefixCorre var deeplyNestedGroup = new GroupConfig { Group = "Level 3", - Pages = new List { "level3/page" } + Pages = ["level3/page"] }; var midGroup = new GroupConfig { Group = "Level 2", - Pages = new List { "level2/page", deeplyNestedGroup } + Pages = ["level2/page", deeplyNestedGroup] }; var topGroup = new GroupConfig { Group = "Level 1", - Pages = new List { "level1/page", midGroup } + Pages = ["level1/page", midGroup] }; var pages = new List { topGroup }; diff --git a/test/MultiAssembly.ByAssembly.docsproj b/test/MultiAssembly.ByAssembly.docsproj deleted file mode 100644 index 260f745..0000000 --- a/test/MultiAssembly.ByAssembly.docsproj +++ /dev/null @@ -1,37 +0,0 @@ - - - - - $(MSBuildProjectDirectory)\byassembly-docs\ - Mintlify - Folder - ByAssembly - - - - Multi-Assembly API Documentation - Documentation organized by assembly - mint - - #2E7D32 - #66BB6A - #1B5E20 - #F5F5F5 - #4CAF50 - - - /logo/light.svg - /logo/dark.svg - - /favicon.ico - - - - - - - - - - - \ No newline at end of file diff --git a/test/MultiAssembly.External.docsproj b/test/MultiAssembly.External.docsproj deleted file mode 100644 index d63c113..0000000 --- a/test/MultiAssembly.External.docsproj +++ /dev/null @@ -1,20 +0,0 @@ - - - - - $(MSBuildProjectDirectory)\external-docs\ - Mintlify - Folder - Unified - API Documentation - $(MSBuildProjectDirectory)\docs-template.json - - - - - - - - - - \ No newline at end of file diff --git a/test/MultiAssembly.Unified.docsproj b/test/MultiAssembly.Unified.docsproj deleted file mode 100644 index 67510e1..0000000 --- a/test/MultiAssembly.Unified.docsproj +++ /dev/null @@ -1,37 +0,0 @@ - - - - - $(MSBuildProjectDirectory)\unified-docs\ - Mintlify - Folder - Unified - Complete API Reference - - - - Multi-Assembly API Documentation - Unified documentation for multiple assemblies - mint - - #007ACC - #4FC3F7 - #005A9E - - - /logo/light.svg - /logo/dark.svg - https://example.com - - /favicon.png - - - - - - - - - - - \ No newline at end of file diff --git a/test/docs-template.json b/test/docs-template.json deleted file mode 100644 index 53f3573..0000000 --- a/test/docs-template.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "$schema": "https://mintlify.com/schema.json", - "name": "External Template API Docs", - "description": "Documentation from external template file", - "theme": "prism", - "colors": { - "primary": "#9C27B0", - "light": "#BA68C8", - "dark": "#6A1B9A", - "background": "#FAFAFA", - "anchors": "#AB47BC" - }, - "logo": { - "light": "/logo/light.png", - "dark": "/logo/dark.png", - "href": "https://docs.example.com" - }, - "favicon": "/favicon.png", - "modeToggle": { - "default": "light", - "isHidden": false - }, - "feedback": { - "thumbsRating": true, - "suggestEdit": true - }, - "tabs": [ - { - "name": "API Reference", - "url": "api-reference" - }, - { - "name": "Guides", - "url": "guides" - } - ], - "anchors": [ - { - "name": "GitHub", - "icon": "github", - "url": "https://github.com/example/repo" - }, - { - "name": "Support", - "icon": "slack", - "url": "https://example.slack.com" - } - ] -} \ No newline at end of file