Restructure content to use _hidden

Charliemowood · Charliemowood · commit a24d01f16ca4 · 2018-02-27T17:43:57.000Z
This structure is not perfect but neatens table of contents
diff --git a/doc/architectural/cprover-architecture-overview.md b/doc/architectural/cprover-architecture-overview.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden 
 \page cprover-architecture-overview CProver Architecture Overview
 
 \author Martin Brain
@@ -70,7 +71,7 @@ rather than `UI_message_handlert` or `UIMessageHandler` and
 
 - utilities
 
-  * \ref big int
+  * \ref big-int
   * \ref json
   * \ref xmllang
   * \ref util
diff --git a/doc/architectural/front-page.md b/doc/architectural/front-page.md
@@ -86,3 +86,5 @@ module pages at the moment, but may be somewhat out-of-date.
   to CProver to get their feet wet through a series of programming
   exercises - mostly modifying goto-instrument, and thus learning to
   manipulate the main data structures used within CBMC.
+
+\defgroup module_hidden _hidden
diff --git a/doc/architectural/howto.md b/doc/architectural/howto.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \page tutorial Tutorials
 
 \section cbmc_tutorial CBMC Developer Tutorial
diff --git a/doc/cbmc-user-manual.md b/doc/cbmc-user-manual.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \page cbmc-user-manual CMBC User Manual
 
 \author Daniel Kroening
diff --git a/src/analyses/README.md b/src/analyses/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup analyses analyses
 # Folder analyses
 
diff --git a/src/ansi-c/README.md b/src/ansi-c/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup ansi-c ansi-c
 # Folder ansi-c
 
diff --git a/src/assembler/README.md b/src/assembler/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup assembler assembler
 # Folder assembler
 
diff --git a/src/big-int/README.md b/src/big-int/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup big-int big-int
 # Folder big-int
 
diff --git a/src/cbmc/README.md b/src/cbmc/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup cbmc cbmc
 # Folder CBMC
 
diff --git a/src/clobber/README.md b/src/clobber/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \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,3 +1,4 @@
+\ingroup module_hidden
 \defgroup cpp cpp
 # Folder cpp
 
diff --git a/src/goto-analyzer/README.md b/src/goto-analyzer/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup goto-analyzer goto-analyzer
 # Folder goto-analyzer
 
diff --git a/src/goto-cc/README.md b/src/goto-cc/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup goto-cc goto-cc
 # Folder goto-cc
 
diff --git a/src/goto-diff/README.md b/src/goto-diff/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup goto-diff goto-diff
 # Folder goto-diff
 
diff --git a/src/goto-instrument/README.md b/src/goto-instrument/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup goto-instrument goto-instrument
 # Folder goto-instrument
 
diff --git a/src/goto-programs/README.md b/src/goto-programs/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup goto-programs goto-programs
 # Folder goto-programs
 
diff --git a/src/goto-symex/README.md b/src/goto-symex/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup goto-symex goto-symex
 # Folder goto-symex
 
diff --git a/src/java_bytecode/README.md b/src/java_bytecode/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup java_bytecode java_bytecode
 # Folder java_bytecode
 
diff --git a/src/jbmc/README.md b/src/jbmc/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup jbmc jbmc
 # Folder jbmc
 
diff --git a/src/jsil/README.md b/src/jsil/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup jsil jsil
 # Folder jsil
 
diff --git a/src/json/README.md b/src/json/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup json json
 # Folder json
 
diff --git a/src/langapi/README.md b/src/langapi/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup langapi langapi
 # Folder langapi
 
diff --git a/src/linking/README.md b/src/linking/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup linking linking
 # Folder linking
 
diff --git a/src/memory-models/README.md b/src/memory-models/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup memory-models memory-models
 # Folder memory-models
 
diff --git a/src/miniz/README.md b/src/miniz/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup miniz miniz
 Folder miniz
 
diff --git a/src/nonstd/README.md b/src/nonstd/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup nonstd nonstd
 # Folder nonstd
 
diff --git a/src/pointer-analysis/README.md b/src/pointer-analysis/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup pointer-analysis pointer-analysis
 # Folder pointer-analysis
 
diff --git a/src/solvers/README.md b/src/solvers/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup solvers solvers
 # Folder solvers
 
diff --git a/src/util/README.md b/src/util/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup util util
 # Folder util
 
diff --git a/src/xmllang/README.md b/src/xmllang/README.md
@@ -1,3 +1,4 @@
+\ingroup module_hidden
 \defgroup xmllang xmllang
 # Folder xmllang
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\page tutorial Tutorials`
`2`	`3`
`3`	`4`	`\section cbmc_tutorial CBMC Developer Tutorial`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\page cbmc-user-manual CMBC User Manual`
`2`	`3`
`3`	`4`	`\author Daniel Kroening`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\defgroup analyses analyses`
`2`	`3`	`# Folder analyses`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\defgroup ansi-c ansi-c`
`2`	`3`	`# Folder ansi-c`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\defgroup assembler assembler`
`2`	`3`	`# Folder assembler`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\defgroup big-int big-int`
`2`	`3`	`# Folder big-int`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\defgroup cbmc cbmc`
`2`	`3`	`# Folder CBMC`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\defgroup cpp cpp`
`2`	`3`	`# Folder cpp`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\defgroup goto-analyzer goto-analyzer`
`2`	`3`	`# Folder goto-analyzer`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+\ingroup module_hidden`
`1`	`2`	`\defgroup goto-cc goto-cc`
`2`	`3`	`# Folder goto-cc`
`3`	`4`