Add outline to module docs

Author: John Nonweiler

src/analyses/README.md

@@ -6,5 +6,112 @@
 This contains the abstract interpretation framework `ai.h` and several
 static analyses that instantiate it.
 
-FIXME: put here a good introduction describing what is contained
-in this folder.
+\section analyses-frameworks Frameworks:
+
+\subsection analyses-ait Abstract interpreter framework (ait)
+
+To be documented.
+
+\subsection analyses-static-analysist Old Abstract interpreter framework (static_analysist)
+
+This is obsolete.
+
+\subsection analyses-flow-insensitive-analysis Flow-insensitive analysis (flow_insensitive_analysist)
+
+To be documented.
+
+\section analyses-specific-analyses Specific analyses:
+
+\subsection analyses-call-graph Call graph and associated helpers (call_grapht)
+
+To be documented.
+
+\subsection analyses-dominator Dominator analysis (cfg_dominators_templatet)
+
+To be documented.
+
+\subsection analyses-constant-propagation Constant propagation (constant_propagator_ait)
+
+To be documented.
+
+\subsection analyses-taint Taint analysis (custom_bitvector_analysist)
+
+To be documented.
+
+\subsection analyses-dependence-graph Data- and control-dependence analysis (dependence_grapht)
+
+To be documented.
+
+\subsection analyses-dirtyt Address-taken lvalue analysis (dirtyt)
+
+To be documented.
+
+\subsection analyses-const-cast-removal const_cast removal analysis (does_remove_constt)
+
+To be documented.
+
+\subsection analyses-escape Escape analysis (escape_analysist)
+
+To be documented.
+
+\subsection analyses-global-may-alias Global may-alias analysis (global_may_aliast)
+
+To be documented.
+
+\subsection analyses-rwt Read-write range analysis (goto_rwt)
+
+To be documented.
+
+\subsection analyses-invariant-propagation Invariant propagation (invariant_propagationt)
+
+To be documented.
+
+\subsection analyses-is-threaded Multithreaded program detection (is_threadedt)
+
+To be documented.
+
+\subsection analyses-pointer-classification Pointer classification analysis (is-heap-pointer, might-be-null, etc -- local_bitvector_analysist)
+
+To be documented.
+
+\subsection analyses-cfg Control-flow graph (local_cfgt)
+
+To be documented.
+
+\subsection analyses-local-may-alias Local may-alias analysis (local_may_aliast)
+
+To be documented.
+
+\subsection analyses-safe-dereference Safe dereference analysis (local_safe_pointerst)
+
+To be documented.
+
+\subsection analyses-locals Address-taken locals analysis (localst)
+
+To be documented.
+
+\subsection analyses-natural-loop Natural loop analysis (natural_loops_templatet)
+
+To be documented.
+
+\subsection analyses-reaching-definitions Reaching definitions (reaching_definitions_analysist)
+
+To be documented.
+
+\subsection analyses-uncaught-exceptions Uncaught exceptions analysis (uncaught_exceptions_domaint)
+
+To be documented.
+
+\subsection analyses-uninitialized-locals Uninitialized locals analysis (uninitialized_analysist)
+
+To be documented.
+
+\section analyses-transformations Transformations (arguably in the wrong directory):
+
+\subsection analyses-goto-checkt Pointer / overflow / other check insertion (goto_checkt)
+
+To be documented.
+
+\subsection analyses-interval-analysist Integer interval analysis (interval_analysist) -- both an analysis and a transformation
+
+To be documented.

src/langapi/README.md

@@ -10,3 +10,23 @@ language front ends. Developers only really need look at this if they
 are adding support for a new language. It’s main users are the
 language front-ends such as `ansi-c/` and
 `cpp/`.
+
+\section langapi-languaget The languaget interface
+
+To be documented.
+
+\section langapi-language-files Language files (language_filet, language_filest)
+
+To be documented.
+
+\section langapi-manipulation-framework The top-level language-file manipulation framework (language_uit, obsolete, replaced by initialize_goto_model)
+
+To be documented.
+
+\section langapi-mode-related-utils Symbol mode-related utilities (everything in mode.h)
+
+To be documented.
+
+\section langapi-pretty-printing Pretty-printing expressions and types (language_util.h)
+
+To be documented.

src/pointer-analysis/README.md

@@ -10,3 +10,45 @@ arbitrary pointers, some alias analysis is needed.  `pointer-analysis`
 contains the three levels of analysis; flow and context insensitive,
 context sensitive and flow and context sensitive. The code needed is
 subtle and sophisticated and thus there may be bugs.
+
+\section pointer-analysis-utilities Utilities:
+
+\subsection pointer-analysis-object-numbering Object / expression numbering (object_numberingt)
+
+To be documented.
+
+\subsection pointer-analysis-pointer-offset-sum Pointer-offset sum (pointer_offset_sum)
+
+To be documented.
+
+\subsection pointer-analysis-rewrite-index Rewrite index (x[i] -> *(x+i)) (rewrite_index)
+
+To be documented.
+
+\section pointer-analysis-analysis Value-set Analysis:
+
+To be documented.
+
+\subsection pointer-analysis-variants Variants:
+
+\subsubsection pointer-analysis-flow-insensitive Flow-insensitive
+
+To be documented.
+
+\subsubsection pointer-analysis-flow-insensitive-with-vr Flow-insensitive with 'vr' (value reduction?)
+
+To be documented.
+
+\subsubsection pointer-analysis-flow-insensitive-with-vr-ns Flow-insensitive with 'vr' and 'ns' (value reduction, ???)
+
+To be documented.
+
+\section pointer-analysis-transformations Transformations:
+
+\subsection pointer-analysis-add-failed-symbols
+
+This is obsolete.
+
+\subsection pointer-analysis-dereference-removal Dereference removal (*x -> x == &o1 ? o1 : ...) -- dereferencet, dereference_callbackt, value_set_dereferencet, goto_program_dereferencet, etc
+
+To be documented.