Documentation - VB6Semantic

Getting oriented

Documentation Overview

VB6Semantic provides comprehensive documentation for both API usage and the internal workings of the semantic analysis system. Whether you're using the library or contributing to it, you'll find the information you need here.

API Documentation

Getting Started

Step-by-step tutorial covering installation, basic analysis, error handling, and common use cases.

Installation and setup
Your first analysis
Error handling patterns
Analyzer usage examples
Common use cases

API Reference (docs.rs)

Complete Rust API documentation with examples for all public types, functions, and modules. Generated from inline documentation comments.

All public APIs documented
Usage examples
Type signatures and traits
Module organization

Code Examples

Practical examples demonstrating how to use VB6Semantic for common tasks.

Symbol table construction
Name resolution and type checking
Working with scopes and visibility
Query system usage

Crates.io Package

Official package page with version history, dependencies, and installation instructions.

Version history and downloads
Dependency information
README and quick start
License and metadata

Technical Documentation

Deep-dive technical specifications and architecture documentation for understanding the VB6 semantic analysis system and its core components.

Symbol Tables

Complete reference for the symbol table system: how symbols are created, stored, queried, and resolved across VB6 modules.

Symbol types and categories
Symbol table construction algorithm
Scope hierarchy and VB6 scoping rules
Visibility enforcement (Public/Private/Friend)
Name resolution process
Symbol query APIs

Topics covered: Variable, constant, procedure, property, class, control, enum, and user-defined type symbols, symbol lifecycle, scope chain traversal, qualified name resolution, accessibility checks

Query System

Reference for the query system that provides structured access to the semantic model.

Query system architecture
Query API and composable operations
Symbol queries and filtering
Reference and definition queries
Integration with the semantic model
Performance considerations

Topics covered: Layered pipeline architecture, query composable interfaces, semantic model access patterns, IDE feature support, efficient traversal strategies

Testing & Performance

Comprehensive testing and code coverage metrics demonstrating code quality and analyzer efficiency.

Test Coverage Report

Comprehensive test coverage metrics for the semantic analysis system.

Line, function, and region coverage percentages
File-by-file coverage breakdown
Interactive coverage explorer
Real-time filtering and search

Topics covered: Coverage metrics from cargo llvm-cov, unit tests, integration tests, library tests, documentation tests

VB6Semantic / Documentation