Skip to content

Commit bfbfcdd

Browse files
committed
tidy up Javadoc
1 parent 6cd9c04 commit bfbfcdd

File tree

4 files changed

+34
-16
lines changed

4 files changed

+34
-16
lines changed

include/mrdox/Metadata/Enum.hpp

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,19 @@ namespace mrdox {
2727
// Information for a single possible value of an enumeration.
2828
struct EnumValueInfo
2929
{
30+
llvm::SmallString<16> Name;
31+
32+
// The computed value of the enumeration constant. This could be the result of
33+
// evaluating the ValueExpr, or it could be automatically generated according
34+
// to C rules.
35+
llvm::SmallString<16> Value;
36+
37+
// Stores the user-supplied initialization expression for this enumeration
38+
// constant. This will be empty for implicit enumeration values.
39+
llvm::SmallString<16> ValueExpr;
40+
41+
//--------------------------------------------
42+
3043
explicit
3144
EnumValueInfo(
3245
llvm::StringRef Name = llvm::StringRef(),
@@ -38,23 +51,15 @@ struct EnumValueInfo
3851
{
3952
}
4053

54+
#if 0
55+
// VFALCO What was this for?
4156
bool operator==(EnumValueInfo const& Other) const
4257
{
4358
return
4459
std::tie(Name, Value, ValueExpr) ==
4560
std::tie(Other.Name, Other.Value, Other.ValueExpr);
4661
}
47-
48-
llvm::SmallString<16> Name;
49-
50-
// The computed value of the enumeration constant. This could be the result of
51-
// evaluating the ValueExpr, or it could be automatically generated according
52-
// to C rules.
53-
llvm::SmallString<16> Value;
54-
55-
// Stores the user-supplied initialization expression for this enumeration
56-
// constant. This will be empty for implicit enumeration values.
57-
llvm::SmallString<16> ValueExpr;
62+
#endif
5863
};
5964

6065
//------------------------------------------------

include/mrdox/Metadata/FieldType.hpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ struct FieldTypeInfo
4444
{
4545
}
4646

47+
#if 0
48+
// VFALCO What was this for?
4749
bool
4850
operator==(
4951
FieldTypeInfo const& Other) const
@@ -52,6 +54,7 @@ struct FieldTypeInfo
5254
std::tie(Type, Name, DefaultValue) ==
5355
std::tie(Other.Type, Other.Name, Other.DefaultValue);
5456
}
57+
#endif
5558
};
5659

5760
} // mrdox

include/mrdox/Metadata/Javadoc.hpp

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ namespace mrdox {
2424

2525
/** A processed Doxygen-style comment attached to a declaration.
2626
*/
27-
struct Javadoc
27+
struct MRDOX_VISIBLE
28+
Javadoc
2829
{
2930
using String = std::string;
3031

@@ -290,16 +291,19 @@ struct Javadoc
290291

291292
//--------------------------------------------
292293

293-
Javadoc() noexcept = default;
294+
MRDOX_DECL
295+
Javadoc() noexcept;
294296

295297
/** Constructor
296298
*/
299+
MRDOX_DECL
297300
explicit
298301
Javadoc(
299302
List<Block> blocks);
300303

301304
/** Return true if this is empty
302305
*/
306+
MRDOX_DECL
303307
bool
304308
empty() const noexcept;
305309

@@ -339,10 +343,11 @@ struct Javadoc
339343
output format.
340344
*/
341345
/** @{ */
342-
bool operator==(Javadoc const&) const noexcept;
343-
bool operator!=(Javadoc const&) const noexcept;
346+
MRDOX_DECL bool operator==(Javadoc const&) const noexcept;
347+
MRDOX_DECL bool operator!=(Javadoc const&) const noexcept;
344348
/* @} */
345349

350+
MRDOX_DECL
346351
List<Block>::const_iterator
347352
findBrief() const noexcept;
348353

@@ -362,7 +367,9 @@ struct Javadoc
362367
@li Otherwise, the brief is set to a
363368
null pointer to indicate absence.
364369
*/
365-
void calculateBrief();
370+
MRDOX_DECL
371+
void
372+
calculateBrief();
366373

367374
//--------------------------------------------
368375

source/api/Metadata/Javadoc.cpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ static_assert(a_Node<Javadoc::Code>);
3333

3434
//------------------------------------------------
3535

36+
Javadoc::
37+
Javadoc() noexcept = default;
38+
3639
Javadoc::
3740
Javadoc(
3841
List<Block> blocks)

0 commit comments

Comments
 (0)