Add links to CPROVER directories

Charliemowood · peterschrammel · commit 40dc1d8b6631 · 2018-03-22T15:38:42.000Z
Improve structure of READMEs in table of contents
diff --git a/doc/architectural/cprover-architecture-overview.md b/doc/architectural/cprover-architecture-overview.md
@@ -56,52 +56,52 @@ rather than `UI_message_handlert` or `UIMessageHandler` and
 
 - language front ends
 
-  * ansi-c
-  * cpp
-  * langapi
-  * jsil
+  * \ref ansi-c
+  * \ref cpp
+  * \ref langapi
+  * \ref jsil
 
 
 - static analysis
 
-  * analysis
-  * pointer analysis
+  * \ref analyses
+  * \ref pointer-analysis
 
 
 - utilities
 
-  * big int
-  * json
-  * xmllang
-  * util
-  * miniz
-  * nonstd
+  * \ref big int
+  * \ref json
+  * \ref xmllang
+  * \ref util
+  * \ref miniz
+  * \ref nonstd
 
 
 - tools
 
-  * cbmc
-  * clobber
-  * goto-analyzer
-  * goto-instrument
-  * goto-diff
-  * memory-models
-  * goto-cc
-  * jbmc
+  * \ref cbmc
+  * \ref clobber
+  * \ref goto-analyzer
+  * \ref goto-instrument
+  * \ref goto-diff
+  * \ref memory-models
+  * \ref goto-cc
+  * \ref jbmc
 
 
 - goto-programs
 
-  * goto-programs
-  * linking
+  * \ref goto-programs
+  * \ref linking
 
 
 - symbolic execution
-   * goto-symex
+   * \ref goto-symex
 
 
 - solvers
-  * solvers
+  * \ref solvers
 
 \section other-apps Other apps
 Other Useful Code
diff --git a/src/analyses/README.md b/src/analyses/README.md
@@ -1,5 +1,5 @@
-\defgroup analyses
-\ingroup analyses
+\defgroup analyses analyses
+# Folder analyses
 
 FIXME: put here a good introduction describing what is contained
 in this folder.
diff --git a/src/ansi-c/README.md b/src/ansi-c/README.md
@@ -1,5 +1,5 @@
-\defgroup ansi-c
-\ingroup ansi-c
+\defgroup ansi-c ansi-c
+# Folder ansi-c
 
 \author Kareem Khazem
 
diff --git a/src/assembler/README.md b/src/assembler/README.md
@@ -1,4 +1,4 @@
-\defgroup assembler
-\ingroup assembler
+\defgroup assembler assembler
+# Folder assembler
 
 `assembler/` is a module that serve as language front end.
diff --git a/src/big-int/README.md b/src/big-int/README.md
@@ -1,5 +1,5 @@
-\defgroup big-int
-\ingroup big-int
+\defgroup big-int big-int
+# Folder big-int
 
 CPROVER is distributed with its own multi-precision arithmetic library;
 mainly for historical and portability reasons. The library is externally
diff --git a/src/cbmc/README.md b/src/cbmc/README.md
@@ -1,5 +1,4 @@
-\defgroup cbmc
-\ingroup cbmc
-
+\defgroup cbmc cbmc
+# Folder CBMC
 
 The CBMC handles the code related to interacting with CBMC.
