Skip to content

Commit

Permalink
Address Doxygen warnings
Browse files Browse the repository at this point in the history
Doxygen 1.9.8 detects more problems than earlier versions did.
  • Loading branch information
tautschnig committed Jan 13, 2025
1 parent de3a0d1 commit 69f4f3b
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
5 changes: 3 additions & 2 deletions doc/API/util/piped_process.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
\page piped-process `src/util/piped_process.{cpp, h}`
\page piped-process The `piped_process` API

To utilise the `piped_process` API for interprocess communication with any binary:
To utilise the `piped_process` API (`src/util/piped_process.{cpp, h}`) for
interprocess communication with any binary:

* You need to initialise it by calling the construct `piped_processt("binary with args")`.
* If IPC fails before child process creation, you will get a `system_exceptiont`.
Expand Down
4 changes: 2 additions & 2 deletions doc/architectural/front-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ license</a>.
Overview of Documentation
=======

### For users:
## For users:

* The [CPROVER User Manual](http://www.cprover.org/cprover-manual/) details the
capabilities of CBMC and describes how to install and use these tools. It
Expand All @@ -68,7 +68,7 @@ you can access it <a href=
* \subpage memory-bounds-checking
* \subpage satabs

### For contributors:
## For contributors:

The following pages attempt to provide the information that a developer needs to
work on CBMC, in a sensible order. In many cases they link to the appropriate
Expand Down
2 changes: 1 addition & 1 deletion doc/architectural/goto-program-transformations.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ This pass adds failed symbols to the symbol table. See
`src/pointer-analysis/add_failed_symbols.h` for details. The implementation of
this pass is called via \ref add_failed_symbols(symbol_table_baset &) . The
purpose of failed symbols is explained in the documentation of the function \ref
goto_symext::dereference(exprt &, statet &, bool)
goto_symext::dereference(exprt &, goto_symex_statet &, bool)

<em>Predecessor pass is \ref update-transform or the optional \ref
nondet-transform if it is being used.</em>
Expand Down
2 changes: 1 addition & 1 deletion doc/assets/xml_spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ The path from the input C code to XML trace goes through the following
steps:\
`C``GOTO``SSA``GOTO Trace``XML Trace`

#### SSA to GOTO Trace
### SSA to GOTO Trace

SSA steps are sorted by clocks and the following steps are skipped: PHI,
GUARD assignments; shared-read, shared-write, constraint, spawn,
Expand Down
6 changes: 3 additions & 3 deletions src/goto-instrument/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ from `main.*`, `parseoptions.*` and the `Makefile` and use these as the
skeleton of their application. The `doit()` method in `parseoptions.cpp`
is the preferred location for the top level control for the program.

### Main usage ###
## Main usage ##

For most of the transformations, `goto-instrument` takes one or two
arguments and any number of options. The two file arguments are
Expand All @@ -40,7 +40,7 @@ option output, with no indication of what has gone wrong. Some of the options
can work with just an input file and not output file. For more specific
examples, take a look at the demonstrations below:

### Function pointer removal ###
## Function pointer removal ##

As an example of a transformation pass being run, imagine you have a file
called `function_pointers.c` with the following content:
Expand Down Expand Up @@ -163,7 +163,7 @@ You can now see that the function pointer (indirect) call (resulting from
the array indexing of the array containing the function pointers)
has now been substituted by direct, conditional calls.

### Call Graph ###
## Call Graph ##

This is an example of a command line flag that requires only one argument,
specifying the input file.
Expand Down

0 comments on commit 69f4f3b

Please sign in to comment.