API Documentation (RDoc)¶
This section contains the automatically generated Ruby API documentation for the Ragdoll gems, created using RDoc.
Available Documentation¶
Ragdoll Core Library¶
Comprehensive API documentation for the core Ragdoll gem, including all classes, modules, and methods.
Coverage: 56.32% documented (87 total elements: 38 undocumented)
Ragdoll CLI Library¶
Complete API documentation for the Ragdoll command-line interface gem.
Coverage: 2.25% documented (89 total elements: 87 undocumented)
About RDoc Documentation¶
RDoc documentation is automatically generated from the Ruby source code and includes:
- Class hierarchies and relationships
- Method signatures and parameters
- Inline code documentation
- Example usage where available
- Source code links
Using the API Documentation¶
The RDoc documentation opens in a new tab/window and provides:
- Navigation sidebar - Browse classes and modules
- Search functionality - Find specific methods or classes
- Source code links - View the actual implementation
- Cross-references - Follow relationships between classes
Development Note¶
The documentation coverage shows significant opportunities for improvement, particularly in the CLI library. Contributing inline documentation to the source code would greatly enhance the API reference quality.
Integration with Main Documentation¶
This RDoc API documentation complements the main Ragdoll documentation:
- User Guide - How to use the features
- API Reference - High-level client methods
- RDoc Documentation (this section) - Low-level implementation details
RDoc documentation generated from Ragdoll v0.1.10 source code