wheels-documentation-generator

name	Wheels Documentation Generator
description	Generate documentation comments, README files, and API documentation for Wheels applications. Use when documenting code, creating project READMEs, or generating API docs.

Wheels Documentation Generator

Function Documentation

/**
 * 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) {
    // Implementation
}

Model Documentation

/**
 * Post Model
 *
 * Represents a blog post with associated comments and tags.
 *
 * Associations:
 * - hasMany: comments (dependent delete)
 * - hasManyThrough: tags (through postTags)
 * - belongsTo: user
 *
 * Validations:
 * - title: presence, length (3-200)
 * - slug: presence, uniqueness
 * - content: presence, minimum length (10)
 */
component extends="Model" {
    // Implementation
}

README Template

# Project Name

## Description

Brief description of the application.

## Requirements

- CFWheels 3.0+
- Lucee 5.x / Adobe ColdFusion 2018+
- Database (MySQL, PostgreSQL, SQL Server)

## Installation

1. Clone repository
2. Run migrations: `wheels dbmigrate latest`
3. Start server: `wheels server start`

## Configuration

Configure database in `config/database.cfm`

## Testing

Run tests: `wheels test run`

## License

MIT

---

Generated by: Wheels Documentation Generator Skill v1.0