@webdoc parser

This page describes how the parser transforms a file's content into a doc-tree.

Docable

The parser first extracts all the documentation comments from the source file and converts them into a tree of "docables". A docable object will hold the comment, the scope it was written in, and the node is was documenting (if any).

Doctree Build

The docables from all files are sorted in order of increasing scope depth. This is so that top-level namespaces are inserted into the doctree first.