From 0219de5b614abc449f6c6c3e1438291697bf4eda Mon Sep 17 00:00:00 2001 From: mac Date: Tue, 13 Jun 2000 10:25:53 +0000 Subject: [PATCH] updated documentation --- eo/src/eoFixedLength.h | 1 - eo/src/eoObject.h | 11 ++++++++++- eo/src/eoVariableLength.h | 2 -- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/eo/src/eoFixedLength.h b/eo/src/eoFixedLength.h index 853059ca..1a00d376 100644 --- a/eo/src/eoFixedLength.h +++ b/eo/src/eoFixedLength.h @@ -30,7 +30,6 @@ #include /** -\ingroup EvolutionStrategies Base class for fixed length chromosomes, just derives from EO and vector and redirects the smaller than operator to EO (fitness based comparison) diff --git a/eo/src/eoObject.h b/eo/src/eoObject.h index 32790c8c..b3630de7 100644 --- a/eo/src/eoObject.h +++ b/eo/src/eoObject.h @@ -43,6 +43,14 @@ This is the base class for the whole hierarchy; an eoObject defines basically an interface for the whole hierarchy: each object should know its name (#className#). Previously, this object defined a print and read interface, but itīs been moved to eoPrintable and eoPersistent. + +It is recommended that you only derive from eoObject in concrete classes. +Some parts of EO do not implement this yet, but that will change in the future. +eoObject, together with eoPersistent and eoPrintable provide a simple persistence +framework that is only needed when the classes have state that changes at runtime. + + @see eoPersistent eoPrintable + */ class eoObject { @@ -56,7 +64,8 @@ class eoObject Maarten: removed the default implementation as this proved to be too error-prone: I found several classes that had a typo in className (like classname), which would print eoObject instead of - their own... + their own. Having it pure will force the implementor to provide a + name. */ virtual string className() const = 0; diff --git a/eo/src/eoVariableLength.h b/eo/src/eoVariableLength.h index 43b25f40..33f05e51 100644 --- a/eo/src/eoVariableLength.h +++ b/eo/src/eoVariableLength.h @@ -30,8 +30,6 @@ #include /** -\ingroup EvolutionStrategies - Base class for variable length chromosomes, just derives from EO and list and redirects the smaller than operator to EO (fitness based comparison) */