code documentation update

This commit is contained in:
Julien Danjou 2007-12-30 15:11:37 +01:00
parent 3216eb4d41
commit 84c59a5704
2 changed files with 23 additions and 3 deletions

20
draw.c
View File

@ -29,6 +29,12 @@
extern AwesomeConf globalconf; extern AwesomeConf globalconf;
/** Get a draw context
* \param phys_screen physical screen id
* \param width width
* \param height height
* \return draw context ref
*/
DrawCtx * DrawCtx *
draw_get_context(int phys_screen, int width, int height) draw_get_context(int phys_screen, int width, int height)
{ {
@ -46,6 +52,9 @@ draw_get_context(int phys_screen, int width, int height)
return d; return d;
}; };
/** Free a draw context and its drawable
* \param ctx the draw context to free
*/
void void
draw_free_context(DrawCtx *ctx) draw_free_context(DrawCtx *ctx)
{ {
@ -53,6 +62,17 @@ draw_free_context(DrawCtx *ctx)
p_delete(&ctx); p_delete(&ctx);
} }
/** Draw text into a draw context
* \param x x coord
* \param y y coord
* \param w width
* \param h height
* \param padding padding to add before drawing the text
* \param font font to use
* \param text text to draw
* \param fg foreground color
* \param bg background color
*/
void void
draw_text(DrawCtx *ctx, int x, int y, int w, int h, int padding, XftFont *font, const char *text, XColor fg, XColor bg) draw_text(DrawCtx *ctx, int x, int y, int w, int h, int padding, XftFont *font, const char *text, XColor fg, XColor bg)
{ {

View File

@ -31,8 +31,8 @@ extern AwesomeConf globalconf;
/** Get screens info /** Get screens info
* \param screen Screen number * \param screen Screen number
* \param statusbar statusbar * \param statusbar statusbar
* \return Area
* \param padding Padding * \param padding Padding
* \return Area
*/ */
Area Area
get_screen_area(int screen, Statusbar *statusbar, Padding *padding) get_screen_area(int screen, Statusbar *statusbar, Padding *padding)
@ -175,8 +175,8 @@ get_phys_screen(int screen)
/** Move a client to a virtual screen /** Move a client to a virtual screen
* \param c the client * \param c the client
* \param new_screen The destinatiuon screen * \param new_screen The destinatiuon screen
* \param doresize set to True if we also move the client to the new x_org and * \param doresize set to True if we also move the client to the new x and
* y_org of the new screen * y of the new screen
*/ */
void void
move_client_to_screen(Client *c, int new_screen, Bool doresize) move_client_to_screen(Client *c, int new_screen, Bool doresize)