Commit 08d0039d authored by Lubosz Sarnecki's avatar Lubosz Sarnecki

src: Fix warnings in documentation comments.

parent cd1bd096
......@@ -215,6 +215,7 @@ xrd_client_add_window (XrdClient *self,
* @self: The #XrdClient
* @width: Width in meters.
* @height: Height in meters.
* @ppm: Density in pixels per meter
* @label_count: The number of text lines given in @label
* @label: One or more lines of text that will be displayed on the button.
*
......@@ -2182,9 +2183,9 @@ _save_window_states (XrdClient *self,
}
}
/** xrd_client_switch_mode:
/**
* xrd_client_switch_mode:
* @self: current #XrdClient to be destroyed.
* Returns: A new #XrdClient of the opposite mode than the passed one.
*
* References to gulkan, openvr-glib and xrdesktop objects (like #XrdWindow)
* will be invalid after calling this function.
......@@ -2197,6 +2198,8 @@ _save_window_states (XrdClient *self,
* The caller is responsible to not use references to any previous #XrdWindow.
* The caller may use xrd_client_get_windows() to get the list of new windows
* and may use the "native" property to recognize each window.
*
* Returns: A new #XrdClient of the opposite mode than the passed one.
*/
struct _XrdClient *
xrd_client_switch_mode (XrdClient *self)
......
......@@ -489,7 +489,11 @@ _step_hand (XrdContainer *self)
/**
* xrd_container_step:
* @self: The #XrdContainer
*
* Updates the container's position based on its attachment.
*
* Returns: A #gboolean if that is %TRUE the step was successful.
*/
gboolean
xrd_container_step (XrdContainer *self)
......
......@@ -406,7 +406,7 @@ xrd_input_synth_synthing_controller (XrdInputSynth *self)
/**
* xrd_input_synth_hand_off_to_controller:
* @self: The #XrdInputSynth
* @controller_index: The index of the controller that will be used for input
* @controller_handle: The index of the controller that will be used for input
* synth.
*/
void
......
......@@ -273,7 +273,6 @@ xrd_window_get_initial_ppm (XrdWindow *self)
/**
* xrd_window_get_current_width_meters:
* @self: The #XrdWindow
* @meters: The current width of the #XrdWindow in meters.
*
* Returns: The current world space width of the window in meters.
*/
......@@ -294,9 +293,8 @@ xrd_window_get_current_width_meters (XrdWindow *self)
/**
* xrd_window_get_current_height_meters:
* @self: The #XrdWindow
* @meters: The current height of the #XrdWindow in meter.
*
* Returns: The current world space height of the window in meter.
* Returns: The current world space height of the window in meters.
*/
float
xrd_window_get_current_height_meters (XrdWindow *self)
......@@ -355,7 +353,7 @@ xrd_window_intersects (XrdWindow *self,
/**
* xrd_window_get_intersection_2d_pixels:
* @self: The #XrdWindow
* @intersection_point: A #graphene_point3d_t intersection point in meters.
* @intersection_3d: A #graphene_point3d_t intersection point in meters.
* @intersection_pixels: Intersection in window coordinates with the origin at top/left in pixels.
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment