include/SDL_power.h
changeset 3407 d3baf5ac4e37
parent 3170 b7a48f533966
child 3428 78475292e059
     1.1 --- a/include/SDL_power.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_power.h	Mon Oct 19 13:31:58 2009 +0000
     1.3 @@ -24,9 +24,9 @@
     1.4  #define _SDL_power_h
     1.5  
     1.6  /**
     1.7 - * \file SDL_power.h
     1.8 - *
     1.9 - * Header for the SDL power management routines
    1.10 + *  \file SDL_power.h
    1.11 + *  
    1.12 + *  Header for the SDL power management routines.
    1.13   */
    1.14  
    1.15  #include "SDL_stdinc.h"
    1.16 @@ -40,9 +40,7 @@
    1.17  #endif
    1.18  
    1.19  /**
    1.20 - * \enum SDL_PowerState
    1.21 - *
    1.22 - * \brief The basic state for the system's power supply.
    1.23 + *  \brief The basic state for the system's power supply.
    1.24   */
    1.25  typedef enum
    1.26  {
    1.27 @@ -55,19 +53,17 @@
    1.28  
    1.29  
    1.30  /**
    1.31 - * \fn int SDL_GetPowerInfo(void)
    1.32 - *
    1.33 - * \brief Get the current power supply details.
    1.34 - *
    1.35 - * \param secs Seconds of battery life left. You can pass a NULL here if
    1.36 - *                you don't care. Will return -1 if we can't determine a
    1.37 - *                value, or we're not running on a battery.
    1.38 - *
    1.39 - * \param pct Percentage of battery life left, between 0 and 100. You can
    1.40 - *                pass a NULL here if you don't care. Will return -1 if we
    1.41 - *                can't determine a value, or we're not running on a battery.
    1.42 - *
    1.43 - * \return The state of the battery (if any).
    1.44 + *  \brief Get the current power supply details.
    1.45 + *  
    1.46 + *  \param secs Seconds of battery life left. You can pass a NULL here if
    1.47 + *              you don't care. Will return -1 if we can't determine a
    1.48 + *              value, or we're not running on a battery.
    1.49 + *  
    1.50 + *  \param pct Percentage of battery life left, between 0 and 100. You can
    1.51 + *             pass a NULL here if you don't care. Will return -1 if we
    1.52 + *             can't determine a value, or we're not running on a battery.
    1.53 + *  
    1.54 + *  \return The state of the battery (if any).
    1.55   */
    1.56  extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct);
    1.57