Convert doc/ADR and doc/API to doxygen page/subpage syntax

Mark R. Tuttle · Mark R. Tuttle · commit ee0a06da25e3 · 2022-09-25T17:48:15.000-05:00
diff --git a/doc/ADR/README.md b/doc/ADR/README.md
@@ -8,5 +8,5 @@ of the system and the surrounding infrastructure.
 
 ## Release & Packaging
 
-* [Release Process](release_process.md)
-* [Homebrew tap](homebrew_tap.md)
+* \subpage release-process
+* \subpage homebrew-tap-instructions
diff --git a/doc/ADR/homebrew_tap.md b/doc/ADR/homebrew_tap.md
@@ -1,4 +1,4 @@
-# Homebrew tap instructions
+\page homebrew-tap-instructions Homebrew tap instructions
 
 CBMC archives versions into a tap which you can use to quickly download and
 build various historical versions.
diff --git a/doc/ADR/release_process.md b/doc/ADR/release_process.md
@@ -1,4 +1,4 @@
-# Release Process
+\page release-process Release Process
 
 **Date**: 2020-10-08
 **Updated**: 2022-06-23
@@ -9,7 +9,7 @@
 
 The current process we follow through to make a new release is the following:
 
-1. At the point in time we want to make the release, we make a change to 
+1. At the point in time we want to make the release, we make a change to
    `src/config.inc`, and update the configuration variable `CBMC_VERSION`.
    This is important as it informs the various tools of the current version
    of CBMC.
diff --git a/doc/API/README.md b/doc/API/README.md
@@ -1,3 +1,3 @@
-# CProver APIs
+# CPROVER APIs
 
-* [piped_process](util/piped_process.md)
+* \subpage piped-process
diff --git a/doc/API/util/piped_process.md b/doc/API/util/piped_process.md
@@ -1,4 +1,4 @@
-# `src/util/piped_process.{cpp, h}`
+\page piped-process `src/util/piped_process.{cpp, h}`
 
 To utilise the `piped_process` API for interprocess communication with any binary:
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Homebrew tap instructions`
	`1`	`+\page homebrew-tap-instructions Homebrew tap instructions`
`2`	`2`
`3`	`3`	`CBMC archives versions into a tap which you can use to quickly download and`
`4`	`4`	`build various historical versions.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-# `src/util/piped_process.{cpp, h}`
	`1`	+\page piped-process `src/util/piped_process.{cpp, h}`
`2`	`2`
`3`	`3`	To utilise the `piped_process` API for interprocess communication with any binary:
`4`	`4`