src/include/eina_hamster.h

   1 /* EINA - EFL data type library
   2  * Copyright (C) 2008 Cedric Bail
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library;
  16  * if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef EINA_HAMSTER_H_
  20 #define EINA_HAMSTER_H_
  21
  22 /**
  23  * @addtogroup Eina_Hamster_Group Hamster
  24  *
  25  * @brief These functions provide hamster calls.
  26  *
  27  * @{
  28  */
  29
  30 /**
  31  * @addtogroup Eina_Core_Group Core
  32  *
  33  * @{
  34  */
  35
  36 /**
  37  * @defgroup Eina_Hamster_Group Hamster
  38  */
  39
  40
  41 /**
  42  * @brief Get the hamster count.
  43  *
  44  * @return The number of available hamsters.
  45  *
  46  * This function returns how many hamsters you have.
  47  */
  48 EAPI int eina_hamster_count(void);
  49
  50 /**
  51  * @}
  52  */
  53
  54 /**
  55  * @}
  56  */
  57
  58 #endif /* EINA_HAMSTER_H_ */