Code Listener  [unstable] git snapshot
doxygen.h
Go to the documentation of this file.
1 // This file contains no code inside
2 
3 /**
4  * @file doxygen.h
5  * @brief Doxygen documentation (common part)
6  */
7 
8 /**
9  * @mainpage
10  * @note See the
11  * <A HREF="http://www.fit.vutbr.cz/research/groups/verifit/tools/code-listener/"><B>project page</B></A>
12  * for details about the <B>Code Listener</B> project, new releases, etc.
13  * @version @include version_cl.h
14  *
15  * @remark
16  *
17  * - an entry point for @b easy analyzers: easy.hh
18  * - clEasyRun()
19  *
20  * - code listener API: code_listener.h
21  * - struct cl_operand
22  * - struct cl_type
23  * - struct cl_accessor
24  *
25  * - code storage API: storage.hh
26  * - CodeStorage::Storage
27  * - CodeStorage::Fnc
28  * - CodeStorage::ControlFlow
29  * - CodeStorage::Block
30  * - CodeStorage::Insn
31  * - CodeStorage::Var
32  *
33  * - listeners:
34  * - cl_pp.hh
35  * - cl_locator.hh
36  * - cl_dotgen.hh
37  * - cl_typedot.hh
38  * - cl_storage.hh
39  * - cl_easy.hh
40  *
41  * - filters:
42  * - clf_intchk.hh
43  * - clf_unilabel.hh
44  * - clf_unswitch.hh
45  *
46  * - error/warning messages: cl_msg.hh
47  * - #CL_ERROR, #CL_ERROR_MSG
48  * - #CL_WARN, #CL_WARN_MSG
49  * - #CL_NOTE, #CL_NOTE_MSG
50  * - #CL_DEBUG, #CL_DEBUG_MSG
51  *
52  * - other utilities: clutil.hh
53  * - targetTypeOfPtr()
54  * - seekRefAccessor()
55  * - intCstFromOperand()
56  * - varIdFromOperand()
57  * - traverseTypeIc()
58  *
59  * - internals: cl.hh, cl_filter.hh, cl_factory.hh
60  * - ICodeListener
61  * - ClFilterBase
62  * - ClFactory
63  *
64  * - configuration: config_cl.h
65  */