Skip to content

Commit 646101f

Browse files
committed
Fix broken multiline reference
The `<!--` `-->` hack to continue a reference overmultiple lines no longer works in Doxygen 1.9.1. This commit avoids the need for a hack by fitting the reference on a single line. The class name `ai_baset` can be safely ommitted from the reference, because this block of doxygen is already assoicated with the `ai_baset` class.
1 parent 7160edb commit 646101f

File tree

2 files changed

+2
-4
lines changed

2 files changed

+2
-4
lines changed

scripts/expected_doxygen_warnings.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +0,0 @@
1-
src/analyses/ai.h:70: warning: unable to resolve reference to 'ai_baset#operator()' for \ref command

src/analyses/ai.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,8 @@ Author: Daniel Kroening, [email protected]
6767
/// Users of abstract interpreters should use the interface given by this class.
6868
/// It breaks into three categories:
6969
///
70-
/// 1. Running an analysis, via
71-
/// \ref ai_baset#operator()(const irep_idt&,const goto_programt&, <!--
72-
/// --> const namespacet&),
70+
/// 1. Running an analysis, via \ref
71+
/// #operator()(const irep_idt&,const goto_programt&, const namespacet&),
7372
/// \ref ai_baset#operator()(const goto_functionst&,const namespacet&)
7473
/// and \ref ai_baset#operator()(const abstract_goto_modelt&)
7574
/// 2. Accessing the results of an analysis, by looking up the history objects

0 commit comments

Comments
 (0)