Doc fix.
authorladanyi
Mon, 20 Nov 2006 10:14:21 +0000
changeset 2304108d6db4f32a
parent 2303 005b3f927287
child 2305 4a2236cc98a0
Doc fix.
lemon/simann.h
     1.1 --- a/lemon/simann.h	Tue Nov 14 09:49:26 2006 +0000
     1.2 +++ b/lemon/simann.h	Mon Nov 20 10:14:21 2006 +0000
     1.3 @@ -83,6 +83,7 @@
     1.4    };
     1.5  
     1.6    /// \brief Simulated annealing abstract base class.
     1.7 +  ///
     1.8    /// Can be used to derive a custom simulated annealing class if \ref SimAnn
     1.9    /// doesn't fit your needs.
    1.10    class SimAnnBase {
    1.11 @@ -214,6 +215,7 @@
    1.12    };
    1.13  
    1.14    /// \brief A simple controller for the simulated annealing class.
    1.15 +  ///
    1.16    /// This controller starts from a given initial temperature and evenly
    1.17    /// decreases it.
    1.18    class SimpleController : public ControllerBase {
    1.19 @@ -265,6 +267,7 @@
    1.20  
    1.21    /// \brief A controller with preset running time for the simulated annealing
    1.22    /// class.
    1.23 +  ///
    1.24    /// With this controller you can set the running time of the annealing
    1.25    /// process in advance. It works the following way: the controller measures
    1.26    /// a kind of divergence. The divergence is the difference of the average