Skip to content

Commit 48061b4

Browse files
author
John Nonweiler
committed
Correct Doxygen syntax
Doxygen was warning that the argument 'type' has muliple @param documentation sections, and producing incorrect documentation.
1 parent 034e454 commit 48061b4

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

src/util/std_types.h

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ class symbol_typet:public typet
7979

8080
/// Check whether a reference to a typet is a \ref symbol_typet.
8181
/// \param type Source type.
82-
/// \return True if \param type is a \ref symbol_typet.
82+
/// \return True if \p type is a \ref symbol_typet.
8383
template <>
8484
inline bool can_cast_type<symbol_typet>(const typet &type)
8585
{
@@ -243,7 +243,7 @@ class struct_union_typet:public typet
243243

244244
/// Check whether a reference to a typet is a \ref struct_union_typet.
245245
/// \param type Source type.
246-
/// \return True if \param type is a \ref struct_union_typet.
246+
/// \return True if \p type is a \ref struct_union_typet.
247247
template <>
248248
inline bool can_cast_type<struct_union_typet>(const typet &type)
249249
{
@@ -351,7 +351,7 @@ class struct_typet:public struct_union_typet
351351

352352
/// Check whether a reference to a typet is a \ref struct_typet.
353353
/// \param type Source type.
354-
/// \return True if \param type is a \ref struct_typet.
354+
/// \return True if \p type is a \ref struct_typet.
355355
template <>
356356
inline bool can_cast_type<struct_typet>(const typet &type)
357357
{
@@ -411,7 +411,7 @@ class class_typet:public struct_typet
411411

412412
/// Check whether a reference to a typet is a \ref class_typet.
413413
/// \param type Source type.
414-
/// \return True if \param type is a \ref class_typet.
414+
/// \return True if \p type is a \ref class_typet.
415415
template <>
416416
inline bool can_cast_type<class_typet>(const typet &type)
417417
{
@@ -452,7 +452,7 @@ class union_typet:public struct_union_typet
452452

453453
/// Check whether a reference to a typet is a \ref union_typet.
454454
/// \param type Source type.
455-
/// \return True if \param type is a \ref union_typet.
455+
/// \return True if \p type is a \ref union_typet.
456456
template <>
457457
inline bool can_cast_type<union_typet>(const typet &type)
458458
{
@@ -504,7 +504,7 @@ class tag_typet:public typet
504504

505505
/// Check whether a reference to a typet is a \ref tag_typet.
506506
/// \param type Source type.
507-
/// \return True if \param type is a \ref tag_typet.
507+
/// \return True if \p type is a \ref tag_typet.
508508
template <>
509509
inline bool can_cast_type<tag_typet>(const typet &type)
510510
{
@@ -545,7 +545,7 @@ class struct_tag_typet:public tag_typet
545545

546546
/// Check whether a reference to a typet is a \ref struct_tag_typet.
547547
/// \param type Source type.
548-
/// \return True if \param type is a \ref struct_tag_typet.
548+
/// \return True if \p type is a \ref struct_tag_typet.
549549
template <>
550550
inline bool can_cast_type<struct_tag_typet>(const typet &type)
551551
{
@@ -585,7 +585,7 @@ class union_tag_typet:public tag_typet
585585

586586
/// Check whether a reference to a typet is a \ref union_tag_typet.
587587
/// \param type Source type.
588-
/// \return True if \param type is a \ref union_tag_typet.
588+
/// \return True if \p type is a \ref union_tag_typet.
589589
template <>
590590
inline bool can_cast_type<union_tag_typet>(const typet &type)
591591
{
@@ -635,7 +635,7 @@ class enumeration_typet:public typet
635635

636636
/// Check whether a reference to a typet is a \ref enumeration_typet.
637637
/// \param type Source type.
638-
/// \return True if \param type is a \ref enumeration_typet.
638+
/// \return True if \p type is a \ref enumeration_typet.
639639
template <>
640640
inline bool can_cast_type<enumeration_typet>(const typet &type)
641641
{
@@ -699,7 +699,7 @@ class c_enum_typet:public type_with_subtypet
699699

700700
/// Check whether a reference to a typet is a \ref c_enum_typet.
701701
/// \param type Source type.
702-
/// \return True if \param type is a \ref c_enum_typet.
702+
/// \return True if \p type is a \ref c_enum_typet.
703703
template <>
704704
inline bool can_cast_type<c_enum_typet>(const typet &type)
705705
{
@@ -739,7 +739,7 @@ class c_enum_tag_typet:public tag_typet
739739

740740
/// Check whether a reference to a typet is a \ref c_enum_tag_typet.
741741
/// \param type Source type.
742-
/// \return True if \param type is a \ref c_enum_tag_typet.
742+
/// \return True if \p type is a \ref c_enum_tag_typet.
743743
template <>
744744
inline bool can_cast_type<c_enum_tag_typet>(const typet &type)
745745
{
@@ -984,7 +984,7 @@ class code_typet:public typet
984984

985985
/// Check whether a reference to a typet is a \ref code_typet.
986986
/// \param type Source type.
987-
/// \return True if \param type is a \ref code_typet.
987+
/// \return True if \p type is a \ref code_typet.
988988
template <>
989989
inline bool can_cast_type<code_typet>(const typet &type)
990990
{
@@ -1050,7 +1050,7 @@ class array_typet:public type_with_subtypet
10501050

10511051
/// Check whether a reference to a typet is a \ref array_typet.
10521052
/// \param type Source type.
1053-
/// \return True if \param type is a \ref array_typet.
1053+
/// \return True if \p type is a \ref array_typet.
10541054
template <>
10551055
inline bool can_cast_type<array_typet>(const typet &type)
10561056
{
@@ -1089,7 +1089,7 @@ class incomplete_array_typet:public type_with_subtypet
10891089

10901090
/// Check whether a reference to a typet is a \ref incomplete_array_typet.
10911091
/// \param type Source type.
1092-
/// \return True if \param type is a \ref incomplete_array_typet.
1092+
/// \return True if \p type is a \ref incomplete_array_typet.
10931093
template <>
10941094
inline bool can_cast_type<incomplete_array_typet>(const typet &type)
10951095
{
@@ -1162,7 +1162,7 @@ class bitvector_typet:public type_with_subtypet
11621162

11631163
/// Check whether a reference to a typet is a \ref bitvector_typet.
11641164
/// \param type Source type.
1165-
/// \return True if \param type is a \ref bitvector_typet.
1165+
/// \return True if \p type is a \ref bitvector_typet.
11661166
template <>
11671167
inline bool can_cast_type<bitvector_typet>(const typet &type)
11681168
{
@@ -1209,7 +1209,7 @@ class bv_typet:public bitvector_typet
12091209

12101210
/// Check whether a reference to a typet is a \ref bv_typet.
12111211
/// \param type Source type.
1212-
/// \return True if \param type is a \ref bv_typet.
1212+
/// \return True if \p type is a \ref bv_typet.
12131213
template <>
12141214
inline bool can_cast_type<bv_typet>(const typet &type)
12151215
{
@@ -1264,7 +1264,7 @@ class unsignedbv_typet:public bitvector_typet
12641264

12651265
/// Check whether a reference to a typet is a \ref unsignedbv_typet.
12661266
/// \param type Source type.
1267-
/// \return True if \param type is a \ref unsignedbv_typet.
1267+
/// \return True if \p type is a \ref unsignedbv_typet.
12681268
template <>
12691269
inline bool can_cast_type<unsignedbv_typet>(const typet &type)
12701270
{
@@ -1320,7 +1320,7 @@ class signedbv_typet:public bitvector_typet
13201320

13211321
/// Check whether a reference to a typet is a \ref signedbv_typet.
13221322
/// \param type Source type.
1323-
/// \return True if \param type is a \ref signedbv_typet.
1323+
/// \return True if \p type is a \ref signedbv_typet.
13241324
template <>
13251325
inline bool can_cast_type<signedbv_typet>(const typet &type)
13261326
{
@@ -1384,7 +1384,7 @@ class fixedbv_typet:public bitvector_typet
13841384

13851385
/// Check whether a reference to a typet is a \ref fixedbv_typet.
13861386
/// \param type Source type.
1387-
/// \return True if \param type is a \ref fixedbv_typet.
1387+
/// \return True if \p type is a \ref fixedbv_typet.
13881388
template <>
13891389
inline bool can_cast_type<fixedbv_typet>(const typet &type)
13901390
{
@@ -1446,7 +1446,7 @@ class floatbv_typet:public bitvector_typet
14461446

14471447
/// Check whether a reference to a typet is a \ref floatbv_typet.
14481448
/// \param type Source type.
1449-
/// \return True if \param type is a \ref floatbv_typet.
1449+
/// \return True if \p type is a \ref floatbv_typet.
14501450
template <>
14511451
inline bool can_cast_type<floatbv_typet>(const typet &type)
14521452
{
@@ -1498,7 +1498,7 @@ class c_bit_field_typet:public bitvector_typet
14981498

14991499
/// Check whether a reference to a typet is a \ref c_bit_field_typet.
15001500
/// \param type Source type.
1501-
/// \return True if \param type is a \ref c_bit_field_typet.
1501+
/// \return True if \p type is a \ref c_bit_field_typet.
15021502
template <>
15031503
inline bool can_cast_type<c_bit_field_typet>(const typet &type)
15041504
{
@@ -1543,7 +1543,7 @@ class pointer_typet:public bitvector_typet
15431543

15441544
/// Check whether a reference to a typet is a \ref pointer_typet.
15451545
/// \param type Source type.
1546-
/// \return True if \param type is a \ref pointer_typet.
1546+
/// \return True if \p type is a \ref pointer_typet.
15471547
template <>
15481548
inline bool can_cast_type<pointer_typet>(const typet &type)
15491549
{
@@ -1596,7 +1596,7 @@ class reference_typet:public pointer_typet
15961596

15971597
/// Check whether a reference to a typet is a \ref reference_typet.
15981598
/// \param type Source type.
1599-
/// \return True if \param type is a \ref reference_typet.
1599+
/// \return True if \p type is a \ref reference_typet.
16001600
template <>
16011601
inline bool can_cast_type<reference_typet>(const typet &type)
16021602
{
@@ -1645,7 +1645,7 @@ class c_bool_typet:public bitvector_typet
16451645

16461646
/// Check whether a reference to a typet is a \ref c_bool_typet.
16471647
/// \param type Source type.
1648-
/// \return True if \param type is a \ref c_bool_typet.
1648+
/// \return True if \p type is a \ref c_bool_typet.
16491649
template <>
16501650
inline bool can_cast_type<c_bool_typet>(const typet &type)
16511651
{
@@ -1695,7 +1695,7 @@ class string_typet:public typet
16951695

16961696
/// Check whether a reference to a typet is a \ref string_typet.
16971697
/// \param type Source type.
1698-
/// \return True if \param type is a \ref string_typet.
1698+
/// \return True if \p type is a \ref string_typet.
16991699
template <>
17001700
inline bool can_cast_type<string_typet>(const typet &type)
17011701
{
@@ -1742,7 +1742,7 @@ class range_typet:public typet
17421742

17431743
/// Check whether a reference to a typet is a \ref range_typet.
17441744
/// \param type Source type.
1745-
/// \return True if \param type is a \ref range_typet.
1745+
/// \return True if \p type is a \ref range_typet.
17461746
template <>
17471747
inline bool can_cast_type<range_typet>(const typet &type)
17481748
{
@@ -1801,7 +1801,7 @@ class vector_typet:public type_with_subtypet
18011801

18021802
/// Check whether a reference to a typet is a \ref vector_typet.
18031803
/// \param type Source type.
1804-
/// \return True if \param type is a \ref vector_typet.
1804+
/// \return True if \p type is a \ref vector_typet.
18051805
template <>
18061806
inline bool can_cast_type<vector_typet>(const typet &type)
18071807
{
@@ -1845,7 +1845,7 @@ class complex_typet:public type_with_subtypet
18451845

18461846
/// Check whether a reference to a typet is a \ref complex_typet.
18471847
/// \param type Source type.
1848-
/// \return True if \param type is a \ref complex_typet.
1848+
/// \return True if \p type is a \ref complex_typet.
18491849
template <>
18501850
inline bool can_cast_type<complex_typet>(const typet &type)
18511851
{

0 commit comments

Comments
 (0)