Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Commit

Permalink
Fixed various mistakes in the doxygen.
Browse files Browse the repository at this point in the history
  • Loading branch information
@bobbens
bobbens committed Jul 6, 2008
1 parent d460f6a commit a7621b8
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions include/SDL_haptic.h
View file
Expand Up @@ -20,11 +20,12 @@
slouken@libsdl.org
*/

/** \file SDL_haptic.h */
/** \file SDL_Haptic.h */

/**
* \mainpage SDL_haptic
*
* The SDL Haptic subsystem allows you to control haptic (force feedback)
* \brief The SDL Haptic subsystem allows you to control haptic (force feedback)
* devices.
*
* The basic usage is as follows:
Expand Down Expand Up @@ -102,7 +103,7 @@ extern "C" {
#endif /* __cpluspuls */

/**
* \struct SDL_Haptic
* \typedef SDL_Haptic
*
* \brief The haptic structure used to identify an SDL haptic.
*
Expand Down Expand Up @@ -389,7 +390,7 @@ typedef struct SDL_HapticRamp {
Uint16 fade_length; /**< Duration of the fade. */
Uint16 fade_level; /**< Level at the end of the fade. */
} SDL_HapticRamp;
/*
/**
* \union SDL_HapticEffect
*
* \brief The generic template for any haptic effect.
Expand Down Expand Up @@ -429,7 +430,7 @@ typedef union SDL_HapticEffect {


/* Function prototypes */
/*
/**
* \fn int SDL_NumHaptics(void)
*
* \brief Count the number of joysticks attached to the system.
Expand All @@ -438,7 +439,7 @@ typedef union SDL_HapticEffect {
*/
extern DECLSPEC int SDLCALL SDL_NumHaptics(void);

/*
/**
* \fn const char * SDL_HapticName(int device_index)
*
* \brief Get the implementation dependent name of a Haptic device.
Expand All @@ -452,7 +453,7 @@ extern DECLSPEC int SDLCALL SDL_NumHaptics(void);
*/
extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);

/*
/**
* \fn SDL_Haptic * SDL_HapticOpen(int device_Index)
*
* \brief Opens a Haptic device for usage - the index passed as an
Expand All @@ -469,8 +470,8 @@ extern DECLSPEC const char *SDLCALL SDL_HapticName(int device_index);
*/
extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);

/*
* \fn int SDL_JoystickIsHaptic(SDL_Joystick * joysticke)
/**
* \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
*
* \brief Checks to see if a joystick has haptic features.
*
Expand All @@ -482,7 +483,7 @@ extern DECLSPEC SDL_Haptic * SDL_HapticOpen(int device_index);
*/
extern DECLSPEC int SDL_JoystickIsHaptic(SDL_Joystick * joystick);

/*
/**
* \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
*
* \brief Opens a Haptic device for usage from a Joystick device. Still has
Expand All @@ -496,7 +497,7 @@ extern DECLSPEC int SDL_JoystickIsHaptic(SDL_Joystick * joystick);
*/
extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick);

/*
/**
* \fn void SDL_HapticClose(SDL_Haptic * haptic)
*
* \brief Closes a Haptic device previously opened with SDL_HapticOpen.
Expand All @@ -505,7 +506,7 @@ extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
*/
extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);

/*
/**
* \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
*
* \brief Returns the number of effects a haptic device can store.
Expand All @@ -518,7 +519,7 @@ extern DECLSPEC void SDL_HapticClose(SDL_Haptic * haptic);
*/
extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);

/*
/**
* \fn unsigned int SDL_HapticQueryEffects(SDL_Haptic * haptic)
*
* \brief Gets the haptic devices supported features in bitwise matter.
Expand All @@ -539,7 +540,7 @@ extern DECLSPEC int SDL_HapticNumEffects(SDL_Haptic * haptic);
*/
extern DECLSPEC unsigned int SDL_HapticQuery(SDL_Haptic * haptic);

/*
/**
* \fn int SDL_HapticEffectSupported
*
* \brief Checks to see if effect is supported by haptic.
Expand All @@ -554,7 +555,7 @@ extern DECLSPEC unsigned int SDL_HapticQuery(SDL_Haptic * haptic);
*/
extern DECLSPEC int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEffect * effect);

/*
/**
* \fn int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect)
*
* \brief Creates a new haptic effect on the device.
Expand All @@ -569,7 +570,7 @@ extern DECLSPEC int SDL_HapticEffectSupported(SDL_Haptic * haptic, SDL_HapticEff
*/
extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect * effect);

/*
/**
* \fn int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data)
*
* \brief Updates an effect. Can be used dynamically, although behaviour when
Expand All @@ -588,7 +589,7 @@ extern DECLSPEC int SDL_HapticNewEffect(SDL_Haptic * haptic, SDL_HapticEffect *
*/
extern DECLSPEC int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data);

/*
/**
* \fn int SDL_HapticRunEffects(SDL_Haptic * haptic, int effect)
*
* \brief Runs the haptic effect on it's assosciated haptic device.
Expand All @@ -603,7 +604,7 @@ extern DECLSPEC int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_
*/
extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);

/*
/**
* \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)
*
* \brief Stops the haptic effect on it's assosciated haptic device.
Expand All @@ -617,7 +618,7 @@ extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect);
*/
extern DECLSPEC int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);

/*
/**
* \fn void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect)
*
* \brief Destroys a haptic effect on the device. This will stop the effect
Expand All @@ -631,7 +632,7 @@ extern DECLSPEC int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect);
*/
extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);

/*
/**
* \fn int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect)
*
* \brief Gets the status of the current effect on the haptic device.
Expand All @@ -648,7 +649,7 @@ extern DECLSPEC void SDL_HapticDestroyEffect(SDL_Haptic * haptic, int effect);
*/
extern DECLSPEC int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect);

/*
/**
* \fn int SDL_HapticSetGain(SDL_Haptic * haptic, int gain)
*
* \brief Sets the global gain of the device. Gain should be between 0 and 100.
Expand All @@ -663,7 +664,7 @@ extern DECLSPEC int SDL_HapticGetEffectStatus(SDL_Haptic *haptic, int effect);
*/
extern DECLSPEC int SDL_HapticSetGain(SDL_Haptic * haptic, int gain);

/*
/**
* \fn int SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
*
* \brief Sets the global autocenter of the device. Autocenter should be between
Expand Down

0 comments on commit a7621b8

Please sign in to comment.