diff --git a/src/clobber/README.md b/src/clobber/README.md
@@ -1,4 +1,3 @@
-\defgroup clobber
-\ingroup clobber
-
+\defgroup clobber clobber
+# Folder clobber
 `clobber\` is a module that is a tool.
diff --git a/src/cpp/README.md b/src/cpp/README.md
@@ -1,4 +1,4 @@
-\defgroup cpp
-\ingroup cpp
+\defgroup cpp cpp
+# Folder cpp
 
 The C++ Language front-end is for processing C++.
diff --git a/src/goto-analyzer/README.md b/src/goto-analyzer/README.md
@@ -1,5 +1,5 @@
-\defgroup goto-analyzer
-\ingroup goto-analyzer
+\defgroup goto-analyzer goto-analyzer
+# Folder goto-analyzer
 
 `goto-analyzer/` is a module stores information related to interacting with
 goto-analyzer. These files are medium risk to change and change frequently.
diff --git a/src/goto-cc/README.md b/src/goto-cc/README.md
@@ -1,5 +1,5 @@
-\defgroup goto-cc
-\ingroup goto-cc
+\defgroup goto-cc goto-cc
+# Folder goto-cc
 
 `goto-cc` is a compiler replacement that just performs the first step of
 the process; converting C or C++ programs to goto-binaries. It is
diff --git a/src/goto-diff/README.md b/src/goto-diff/README.md
@@ -1,5 +1,5 @@
-\defgroup goto-diff
-\ingroup goto-diff
+\defgroup goto-diff goto-diff
+# Folder goto-diff
 
 
 `goto-diff/` is a module has files which change frequently and are medium
diff --git a/src/goto-instrument/README.md b/src/goto-instrument/README.md
@@ -1,5 +1,5 @@
-\defgroup goto-instrument
-\ingroup goto-instrument
+\defgroup goto-instrument goto-instrument
+# Folder goto-instrument
 
 The `goto-instrument/` directory contains a number of tools, one per
 file, that are built into the `goto-instrument` program. All of them
diff --git a/src/goto-programs/README.md b/src/goto-programs/README.md
@@ -1,5 +1,5 @@
-\defgroup goto-programs
-\ingroup goto-programs
+\defgroup goto-programs goto-programs
+# Folder goto-programs
 
 
 \author Kareem Khazem
diff --git a/src/goto-symex/README.md b/src/goto-symex/README.md
@@ -1,5 +1,5 @@
-\defgroup goto-symex
-\ingroup goto-symex
+\defgroup goto-symex goto-symex
+# Folder goto-symex
 
 
 \author Kareem Khazem
diff --git a/src/java_bytecode/README.md b/src/java_bytecode/README.md
@@ -1,5 +1,5 @@
-\defgroup java_bytecode
-\ingroup java_bytecode
+\defgroup java_bytecode java_bytecode
+# Folder java_bytecode
 
 
 This module provide a front end for Java.
diff --git a/src/jbmc/README.md b/src/jbmc/README.md
@@ -1,4 +1,4 @@
-\defgroup jbmc
-\ingroup jbmc
+\defgroup jbmc jbmc
+# Folder jbmc
 
 `jbmc/` is like cbmc but especially designed for Java.
diff --git a/src/jsil/README.md b/src/jsil/README.md
@@ -1,5 +1,5 @@
-\defgroup jsil
-\ingroup jsil
+\defgroup jsil jsil
+# Folder jsil
 
 
 `jsil/` is a module that focuses on type checking.
diff --git a/src/json/README.md b/src/json/README.md
@@ -1,4 +1,4 @@
-\defgroup json
-\ingroup json
+\defgroup json json
+# Folder json
 
 `json/` is a utility that processes json.
diff --git a/src/langapi/README.md b/src/langapi/README.md
@@ -1,5 +1,5 @@
-\defgroup langapi
-\ingroup langapi
+\defgroup langapi langapi
+# Folder langapi
 
 
 `langapi/` is a language front end.
diff --git a/src/linking/README.md b/src/linking/README.md
@@ -1,4 +1,4 @@
-\defgroup linking
-\ingroup linking
+\defgroup linking linking
+# Folder linking
 
 linking docs: todo
diff --git a/src/memory-models/README.md b/src/memory-models/README.md
@@ -1,5 +1,5 @@
-\defgroup memory-models
-\ingroup memory-models
+\defgroup memory-models memory-models
+# Folder memory-models
 
 
 `memory-models` is a tool that works with memory.
diff --git a/src/miniz/README.md b/src/miniz/README.md
@@ -1,5 +1,5 @@
-\defgroup miniz
-\ingroup miniz
+\defgroup miniz miniz
+Folder miniz
 
 
 `miniz/` is a utility for minimizing things.
diff --git a/src/nonstd/README.md b/src/nonstd/README.md
@@ -1,5 +1,5 @@
-\defgroup nonstd
-\ingroup nonstd
+\defgroup nonstd nonstd
+# Folder nonstd
 
 
 `nonstd` is a utility.
diff --git a/src/pointer-analysis/README.md b/src/pointer-analysis/README.md
@@ -1,4 +1,4 @@
-\defgroup pointer-analysis
-\ingroup pointer-analysis
+\defgroup pointer-analysis pointer-analysis
+# Folder pointer-analysis
 
 `pointer analysis/` is for static analysis.
diff --git a/src/solvers/README.md b/src/solvers/README.md
@@ -1,5 +1,5 @@
-\defgroup solvers
-\ingroup solvers
+\defgroup solvers solvers
+# Folder solvers
 
 
 \authors Romain Brenguier, Kareem Khazem
diff --git a/src/util/README.md b/src/util/README.md
@@ -1,5 +1,5 @@
-\defgroup util
-\ingroup util
+\defgroup util util
+# Folder util
 
 
 `util/` is filled with useful tools.
diff --git a/src/xmllang/README.md b/src/xmllang/README.md
@@ -1,5 +1,5 @@
-\defgroup xmllang
-\ingroup xmllang
+\defgroup xmllang xmllang
+# Folder xmllang
 
 `xmllang` is a utility for converting to XML.
 
