Wheels Documentation Generator

What problem does it solve?

This Skill automates the generation of consistent and comprehensive documentation for CFWheels applications, including function comments, model descriptions, and project README files. It ensures your codebase is well-documented, making it easier for teams to understand, maintain, and onboard new developers.

Core Features & Use Cases

• Function Documentation: Provides templates for JSDoc-style comments for functions, including @param and @return tags.
• Model Documentation: Guides on documenting model associations, validations, and overall purpose.
• README Template: Generates a standard project README.md file with sections for description, requirements, installation, configuration, and testing.
• Use Case: Document your authenticate function in a User model. This skill provides the correct JSDoc-style comment structure, including @param and @return tags, making your code easier to understand and maintain for anyone working on the project.

Quick Start

/**

• Authenticate user with email and password
• @param email User's email address
• @param password User's password (plain text)
• @return User object if authenticated, false otherwise */ public any function authenticate(required string email, required string password) {

  ...

}