AceUnitAnnotations.h File Reference

AceUnit Annotations header file. More...

Go to the source code of this file.

Defines

#define ACEUNITANNOTATIONS_H   1
 Include shield to protect the header file from being included more than once.
#define ACEUNIT_ANNOTATION
 The super type of annotations.
#define ACEUNIT_DIRECT_ANNOTATION   ACEUNIT_ANNOTATION
 A direct annotation is an annotation which turns an arbitrary method into a test fixture method.
#define ACEUNIT_META_ANNOTATION   ACEUNIT_ANNOTATION
 A meta annotation is an annotation which cannot be used standalone but only provides additional information for another annotation.
#define A_Test   ACEUNIT_DIRECT_ANNOTATION
 Test annotation, use for test cases.
#define A_Loop(times)   ACEUNIT_META_ANNOTATION
 Loop annotation, use for looping test cases.
#define A_Before   ACEUNIT_DIRECT_ANNOTATION
 Before annotation, use for methods that should be invoked before each test case in a fixture.
#define A_After   ACEUNIT_DIRECT_ANNOTATION
 After annotation, use for methods that should be invoked after each test case in a fixture.
#define A_BeforeClass   ACEUNIT_DIRECT_ANNOTATION
 BeforeClass annotation, use for methods that should be invoked once for the fixture before all of its test cases.
#define A_AfterClass   ACEUNIT_DIRECT_ANNOTATION
 AfterClass annotation, use for methods that should be invoked once for the fixture after all of its test cases.
#define A_Ignore   ACEUNIT_META_ANNOTATION
 Ignore annotation, use for test cases to ignore.
#define A_Group(group)
 Puts a test in a specific group.
#define A_FixtureGroup(group)
 Puts a fixture in a specific group.


Detailed Description

AceUnit Annotations header file.

You do not need to include this header file in a fixture. The generated header file for your fixture will automatically include it.

Author:
Christian Hujer

Define Documentation

#define A_After   ACEUNIT_DIRECT_ANNOTATION

After annotation, use for methods that should be invoked after each test case in a fixture.

#define A_AfterClass   ACEUNIT_DIRECT_ANNOTATION

AfterClass annotation, use for methods that should be invoked once for the fixture after all of its test cases.

#define A_Before   ACEUNIT_DIRECT_ANNOTATION

Before annotation, use for methods that should be invoked before each test case in a fixture.

#define A_BeforeClass   ACEUNIT_DIRECT_ANNOTATION

BeforeClass annotation, use for methods that should be invoked once for the fixture before all of its test cases.

#define A_FixtureGroup ( group   ) 

Puts a fixture in a specific group.

This annotation is only allowed once per fixture source. Though this annotation might appear anywhere in the source code, it is recommended to place after include directives but before "normal" code.

Putting a fixture in a specific group overrides the default group for all tests in that fixture.

#define A_Group ( group   ) 

Puts a test in a specific group.

This annotation is only allowed for methods annotated as A_Test.

A test group allows tests to be grouped. When the runner runs, it will pick only those tests belonging to the group given to the runner.

For C99 it is possible to put a test in an arbitrary number of groups. For C89 a test can be put in only one group.

The default group of a test is group 0 (zero).

#define A_Ignore   ACEUNIT_META_ANNOTATION

Ignore annotation, use for test cases to ignore.

This annotation is only allowed for methods annotated as A_Test.

#define A_Loop ( times   )     ACEUNIT_META_ANNOTATION

Loop annotation, use for looping test cases.

Define ACEUNIT_LOOP to enable this feature. If this feature is enabled, a test case is looped times times by the runner. The loop will only loop the test itself. It will not loop its A_Before and A_After methods.

Parameters:
times Number of times to loop.

#define A_Test   ACEUNIT_DIRECT_ANNOTATION

Test annotation, use for test cases.

#define ACEUNIT_ANNOTATION

The super type of annotations.

Annotations are either ignored by the compiler or you can declare them to create static methods. To use the latter, define ACEUNIT_STATIC_ANNOTATIONS.

#define ACEUNIT_DIRECT_ANNOTATION   ACEUNIT_ANNOTATION

A direct annotation is an annotation which turns an arbitrary method into a test fixture method.

A method can have only zero or one direct annotations, not more. That means direct annotations cannot be combined.

#define ACEUNIT_META_ANNOTATION   ACEUNIT_ANNOTATION

A meta annotation is an annotation which cannot be used standalone but only provides additional information for another annotation.

A method can have multiple meta annotations, but only if it already was annotated with a direct annotation.

#define ACEUNITANNOTATIONS_H   1

Include shield to protect the header file from being included more than once.


Generated on Sun Feb 13 11:10:16 2011 for AceUnit by  doxygen 1.5.3