Skip to content

Commit dda2575

Browse files
committed
Documentation polish
1 parent b698eef commit dda2575

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/custom.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,13 @@ int main()
5252
}
5353
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5454

55-
## Extending RABERU Keywords
55+
## Custom RABERU Keywords
5656

5757
THe keywords provided by **RABERU** can also be extended to propose a better user experience.
5858
This includes using user-defined type instead of **RABERU** long symbol to improve diagnostic
5959
, complex checks or provide custom display when using stream insertion of settings.
6060

61+
### Extending RABERU Keywords
6162
Let's start again with our unrolling option. This time we want to be able to be sure nobody
6263
will use it with a non integral constant value and to display the value in a more informative way.
6364
To do so, we can inherits from `rbr::any_keyword`:
@@ -92,8 +93,8 @@ example.cpp:5:8: note: candidate function (the implicit copy assignment operator
9293
example.cpp:5:8: note: candidate function (the implicit move assignment operator) not viable: no known conversion from 'float' to 'unrolling' for 1st argument struct unrolling : rbr::any_keyword<unrolling>
9394
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9495
95-
Let's now improve the output of the option.
96-
Currently, the output is like:
96+
### Custom Keywords Display
97+
Let's now improve the output of the option. Currently, the output is like:
9798
9899
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c++
99100
[unrolling] : 8 (std::integral_constant<int, 8>)

0 commit comments

Comments
 (0)