Changeset 192c04 for src/version.hpp

Timestamp:

Jan 10, 2011, 8:07:18 PM (15 years ago)

Author:

Frederik Heber <heber@…>

Children:

56d62f

Parents:

8dd38e

git-author:

Frederik Heber <heber@…> (01/10/11 20:00:52)

git-committer:

Frederik Heber <heber@…> (01/10/11 20:07:18)

Message:

FIX: make dist works, documentation changed and working (basically).

• make dist lacked some nodist_..._SOURCES.
• doc is now created in top_builddir/doc, not top_srcdir.
• Doxyfile is now created by configure and package name, version and paths are adapted therein.

File:

• src/version.hpp (modified) (1 diff)

src/version.hpp

@@ -7 +7 @@
 #endif
 
+/*! \mainpage Introduction to CodePatterns
+ *
+ *  This is the introductory page to the CodePatterns package.
+ *
+ *  <h1> Aim </h1>
+ *
+ *  The CodePatterns tries to contain a good set of prefactured design patterns
+ *  for your ease-of-use. Special emphasis is placed on \a immediate usability.
+ *  In most cases, you only have to know the type of design pattern you want,
+ *  let's call it foo, then include a \b foo.hpp in your definition, a
+ *  \b foo_impl.hpp in your implementation, maybe do some inheritance and your
+ *  good to go. At times you will need to call a macro such as \b
+ *  CONSTRUCT_FOO(..) which tells the pattern about your specific class or you
+ *  have to create a \b foo.def file containing some #define's with an equal
+ *  intention. But that's supposed to be it.
+ *
+ *  <h1> Overview of implemented patterns </h1>
+ *
+ *  - \ref Cacheable - class wraps a value obtained via some expensive
+ *    calculation and only performs update when necessary.
+ *  - \ref Clone - class can create copies of itself with specific interface,
+ *    copies can be manipulated at construction.
+ *  - \ref Creator - class can create copies of itself with specific interface.
+ *  - \ref Factory - contains table of Creator and spawns new instances on user
+ *    request.
+ *  - \ref ManipulablePrototypeFactory - contains table of clones or prototypes
+ *    and spawns new \a manipulated instances on user request.
+ *  - \ref Observer - class can observe changes in other class via this
+ *    interface.
+ *  - \ref PrototypeFactory - contains table of clones or prototypes and spawns
+ *    new instances on user request.
+ *  - \ref Registry - contains a map to instances which can be retrieved on
+ *    user request.
+ *  - \ref Singleton - global, unique instance of a class.
+ */
+
 extern const char *CODEPATTERNSVERSION;
 extern const char *CODEPATTERNSFULLVERSION;