Skip to content

Commit c9144dc

Browse files
committed
[docs 1/5] Port existing HTML manual to doxygen
* The existing HTML documentation under doc/html-manual has been converted to Markdown. This was done automatically using Pandoc, plus some manual work to give identifiers to sections and changing internal links to point to those sections with \ref. * The Doxygen front page now contains some content: a link to the doxygen-ated HTML manual, and a note about the API documentation. The intention here is that the entire Doxygen site could be hosted publicly, serving both users of and contributors to CBMC from a single site. * The doxyfile is updated to enable these changes.
1 parent 32b68ce commit c9144dc

File tree

145 files changed

+3013
-13567
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

145 files changed

+3013
-13567
lines changed

doc/CPPLINT.cfg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
exclude_files=.*

doc/architectural/front-page.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
CProver Documentation
2+
=====================
3+
4+
These pages contain both user tutorials and automatically-generated API
5+
documentation. Users can download CProver tools from the
6+
<a href="http://www.cprover.org/">CProver website</a>; contributors
7+
should use the <a href="https://github.com/diffblue/cbmc">repository</a>
8+
hosted on GitHub.
9+
10+
### For users:
11+
12+
* The \ref cprover-manual "CProver Manual" details the capabilities of
13+
CBMC and SATABS and describes how to install and use these tools. It
14+
also covers the underlying theory and prerequisite concepts behind how
15+
these tools work.
16+
17+
### For contributors:
18+
19+
* If you already know exactly what you're looking for, the API reference
20+
is generated from the codebase. You can search for classes and class
21+
members in the search bar at top-right or use one of the links in the
22+
sidebar.
23+
24+
\defgroup module_hidden _hidden
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/cprover-manual.md

Lines changed: 2982 additions & 0 deletions
Large diffs are not rendered by default.

doc/html-manual/api.shtml

Lines changed: 0 additions & 323 deletions
This file was deleted.

0 commit comments

Comments
 (0)