Skip to content

Commit f146329

Browse files
author
John Nonweiler
committed
Abbreviate deprecated message
It appears that Doxygen cannot cope with macros with multiline parameters. There was a DEPRECATED macro with a multiline comment explaining which method to use instead, which led to Doxygen producing a warning message and failing to produce the correct documentation. With the message passed to the DEPRECATED macro abbreviated so that it fits in one line, Doxygen can produce the correct documentation. (There is only one instrument_cover_goals() method which takes a goto_programt as its first parameter.)
1 parent bffa0b9 commit f146329

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed

src/goto-instrument/cover.cpp

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@ void instrument_cover_goals(
5454
/// \deprecated use instrument_cover_goals(goto_programt &goto_program,
5555
/// const cover_instrumenterst &instrumenters,
5656
/// message_handlert &message_handler, const irep_idt mode) instead
57-
DEPRECATED(
58-
"use instrument_cover_goals(goto_programt &goto_program,"
59-
"const cover_instrumenterst &instrumenters,"
60-
"message_handlert &message_handler, const irep_idt mode) instead")
57+
DEPRECATED("use instrument_cover_goals(goto_programt &...) instead")
6158
void instrument_cover_goals(
6259
const symbol_tablet &symbol_table,
6360
goto_programt &goto_program,

0 commit comments

Comments
 (0)