Module quick_ref

Module quick_ref 

Source
Expand description

Quick Reference table generation for module documentation.

This module provides QuickRefGenerator which generates a markdown table summarizing all public items in a module at a glance. The table shows item name, kind, and first-sentence description.

§Example Output

## Quick Reference

| Item | Kind | Description |
|------|------|-------------|
| [`Parser`](#parser) | struct | JSON parser with streaming support |
| [`Value`](#value) | enum | Dynamic JSON value type |
| [`parse`](#parse) | fn | Parses a JSON string into a Value |

Structs§

QuickRefEntry
An entry in the quick reference table.
QuickRefGenerator
Generator for markdown quick reference tables.

Functions§

extract_summary
Extract the first sentence from a documentation string.