Skip to content

Commit 9207e52

Browse files
committed
Fix documentation links
1) Make sure .c source files are considered by Doxygen. (Notably, cprover_contracts.c contains relevant documentation.) 2) Reference other files in ways understood by Doxygen.
1 parent e024ecb commit 9207e52

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

doc/architectural/cbmc-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ transformation tools (see \ref other-tools).
6161

6262
For an explanation of the data structures involved in the modeling of a GOTO
6363
program (the GOTO Intermediate Representation used by CBMC and assorted tools)
64-
please see \subpage central-data-structures .
64+
please see [central data structures](central-data-structures.md).
6565

6666
## {C, java bytecode} → Parse tree → Symbol table → GOTO programs → GOTO program transformations → BMC → counterexample (goto_tracet) → printing
6767

doc/architectural/symex-instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Symex is, at its core, a GOTO-program interpreter that uses symbolic values inst
2323
This produces a formula which describes all possible outputs rather than a single output value.
2424
While Symex is interpreting the program, it also builds a list of Static Single Assignment (SSA)
2525
steps that form part of the equation that is to be sent to the solver. For more information see
26-
[src/goto-symex](../../src/goto-symex/README.md).
26+
[src/goto-symex](../../src/goto-symex/).
2727

2828
You can see the main instruction dispatcher (what corresponds to the main interpreter
2929
loop) at `goto_symext::execute_next_instruction`.
@@ -128,4 +128,4 @@ potential paths within it.
128128
129129
This is a high-level overview of symex and goto-program instructions.
130130
For more information (and a more robust introduction), please have a look
131-
at \ref symbolic-execution.
131+
at [symbolic-execution](../../src/goto-symex/).

doc/doxygen-root/doxyfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,7 @@ INPUT_ENCODING = UTF-8
853853
FILE_PATTERNS = *.cpp
854854
FILE_PATTERNS += *.h
855855
FILE_PATTERNS += *.md
856+
FILE_PATTERNS += *.c
856857

857858
# The RECURSIVE tag can be used to specify whether or not subdirectories should
858859
# be searched for input files as well.

0 commit comments

Comments
 (0)