[Fix] Few corrections in documentation.

This commit is contained in:
Allanis 2013-10-22 18:54:30 +01:00
parent 6764a1c424
commit 435be644cf
2 changed files with 22 additions and 10 deletions

View File

@ -65,12 +65,16 @@ typedef struct glTexture_ {
char* name; /**< Name of graphic. */ char* name; /**< Name of graphic. */
/* Dimensions */ /* Dimensions */
double w, h; /**< Real size of the image (excluding POT buffer). */ double w; /**< Real width of the image. */
double rw, rh; /**< Size of POT surface. */ double h; /**< Real height of the image. */
double rw; /**< Padded POT width of the image. */
double rh; /**< Padded POT height of the image. */
/* Sprites */ /* Sprites */
double sx, sy; /**< Number of sprites on x and y axes. */ double sx; /**< Number of sprites on the x axis. */
double sw, sh; /**< Size of each sprite. */ double sy; /**< Number of sprites on the y axis. */
double sw; /**< Width of the sprite. */
double sh; /**< Height of the sprite. */
/* Data */ /* Data */
GLuint texture; /**< The opengl texture itself. */ GLuint texture; /**< The opengl texture itself. */

View File

@ -100,8 +100,10 @@ extern StarSystem* systems_stack;
* @brief Represents the player's radar. * @brief Represents the player's radar.
*/ */
typedef struct Radar_ { typedef struct Radar_ {
double x,y; /**< Position. */ double x; /**< X position. */
double w,h; /**< Dimensions. */ double y; /**< Y position. */
double w; /**< Width. */
double h; /**< Height. */
RadarShape shape; /**< Shape. */ RadarShape shape; /**< Shape. */
double res; /**< Resolution. */ double res; /**< Resolution. */
} Radar; } Radar;
@ -118,8 +120,10 @@ typedef struct Radar_ {
* @brief Represents a rectangle. * @brief Represents a rectangle.
*/ */
typedef struct Rect_ { typedef struct Rect_ {
double x,y; double x; /**< X position. */
double w,h; double y; /**< Y position. */
double w; /**< Width. */
double h; /**< Height. */
} Rect; } Rect;
/** /**
@ -134,9 +138,13 @@ typedef struct GUI_ {
Radar radar; /**< The radar. */ Radar radar; /**< The radar. */
Rect nav; /**< Navigation computer. */ Rect nav; /**< Navigation computer. */
Rect shield, armour, energy; /**< Health bars. */ Rect shield; /**< Shield bar. */
Rect armour; /**< Armour bar. */
Rect energy; /**< Energy bar. */
Rect weapon; /**< Weapon targeting system. */ Rect weapon; /**< Weapon targeting system. */
Rect target_health, target_name, target_faction; /**< Target stuff. */ Rect target_health; /**< Target health. */
Rect target_name; /**< Name of the target. */
Rect target_faction; /**< Faction of the target. */
Rect misc; /**< Misc stuff: credits, cargo.. */ Rect misc; /**< Misc stuff: credits, cargo.. */
Rect msg; /**< Where messages go. */ Rect msg; /**< Where messages go. */