Skip to content

Commit de972b6

Browse files
committed
Rename detail header, fix some comments
1 parent be5e8b7 commit de972b6

3 files changed

Lines changed: 16 additions & 15 deletions

File tree

File renamed without changes.

include/rsl/_impl/macro/compiler.hpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
#pragma once
2-
#include <version>
32

43
#define RSL_COMPILER_UNKNOWN 0
54
#define RSL_COMPILER_CLANG 1
@@ -49,4 +48,4 @@
4948
#else
5049
# define RSL_STDLIB RSL_STDLIB_UNKNOWN
5150
# define RSL_STDLIB_VERSION 0
52-
#endif
51+
#endif

include/rsl/macro

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,41 +24,43 @@
2424
*/
2525
#define $os_is(os) (RSL_OS == RSL_OS_##os)
2626

27-
/// feature macro helper
27+
/// Feature macro helper
2828
#define $uses_opt(x) USES_OPT(x)
2929

3030
/**
31-
* @param: one of always, never
31+
* @param opt: one of always, never
3232
*/
33-
#define $inline(...) RSL_INLINE(__VA_ARGS__)
33+
#define $inline(opt) RSL_INLINE(opt)
3434

35-
/** Enable this overload if expr evaluates to true. Clang only.
36-
* @param expr
37-
*/
35+
/// Enable this overload if a given expression evaluates to true. Clang only.
3836
#define $enable_if(...) RSL_ENABLE_IF(__VA_ARGS__)
3937

4038
//! Workaround for expansion statements in GCC
4139
#define $define_static_array(...) RSL_DEFINE_STATIC_ARRAY(__VA_ARGS__)
4240

4341
/** Applies `macro` to every element and inserts delimiters produced by `delim` between elements
44-
* @param macro function-like macro applied to every element
45-
* @param delim function-like macro producing the delimiter
46-
* @param ... elements to loop over
42+
* @param macro: function-like macro applied to every element
43+
* @param delim: function-like macro producing the delimiter
44+
* @param ...: elements to loop over
4745
*/
4846
#define $for_each_delim(macro, delim, ...) RSL_IMPL_FOR_EACH_DELIM(macro, delim, __VA_ARGS__)
4947

5048
/** Applies `macro` to every element and inserts commas between elements
51-
* @param macro function-like macro applied to every element
52-
* @param ... elements to loop over
49+
* @param macro: function-like macro applied to every element
50+
* @param ...: elements to loop over
5351
*/
5452
#define $for_each_list(macro, ...) RSL_IMPL_FOR_EACH_DELIM(macro, RSL_IMPL_DELIM_COMMA, __VA_ARGS__)
5553

5654
/** Applies `macro` to every element
57-
* @param macro function-like macro applied to every element
58-
* @param ... elements to loop over
55+
* @param macro: function-like macro applied to every element
56+
* @param ...: elements to loop over
5957
*/
6058
#define $for_each(macro, ...) RSL_IMPL_FOR_EACH_DELIM(macro, RSL_IMPL_DELIM_NONE, __VA_ARGS__)
6159

60+
/**
61+
* @param op: one of push, pop, disable, error
62+
* @param ...: optional arguments
63+
*/
6264
#define $diagnostics(op, ...) RSL_DIAG_##op (__VA_ARGS__)
6365

6466
/// Introduces an explicit template region

0 commit comments

Comments
 (0)