Documentation ¶

This directory contains auto-generated documentation for the UI package.

Structure ¶

• index - Complete function index organized by category
• functions/ - Individual function documentation
• images/ - Example output images

Generating Documentation ¶

To regenerate the documentation:

1make docs

This will:

1. Parse all exported functions from the package
2. Extract GoDoc comments
3. Find example functions
4. Generate markdown files with images
5. Create an organized index

Adding Examples ¶

To add an example for a function, create an Example<FunctionName> function in the test files:

1func ExampleButton() {
2    btn := &Clickable{}
3    widget := Button(btn, "Click Me")
4    ShowWidget(widget)
5}

Viewing Documentation ¶

Browse the documentation by opening index in your markdown viewer or IDE.

This is an auto-generated directory. Do not edit files manually.