[xscreen] Add some documentation
Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
parent
ffdb9727b7
commit
e710cff383
|
@ -25,11 +25,11 @@
|
||||||
|
|
||||||
#include "common/xscreen.h"
|
#include "common/xscreen.h"
|
||||||
|
|
||||||
/** Return the Xinerama screen number where the coordinates belongs to
|
/** Return the Xinerama screen number where the coordinates belongs to.
|
||||||
* \param disp Display ref
|
* \param si The screens infos structure.
|
||||||
* \param x x coordinate of the window
|
* \param x X coordinate
|
||||||
* \param y y coordinate of the window
|
* \param y Y coordinate
|
||||||
* \return screen number or DefaultScreen of disp on no match
|
* \return Screen number or screen param if no match or no multi-head.
|
||||||
*/
|
*/
|
||||||
int
|
int
|
||||||
screen_get_bycoord(screens_info_t *si, int screen, int x, int y)
|
screen_get_bycoord(screens_info_t *si, int screen, int x, int y)
|
||||||
|
@ -69,6 +69,10 @@ screensinfo_delete(screens_info_t **si)
|
||||||
p_delete(si);
|
p_delete(si);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Get screens informations.
|
||||||
|
* \param conn X connection.
|
||||||
|
* \return A pointer to complete screens_info_t structure.
|
||||||
|
*/
|
||||||
screens_info_t *
|
screens_info_t *
|
||||||
screensinfo_new(xcb_connection_t *conn)
|
screensinfo_new(xcb_connection_t *conn)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in New Issue