include/SDL_mouse.h
branchSDL-1.3
changeset 1673 624e1412fbba
parent 1671 89f7510fe17a
child 1722 5daa04d862f1
     1.1 --- a/include/SDL_mouse.h	Fri Jun 09 07:06:12 2006 +0000
     1.2 +++ b/include/SDL_mouse.h	Sat Jun 10 09:11:59 2006 +0000
     1.3 @@ -45,7 +45,8 @@
     1.4  
     1.5  /* Function prototypes */
     1.6  
     1.7 -/* \fn int SDL_GetNumMice(void)
     1.8 +/**
     1.9 + * \fn int SDL_GetNumMice(void)
    1.10   *
    1.11   * \brief Get the number of mouse input devices available.
    1.12   *
    1.13 @@ -53,7 +54,8 @@
    1.14   */
    1.15  extern DECLSPEC int SDLCALL SDL_GetNumMice(void);
    1.16  
    1.17 -/* \fn int SDL_SelectMouse(int index)
    1.18 +/**
    1.19 + * \fn int SDL_SelectMouse(int index)
    1.20   *
    1.21   * \brief Set the index of the currently selected mouse.
    1.22   *
    1.23 @@ -65,13 +67,14 @@
    1.24   */
    1.25  extern DECLSPEC int SDLCALL SDL_SelectMouse(int index);
    1.26  
    1.27 -/* \fn SDL_WindowID SDL_GetMouseFocusWindow(void)
    1.28 +/**
    1.29 + * \fn SDL_WindowID SDL_GetMouseFocusWindow(void)
    1.30   *
    1.31   * \brief Get the window which currently has focus for the currently selected mouse.
    1.32   */
    1.33  extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(void);
    1.34  
    1.35 -/*
    1.36 +/**
    1.37   * \fn Uint8 SDL_GetMouseState(int *x, int *y)
    1.38   *
    1.39   * \brief Retrieve the current state of the mouse.
    1.40 @@ -83,7 +86,7 @@
    1.41   */
    1.42  extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y);
    1.43  
    1.44 -/*
    1.45 +/**
    1.46   * \fn Uint8 SDL_GetRelativeMouseState(int *x, int *y)
    1.47   *
    1.48   * \brief Retrieve the current state of the mouse.
    1.49 @@ -94,7 +97,7 @@
    1.50   */
    1.51  extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
    1.52  
    1.53 -/*
    1.54 +/**
    1.55   * \fn void SDL_WarpMouseInWindow(SDL_WindowID windowID, int x, int y)
    1.56   *
    1.57   * \brief Moves the currently selected mouse to the given position within the window.
    1.58 @@ -108,7 +111,7 @@
    1.59  extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_WindowID windowID,
    1.60                                                     int x, int y);
    1.61  
    1.62 -/*
    1.63 +/**
    1.64   * \fn SDL_Cursor *SDL_CreateCursor (const Uint8 * data, const Uint8 * mask, int w, int h, int hot_x, int hot_y)
    1.65   *
    1.66   * \brief Create a cursor for the currently selected mouse, using the
    1.67 @@ -130,7 +133,7 @@
    1.68                                                       int w, int h, int hot_x,
    1.69                                                       int hot_y);
    1.70  
    1.71 -/*
    1.72 +/**
    1.73   * \fn void SDL_SetCursor(SDL_Cursor * cursor)
    1.74   *
    1.75   * \brief Set the active cursor for the currently selected mouse.
    1.76 @@ -139,14 +142,14 @@
    1.77   */
    1.78  extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
    1.79  
    1.80 -/*
    1.81 +/**
    1.82   * \fn SDL_Cursor *SDL_GetCursor(void)
    1.83   *
    1.84   * \brief Return the active cursor for the currently selected mouse.
    1.85   */
    1.86  extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
    1.87  
    1.88 -/*
    1.89 +/**
    1.90   * \fn void SDL_FreeCursor(SDL_Cursor * cursor)
    1.91   *
    1.92   * \brief Frees a cursor created with SDL_CreateCursor().
    1.93 @@ -155,7 +158,7 @@
    1.94   */
    1.95  extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
    1.96  
    1.97 -/*
    1.98 +/**
    1.99   * \fn int SDL_ShowCursor(int toggle)
   1.100   *
   1.101   * \brief Toggle whether or not the cursor is shown for the currently selected mouse.