Documentation update: Make some comments more understandable, more docs

This commit is contained in:
Michael Stapelberg 2009-03-01 22:00:54 +01:00
parent 6868534fcb
commit ac6567c0a6
2 changed files with 12 additions and 6 deletions

View File

@ -128,7 +128,7 @@ struct Workspace {
int cols; int cols;
int rows; int rows;
/* These are stored here just while this workspace is _not_ shown (see show_workspace()) */ /* These are stored here only while this workspace is _not_ shown (see show_workspace()) */
int current_row; int current_row;
int current_col; int current_col;
@ -162,9 +162,9 @@ struct Binding {
}; };
/* /*
* We need to save the height of a font because it is required for each drawing of * Data structure for cached font information:
* text but relatively hard to get. As soon as a new font needs to be loaded, a * - font id in X11 (load it once)
* Font-entry will be filled for later use. * - font height (multiple calls needed to get it)
* *
*/ */
struct Font { struct Font {
@ -206,6 +206,7 @@ struct Client {
/* fullscreen is pretty obvious */ /* fullscreen is pretty obvious */
bool fullscreen; bool fullscreen;
/* Ensure TITLEBAR_TOP maps to 0 because we use calloc for initialization later */
enum { TITLEBAR_TOP = 0, TITLEBAR_LEFT, TITLEBAR_RIGHT, TITLEBAR_BOTTOM, TITLEBAR_OFF } titlebar_position; enum { TITLEBAR_TOP = 0, TITLEBAR_LEFT, TITLEBAR_RIGHT, TITLEBAR_BOTTOM, TITLEBAR_OFF } titlebar_position;
/* If a client is set as a dock, it is placed at the very bottom of the screen and its /* If a client is set as a dock, it is placed at the very bottom of the screen and its
@ -227,6 +228,8 @@ struct Client {
xcb_window_t child; /* The clients window */ xcb_window_t child; /* The clients window */
/* Cache of colorpixels for this client */ /* Cache of colorpixels for this client */
/* TODO: Couldnt we move them outside here, as they should only depend on the
root window? */
SLIST_HEAD(colorpixel_head, Colorpixel) colorpixels; SLIST_HEAD(colorpixel_head, Colorpixel) colorpixels;
/* The following entry provides the necessary list pointers to use Client with LIST_* macros */ /* The following entry provides the necessary list pointers to use Client with LIST_* macros */
@ -253,6 +256,9 @@ struct Container {
/* Width/Height of the container. Changeable by the user */ /* Width/Height of the container. Changeable by the user */
int width; int width;
int height; int height;
/* width_factor and height_factor contain the amount of space (percentage) a window
has of all the space which is available for resized windows. This ensures that
non-resized windows (newly opened, for example) have the same size as always */
float width_factor; float width_factor;
float height_factor; float height_factor;
@ -263,7 +269,7 @@ struct Container {
Workspace *workspace; Workspace *workspace;
/* Ensure MODE_DEFAULT maps to 0 because we use calloc for initialization later */ /* Ensure MODE_DEFAULT maps to 0 because we use calloc for initialization later */
enum { MODE_DEFAULT = 0, MODE_STACK = 1 } mode; enum { MODE_DEFAULT = 0, MODE_STACK } mode;
CIRCLEQ_HEAD(client_head, Client) clients; CIRCLEQ_HEAD(client_head, Client) clients;
}; };

View File

@ -28,7 +28,7 @@
th new one and returns true if it changed */ th new one and returns true if it changed */
#define HAS_CHANGED(value, new) (old_value = value, old_value != (value = new)) #define HAS_CHANGED(value, new) (old_value = value, old_value != (value = new))
int old_value; static int old_value;
/* /*
* Gets the unoccupied space (= space which is available for windows which were resized by the user) * Gets the unoccupied space (= space which is available for windows which were resized by the user)