Skip to content

Commit f104d38

Browse files
author
Owen Jones
committed
Update to correct doxygen format (\par)
\par is just a paragraph marker. \param is the way of documenting individual parameters.
1 parent 23b828b commit f104d38

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

src/analyses/ai.cpp

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ void ai_baset::output(
6161
}
6262

6363
/// Output the domains for the whole program as JSON
64-
/// \par parameters: The namespace and goto_functions
64+
/// \param ns: The namespace
65+
/// \param goto_functions: The goto functions
6566
/// \return The JSON object
6667
jsont ai_baset::output_json(
6768
const namespacet &ns,
@@ -86,7 +87,10 @@ jsont ai_baset::output_json(
8687
}
8788

8889
/// Output the domains for a single function as JSON
89-
/// \par parameters: The namespace, goto_program and its identifier
90+
/// \param ns: The namespace
91+
/// \param goto_program: The goto program
92+
/// \param identifier: the identifier used to find a symbol to identify the
93+
/// source language
9094
/// \return The JSON object
9195
jsont ai_baset::output_json(
9296
const namespacet &ns,
@@ -117,7 +121,8 @@ jsont ai_baset::output_json(
117121
}
118122

119123
/// Output the domains for the whole program as XML
120-
/// \par parameters: The namespace and goto_functions
124+
/// \param ns: The namespace
125+
/// \param goto_functions: The goto functions
121126
/// \return The XML object
122127
xmlt ai_baset::output_xml(
123128
const namespacet &ns,
@@ -145,7 +150,10 @@ xmlt ai_baset::output_xml(
145150
}
146151

147152
/// Output the domains for a single function as XML
148-
/// \par parameters: The namespace, goto_program and its identifier
153+
/// \param ns: The namespace
154+
/// \param goto_program: The goto program
155+
/// \param identifier: the identifier used to find a symbol to identify the
156+
/// source language
149157
/// \return The XML object
150158
xmlt ai_baset::output_xml(
151159
const namespacet &ns,

0 commit comments

Comments
 (0)