Convert existing RDoc comments to YARD @tag format across codebase #95

New issue

Open

opened 2026-03-15 04:13:10 +00:00 by freemo · 0 comments

freemo commented

2026-03-15 04:13:10 +00:00

Owner

Metadata

Commit Message: docs(api): convert RDoc comments to YARD format
Branch: feature/m1-yard-migration

Background and Context

Existing documentation comments in the codebase use RDoc conventions. These need to
be converted to YARD's @param, @return, @raise, @example tag format for
richer documentation output.

Expected Behavior

Method documentation uses @param name [Type] description format
Return values documented with @return [Type] description
Exceptions documented with @raise [ExceptionClass] description
rake yard generates complete documentation with no warnings

Acceptance Criteria

All public method documentation uses YARD tags
rake yard runs with zero undocumented warnings for converted files
Documentation reads correctly in generated HTML

Subtasks

Convert core class comments (GameObject, Player, Mobile, Room, etc.)
Convert Manager and StorageMachine comments
Convert command handler and action comments
Convert trait and utility comments
Run yard stats to verify coverage

Definition of Done

This issue is complete when:

All subtasks above are completed and checked off.
A Git commit is created where the first line of the commit message matches the
Commit Message in Metadata exactly.
The commit is pushed to the remote on the branch matching the Branch in Metadata.
The commit is submitted as a pull request to master, reviewed, and merged.

## Metadata - **Commit Message**: `docs(api): convert RDoc comments to YARD format` - **Branch**: `feature/m1-yard-migration` ## Background and Context Existing documentation comments in the codebase use RDoc conventions. These need to be converted to YARD's `@param`, `@return`, `@raise`, `@example` tag format for richer documentation output. ## Expected Behavior - Method documentation uses `@param name [Type] description` format - Return values documented with `@return [Type] description` - Exceptions documented with `@raise [ExceptionClass] description` - `rake yard` generates complete documentation with no warnings ## Acceptance Criteria - All public method documentation uses YARD tags - `rake yard` runs with zero undocumented warnings for converted files - Documentation reads correctly in generated HTML ## Subtasks - [ ] Convert core class comments (GameObject, Player, Mobile, Room, etc.) - [ ] Convert Manager and StorageMachine comments - [ ] Convert command handler and action comments - [ ] Convert trait and utility comments - [ ] Run `yard stats` to verify coverage ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged**.