DecodeGuides

Guides

Getting Started

This guide explains how to use decode for source code analysis.

Documentation Coverage

This guide explains how to test and monitor documentation coverage in your Ruby projects using the Decode gem's built-in bake tasks.

Extract Symbols

This example demonstrates how to extract symbols using the index. An instance of class Decode::Index is used for loading symbols from source code files. These symbols are available as a flat list and as a trie structure. You can look up specific symbols using a reference using Decode::Index#lookup.

Ruby Documentation

This guide covers documentation practices and pragmas supported by the Decode gem for documenting Ruby code. These pragmas provide structured documentation that can be parsed and used to generate API documentation and achieve complete documentation coverage.