WCudaMSE/Tuto_Doxy/src/header/Animals.h

   1 #ifndef ANIMAL_H_
   2 #define ANIMAL_H_
   3
   4 /*----------------------------------------------------------------------*\
   5  |*                     Declaration                                     *|
   6  \*---------------------------------------------------------------------*/
   7
   8 /*--------------------------------------*\
   9  |*             Public                  *|
  10  \*-------------------------------------*/
  11
  12 /**
  13  * @class Animals
  14  * @brief Represent the ensemble of Animals
  15  *
  16  * <pre>
  17  * Here you can write the full documentation of teh class Animal.
  18  * It's up to you!
  19  * </pre>
  20  *
  21  * http://en.wikipedia.org
  22  */
  23 class Animals
  24     {
  25     public:
  26
  27         /**
  28          * @param poids in kg
  29          */
  30         Animals(int poids);
  31
  32         /**
  33          * Destructor exist in <b>C++</b>, we are not in java!
  34          */
  35         virtual ~Animals();
  36
  37         /**
  38          * <pre>
  39          * Virtual method to eat.
  40          * Animal need to eat for live!
  41          * </pre>
  42          */
  43         virtual void eat()=0;
  44
  45         /**
  46          * Get the poids of the car
  47          * @return weight in kg
  48          */
  49         int getPoids();
  50
  51
  52     private:
  53         int poids; ///<en kg
  54     };
  55
  56 #endif
  57
  58 /*----------------------------------------------------------------------*\
  59  |*                     End                                             *|
  60  \*---------------------------------------------------------------------*/