| 1 | #ifndef VERSION_HPP_ | 
|---|
| 2 | #define VERSION_HPP_ | 
|---|
| 3 |  | 
|---|
| 4 | // include config.h | 
|---|
| 5 | #ifdef HAVE_CONFIG_H | 
|---|
| 6 | #include <config.h> | 
|---|
| 7 | #endif | 
|---|
| 8 |  | 
|---|
| 9 | /*! \mainpage Introduction to CodePatterns | 
|---|
| 10 | * | 
|---|
| 11 | *  This is the introductory page to the CodePatterns package. | 
|---|
| 12 | * | 
|---|
| 13 | *  <h1> Aim </h1> | 
|---|
| 14 | * | 
|---|
| 15 | *  The CodePatterns tries to contain a good set of prefactured design patterns | 
|---|
| 16 | *  for your ease-of-use. Special emphasis is placed on \a immediate usability. | 
|---|
| 17 | *  In most cases, you only have to know the type of design pattern you want, | 
|---|
| 18 | *  let's call it foo, then include a \b foo.hpp in your definition, a | 
|---|
| 19 | *  \b foo_impl.hpp in your implementation, maybe do some inheritance and your | 
|---|
| 20 | *  good to go. At times you will need to call a macro such as \b | 
|---|
| 21 | *  CONSTRUCT_FOO(..) which tells the pattern about your specific class or you | 
|---|
| 22 | *  have to create a \b foo.def file containing some #define's with an equal | 
|---|
| 23 | *  intention. But that's supposed to be it. | 
|---|
| 24 | * | 
|---|
| 25 | *  <h1> Overview of implemented patterns </h1> | 
|---|
| 26 | * | 
|---|
| 27 | *  - \ref Cacheable - class wraps a value obtained via some expensive | 
|---|
| 28 | *    calculation and only performs update when necessary. | 
|---|
| 29 | *  - \ref Clone - class can create copies of itself with specific interface, | 
|---|
| 30 | *    copies can be manipulated at construction. | 
|---|
| 31 | *  - \ref Creator - class can create copies of itself with specific interface. | 
|---|
| 32 | *  - \ref Factory - contains table of Creator and spawns new instances on user | 
|---|
| 33 | *    request. | 
|---|
| 34 | *  - \ref ManipulablePrototypeFactory - contains table of clones or prototypes | 
|---|
| 35 | *    and spawns new \a manipulated instances on user request. | 
|---|
| 36 | *  - \ref Observer - class can observe changes in other class via this | 
|---|
| 37 | *    interface. | 
|---|
| 38 | *  - \ref PrototypeFactory - contains table of clones or prototypes and spawns | 
|---|
| 39 | *    new instances on user request. | 
|---|
| 40 | *  - \ref Registry - contains a map to instances which can be retrieved on | 
|---|
| 41 | *    user request. | 
|---|
| 42 | *  - \ref Singleton - global, unique instance of a class. | 
|---|
| 43 | */ | 
|---|
| 44 |  | 
|---|
| 45 | extern const char *CODEPATTERNSVERSION; | 
|---|
| 46 | extern const char *CODEPATTERNSFULLVERSION; | 
|---|
| 47 |  | 
|---|
| 48 | #endif /* VERSION_HPP_ */ | 
|---|