[cleanup] random doxygen fixes
Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
parent
75cb6b81af
commit
59c04890fc
1
client.c
1
client.c
|
@ -154,7 +154,6 @@ client_isvisible(client_t *c, int screen)
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
/** Get a client by its window.
|
/** Get a client by its window.
|
||||||
* \param list A client_t list to look into.
|
|
||||||
* \param w The client window to find.
|
* \param w The client window to find.
|
||||||
* \return A client pointer if found, NULL otherwise.
|
* \return A client pointer if found, NULL otherwise.
|
||||||
*/
|
*/
|
||||||
|
|
4
cnode.c
4
cnode.c
|
@ -22,7 +22,7 @@
|
||||||
#include "cnode.h"
|
#include "cnode.h"
|
||||||
|
|
||||||
/** Get the client's node focus.
|
/** Get the client's node focus.
|
||||||
* \arap, list The client list.
|
* \param list The client list.
|
||||||
* \param c The client.
|
* \param c The client.
|
||||||
* \return The client node focus.
|
* \return The client node focus.
|
||||||
*/
|
*/
|
||||||
|
@ -39,7 +39,7 @@ client_node_client_getby(client_node_t *list, client_t *c)
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Create a client node for focus.
|
/** Create a client node for focus.
|
||||||
* \arap, list The client list.
|
* \param list The client list.
|
||||||
* \param c The client
|
* \param c The client
|
||||||
* \return The client focus node.
|
* \return The client focus node.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -96,7 +96,7 @@ markup_parse_start_element(GMarkupParseContext *context __attribute__ ((unused))
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Callback to invoke when the closing tag of an element is seen. Note that
|
/** Callback to invoke when the closing tag of an element is seen. Note that
|
||||||
* this is also called for empty tags like <empty/>.
|
* this is also called for empty tags like \<empty/\>.
|
||||||
* Here is just copies element elements we do not care about.
|
* Here is just copies element elements we do not care about.
|
||||||
* \param context the context of GMarkup
|
* \param context the context of GMarkup
|
||||||
* \param element_name element name
|
* \param element_name element name
|
||||||
|
|
3
mouse.c
3
mouse.c
|
@ -131,7 +131,7 @@ mouse_snapclient(client_t *c, area_t geometry, int snap)
|
||||||
|
|
||||||
/** Redraw the resizebar.
|
/** Redraw the resizebar.
|
||||||
* \param ctx Draw context.
|
* \param ctx Draw context.
|
||||||
* \param style The style pointer to use for drawing.
|
* \param sw The simple window.
|
||||||
* \param geometry The geometry to use for the box.
|
* \param geometry The geometry to use for the box.
|
||||||
* \param border The client border size.
|
* \param border The client border size.
|
||||||
*/
|
*/
|
||||||
|
@ -157,7 +157,6 @@ mouse_resizebar_draw(draw_context_t *ctx,
|
||||||
* \param phys_screen Physical screen number.
|
* \param phys_screen Physical screen number.
|
||||||
* \param border Border size of the client.
|
* \param border Border size of the client.
|
||||||
* \param geometry Client geometry.
|
* \param geometry Client geometry.
|
||||||
* \param style Style used to draw.
|
|
||||||
* \param ctx Draw context to create.
|
* \param ctx Draw context to create.
|
||||||
* \return The simple window.
|
* \return The simple window.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -61,8 +61,7 @@ placement_fix_offscreen(area_t geometry, int screen, int border)
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Compute smart coordinates for a client window
|
/** Compute smart coordinates for a client window
|
||||||
* \param geometry current/requested client geometry
|
* \param c The client to place.
|
||||||
* \param screen screen used
|
|
||||||
* \return new geometry
|
* \return new geometry
|
||||||
*/
|
*/
|
||||||
area_t
|
area_t
|
||||||
|
|
2
screen.c
2
screen.c
|
@ -74,7 +74,7 @@ screen_area_get(int screen, statusbar_t *statusbar, padding_t *padding)
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Get display info.
|
/** Get display info.
|
||||||
* \param screen Physical screen number.
|
* \param phys_screen Physical screen number.
|
||||||
* \param statusbar The statusbars.
|
* \param statusbar The statusbars.
|
||||||
* \param padding Padding.
|
* \param padding Padding.
|
||||||
* \return The display area.
|
* \return The display area.
|
||||||
|
|
|
@ -53,8 +53,6 @@ statusbar_draw(statusbar_t *statusbar)
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Statusbar refresh function.
|
/** Statusbar refresh function.
|
||||||
* \param p A pointer to a statusbar_t.
|
|
||||||
* \return Return NULL.
|
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
statusbar_refresh(void)
|
statusbar_refresh(void)
|
||||||
|
|
5
widget.c
5
widget.c
|
@ -101,6 +101,7 @@ widget_common_button_press(widget_node_t *w,
|
||||||
/** Common tell function for widget, which only warn user that widget
|
/** Common tell function for widget, which only warn user that widget
|
||||||
* cannot be told anything.
|
* cannot be told anything.
|
||||||
* \param widget The widget.
|
* \param widget The widget.
|
||||||
|
* \param property Unused argument.
|
||||||
* \param new_value Unused argument.
|
* \param new_value Unused argument.
|
||||||
* \return The status of the command, which is always an error in this case.
|
* \return The status of the command, which is always an error in this case.
|
||||||
*/
|
*/
|
||||||
|
@ -116,7 +117,7 @@ widget_common_tell(widget_t *widget,
|
||||||
/** Render a list of widgets.
|
/** Render a list of widgets.
|
||||||
* \param wnode The list of widgets.
|
* \param wnode The list of widgets.
|
||||||
* \param ctx The draw context where to render.
|
* \param ctx The draw context where to render.
|
||||||
* \param rotate_dw The rotate pixmap: where to rotate and render the final
|
* \param rotate_px The rotate pixmap: where to rotate and render the final
|
||||||
* \param screen The logical screen used to render.
|
* \param screen The logical screen used to render.
|
||||||
* \param position The object position.
|
* \param position The object position.
|
||||||
* \param x The x coordinates of the object.
|
* \param x The x coordinates of the object.
|
||||||
|
@ -382,7 +383,7 @@ luaA_widget_mouse(lua_State *L)
|
||||||
/** Do what should be done with a widget_tell_status_t for a widget.
|
/** Do what should be done with a widget_tell_status_t for a widget.
|
||||||
* \param widget The widget.
|
* \param widget The widget.
|
||||||
* \param status The status returned by the tell function of the widget.
|
* \param status The status returned by the tell function of the widget.
|
||||||
* \para property The property updated.
|
* \param property The property updated.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
widget_tell_managestatus(widget_t *widget, widget_tell_status_t status, const char *property)
|
widget_tell_managestatus(widget_t *widget, widget_tell_status_t status, const char *property)
|
||||||
|
|
|
@ -74,7 +74,6 @@ tag_markup_parse(tag_t *t, const char *str, ssize_t len)
|
||||||
|
|
||||||
/** Check if at least one client is tagged with tag number t and is on screen
|
/** Check if at least one client is tagged with tag number t and is on screen
|
||||||
* screen
|
* screen
|
||||||
* \param screen screen number
|
|
||||||
* \param t tag
|
* \param t tag
|
||||||
* \return true or false
|
* \return true or false
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue