From 52ec8180fb050afae4123efbbd3a6937e303ef0b Mon Sep 17 00:00:00 2001 From: Alexandre Bique Date: Tue, 7 Apr 2009 18:09:30 +0100 Subject: [PATCH] [doc] added some description on symbols --- doc/mainpage.doch | 1 + src/ozulis/visitors/scope-builder.doch | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/doc/mainpage.doch b/doc/mainpage.doch index bf638f4..bfef866 100644 --- a/doc/mainpage.doch +++ b/doc/mainpage.doch @@ -7,5 +7,6 @@ * @li @ref conventions "Conventions" * * @section Internals + * @li @ref scopebuilder "Scope builder" * @li @ref typechecking "Type checking" */ diff --git a/src/ozulis/visitors/scope-builder.doch b/src/ozulis/visitors/scope-builder.doch index 7d53359..9e660a2 100644 --- a/src/ozulis/visitors/scope-builder.doch +++ b/src/ozulis/visitors/scope-builder.doch @@ -11,6 +11,14 @@ * at the moment). * - => You can not use the ScopeBuilder two times on the same AST. * + * @subsection symbols Symbols + * What is a symbol ? A data structure which describe 3 things: + * - the name of the symbol. + * - the type of the symbol. + * - the address of the symbol. An address can be: + * - a register address + * - a memory address. Usually it is scope's prefix + symbol's name. + * * @subsection global_scope Global scope * This scope is the first scope. It has no parents. * Symbol addresses are prefixed with `@'. -- 2.11.4.GIT