Decode
A Ruby code analysis tool and documentation generator.
Motivation
As part of my effort to build better project documentation, I needed a better code analysis tool. While less featured than some of the more mature alternatives, this library focuses on the needs of documentation generation, including speed, cross-referencing and (eventually) multi-language support.
Usage
Please browse the source code index or refer to the guides below.
Getting Started
No description.
Code Coverage
No description.
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.
Contributing
We welcome contributions to this project.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request