Create Oo Component Documentation

What it does

This skill generates documentation for object-oriented components, such as classes and interfaces, in a structured format. It extracts details like properties, methods, parameters, return types, and usage examples from the code to create clear, developer-friendly documentation.

When to use it

• You need to document a new class or interface in your codebase.
• You're maintaining legacy code and want to generate up-to-date API references.
• Your team requires consistent formatting for all component documentation.
• You are preparing documentation for external developers or users of your library.

Key capabilities

• Parses object-oriented code (e.g., classes, interfaces).
• Extracts method signatures, parameters, return types, and descriptions.
• Generates structured documentation in formats like Markdown or HTML.
• Supports common programming languages such as TypeScript, Java, and C#.

Example prompts

• "Generate documentation for the UserRepository class."
• "Create API reference for all interfaces in the services module."
• "Write a detailed description of the calculateTotal() method in the OrderService class."

Tips & gotchas

• Ensure your code is well-commented with JSDoc or similar syntax to get accurate documentation.
• This skill may not handle complex inheritance or polymorphism without additional configuration.