• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/
2 / Copyright (c) 2003 Boost.Test contributors
3 /
4 / Distributed under the Boost Software License, Version 1.0. (See accompanying
5 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6 /]
7
8
9[section:semantic Adding semantic to a test]
10
11It is sometimes useful to add a /semantic description/ to a test unit, which may be consulted by the user during a dry
12run. The user may then choose the test he/she wants to run based on this information, instead of basing his/her choice
13on the test unit /name/, or instead of looking at the code.
14
15The __UTF__ provides the decorator __decorator_description__ for that purpose.
16
17Decorator `description` attaches an arbitrary string to the test unit. All strings attached to test units can be
18displayed when running a test program with parameter [link boost_test.utf_reference.rt_param_reference.list_content `list_content`].
19This can be used for conveying information from the person who composes the test tree to the person who will be
20running the test program. Applying more than one decorator `description` to the same test unit means that the two
21(or more) strings will be concatenated.
22
23
24[bt_example decorator_09..decorator description..run]
25
26[endsect]
27