Fixed various mistakes in the doxygen. gsoc2008_force_feedback
authorEdgar Simo <bobbens@gmail.com>
Sun, 06 Jul 2008 17:06:37 +0000
branchgsoc2008_force_feedback
changeset 2498ab567bd667bf
parent 2497 0893fbf73b3d
child 2499 cc2b270608b2
Fixed various mistakes in the doxygen.
include/SDL_haptic.h
     1.1 --- a/include/SDL_haptic.h	Sun Jul 06 16:53:32 2008 +0000
     1.2 +++ b/include/SDL_haptic.h	Sun Jul 06 17:06:37 2008 +0000
     1.3 @@ -20,11 +20,12 @@
     1.4      slouken@libsdl.org
     1.5  */
     1.6  
     1.7 -/** \file SDL_haptic.h */
     1.8 +/** \file SDL_Haptic.h */
     1.9 +
    1.10  /**
    1.11   * \mainpage SDL_haptic
    1.12   *
    1.13 - * The SDL Haptic subsystem allows you to control haptic (force feedback)
    1.14 + * \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
    1.15   *  devices.
    1.16   *
    1.17   * The basic usage is as follows:
    1.18 @@ -102,7 +103,7 @@
    1.19  #endif /* __cpluspuls */
    1.20  
    1.21  /**
    1.22 - * \struct SDL_Haptic
    1.23 + * \typedef SDL_Haptic
    1.24   *
    1.25   * \brief The haptic structure used to identify an SDL haptic.
    1.26   *
    1.27 @@ -389,7 +390,7 @@
    1.28     Uint16 fade_length; /**< Duration of the fade. */
    1.29     Uint16 fade_level; /**< Level at the end of the fade. */
    1.30  } SDL_HapticRamp;
    1.31 -/*
    1.32 +/**
    1.33   * \union SDL_HapticEffect
    1.34   *
    1.35   * \brief The generic template for any haptic effect.
    1.36 @@ -429,7 +430,7 @@
    1.37  
    1.38  
    1.39  /* Function prototypes */
    1.40 -/*
    1.41 +/**
    1.42   * \fn int SDL_NumHaptics(void)
    1.43   *
    1.44   * \brief Count the number of joysticks attached to the system.
    1.45 @@ -438,7 +439,7 @@
    1.46   */
    1.47  extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
    1.48  
    1.49 -/*
    1.50 +/**
    1.51   * \fn const char * SDL_HapticName(int device_index)
    1.52   *
    1.53   * \brief Get the implementation dependent name of a Haptic device.
    1.54 @@ -452,7 +453,7 @@
    1.55   */
    1.56  extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
    1.57  
    1.58 -/*
    1.59 +/**
    1.60   * \fn SDL_Haptic * SDL_HapticOpen(int device_Index)
    1.61   *
    1.62   * \brief Opens a Haptic device for usage - the index passed as an
    1.63 @@ -469,8 +470,8 @@
    1.64   */
    1.65  extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);
    1.66  
    1.67 -/*
    1.68 - * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joysticke)
    1.69 +/**
    1.70 + * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
    1.71   *
    1.72   * \brief Checks to see if a joystick has haptic features.
    1.73   *
    1.74 @@ -482,7 +483,7 @@
    1.75   */
    1.76  extern DECLSPEC int SDL_JoystickIsHaptic(SDL_Joystick * joystick);
    1.77  
    1.78 -/*
    1.79 +/**
    1.80   * \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
    1.81   *
    1.82   * \brief Opens a Haptic device for usage from a Joystick device.  Still has
    1.83 @@ -496,7 +497,7 @@
    1.84   */
    1.85  extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick);
    1.86  
    1.87 -/* 
    1.88 +/**
    1.89   * \fn void SDL_HapticClose(SDL_Haptic * haptic)
    1.90   *
    1.91   * \brief Closes a Haptic device previously opened with SDL_HapticOpen.
    1.92 @@ -505,7 +506,7 @@
    1.93   */
    1.94  extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);
    1.95  
    1.96 -/*
    1.97 +/**
    1.98   * \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
    1.99   *
   1.100   * \brief Returns the number of effects a haptic device can store.
   1.101 @@ -518,7 +519,7 @@
   1.102   */
   1.103  extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);
   1.104  
   1.105 -/*
   1.106 +/**
   1.107   * \fn unsigned int SDL_HapticQueryEffects(SDL_Haptic * haptic)
   1.108   *
   1.109   * \brief Gets the haptic devices supported features in bitwise matter.
   1.110 @@ -539,7 +540,7 @@
   1.111   */
   1.112  extern DECLSPEC unsigned int SDL_HapticQuery(SDL_Haptic * haptic);
   1.113  
   1.114 -/*
   1.115 +/**
   1.116   * \fn int SDL_HapticEffectSupported
   1.117   *
   1.118   * \brief Checks to see if effect is supported by haptic.
   1.119 @@ -554,7 +555,7 @@
   1.120   */
   1.121  extern DECLSPEC int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect);
   1.122  
   1.123 -/*
   1.124 +/**
   1.125   * \fn int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
   1.126   *
   1.127   * \brief Creates a new haptic effect on the device.
   1.128 @@ -569,7 +570,7 @@
   1.129   */
   1.130  extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);
   1.131  
   1.132 -/*
   1.133 +/**
   1.134   * \fn int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
   1.135   *
   1.136   * \brief Updates an effect.  Can be used dynamically, although behaviour when
   1.137 @@ -588,7 +589,7 @@
   1.138   */
   1.139  extern DECLSPEC int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data);
   1.140  
   1.141 -/*
   1.142 +/**
   1.143   * \fn int SDL_HapticRunEffects(SDL_Haptic * haptic, int effect)
   1.144   *
   1.145   * \brief Runs the haptic effect on it's assosciated haptic device.
   1.146 @@ -603,7 +604,7 @@
   1.147   */
   1.148  extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);
   1.149  
   1.150 -/*
   1.151 +/**
   1.152   * \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
   1.153   *
   1.154   * \brief Stops the haptic effect on it's assosciated haptic device.
   1.155 @@ -617,7 +618,7 @@
   1.156   */
   1.157  extern DECLSPEC int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);
   1.158  
   1.159 -/*
   1.160 +/**
   1.161   * \fn void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
   1.162   *
   1.163   * \brief Destroys a haptic effect on the device.  This will stop the effect
   1.164 @@ -631,7 +632,7 @@
   1.165   */
   1.166  extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);
   1.167  
   1.168 -/*
   1.169 +/**
   1.170   * \fn int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
   1.171   *
   1.172   * \brief Gets the status of the current effect on the haptic device.
   1.173 @@ -648,7 +649,7 @@
   1.174   */
   1.175  extern DECLSPEC int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect);
   1.176  
   1.177 -/*
   1.178 +/**
   1.179   * \fn int SDL_HapticSetGain(SDL_Haptic * haptic, int gain)
   1.180   *
   1.181   * \brief Sets the global gain of the device.  Gain should be between 0 and 100.
   1.182 @@ -663,7 +664,7 @@
   1.183   */
   1.184  extern DECLSPEC int SDL_HapticSetGain(SDL_Haptic * haptic, int gain);
   1.185  
   1.186 -/*
   1.187 +/**
   1.188   * \fn int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
   1.189   *
   1.190   * \brief Sets the global autocenter of the device.  Autocenter should be between