Contract Documentation Site Generator

WHAT IT DOES

This tool connects to your EVM wallet and generates comprehensive documentation websites from smart contract source code, ABI, and natspec comments. It reads contract source code to extract function definitions, parameters, return types, and visibility modifiers. It parses natspec comments (@title, @author, @notice, @param, @return, @dev) to include developer annotations in the documentation. Optionally, it reads ABI input to enhance function signatures and event definitions. The tool produces a clean, dark-themed HTML documentation page with organized sections for contract overview, functions, events, and usage examples.

HOW TO USE

Connect your Web3 wallet using the Connect button. Enter the contract name in the Contract Name field. Paste your contract source code in the Contract Source Code field. Optionally, paste the contract ABI in JSON format in the ABI field to enhance documentation. Click "Generate Docs" to produce the documentation site. Click "Load Sample" to populate fields with an example token contract. Results appear in the Results card with the contract name, function count, ABI status, and a detailed documentation page with sections for the contract overview, functions (with natspec annotations), events, and a usage example.

TECHNICAL MECHANISM: SOURCE CODE PARSING AND DOCUMENTATION GENERATION

The tool uses regular expression pattern matching to parse contract source code. It extracts function declarations using a regex that captures function name, parameters, visibility modifiers, state mutability, and return types. Parameter and return types are parsed into structured lists. Natspec comments are extracted by searching for ///@ tags preceding function definitions, capturing tags like title, author, notice, param, return, and dev. Events are extracted separately. The tool combines source code analysis with optional ABI input to generate a comprehensive documentation page. The output is formatted as HTML with a dark theme consistent with the tool's design, featuring collapsible sections and readable typography.

WHAT IT CANNOT SEE

This tool cannot interpret contract semantics or generate accurate usage examples without human input—usage examples are generic and require manual refinement. It cannot generate documentation for contracts without natspec or well-commented source code—the quality of documentation depends on the source code's comments. It cannot verify that generated documentation accurately reflects contract behavior—the tool performs static analysis only. It relies on source code parsing and may not handle all documentation formats or styles—custom patterns may not be detected. It cannot include external dependencies or context in generated documentation—the tool only uses the provided source and ABI.

PLEASE NOTE

This is a read-only tool—it never signs transactions. All data is processed in-memory and never persists. The tool supports EVM chains only—Ethereum, Polygon, BSC, Arbitrum, Optimism, Avalanche, Base, and Fantom. The generated documentation is a starting point and should be reviewed and refined by developers. Natspec comments are essential for high-quality documentation—encourage thorough commenting in contract source code.