mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-27 20:23:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

gudev: add missing (nullable) annotations on return values

Browse Source
This commit is contained in:
Evan Nemerson 2014-05-18 00:25:06 -07:00 committed by Kay Sievers
parent 5c868fe2e9
commit 2be6107255
2 changed files with 34 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/gudev/gudevclient.c
View File

@ -338,7 +338,10 @@ g_udev_client_new (const gchar * const *subsystems)
* *
* Gets all devices belonging to @subsystem. * Gets all devices belonging to @subsystem.
* *
* Returns: (element-type GUdevDevice) (transfer full): A list of #GUdevDevice objects. The caller should free the result by using g_object_unref() on each element in the list and then g_list_free() on the list. * Returns: (nullable) (element-type GUdevDevice) (transfer full): A
* list of #GUdevDevice objects. The caller should free the result by
* using g_object_unref() on each element in the list and then
* g_list_free() on the list.
*/ */
GList * GList *
g_udev_client_query_by_subsystem (GUdevClient *client, g_udev_client_query_by_subsystem (GUdevClient *client,
@ -391,7 +394,8 @@ g_udev_client_query_by_subsystem (GUdevClient *client,
* *
* Looks up a device for a type and device number. * Looks up a device for a type and device number.
* *
* Returns: (transfer full): A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref(). * Returns: (nullable) (transfer full): A #GUdevDevice object or %NULL
* if the device was not found. Free with g_object_unref().
*/ */
GUdevDevice * GUdevDevice *
g_udev_client_query_by_device_number (GUdevClient *client, g_udev_client_query_by_device_number (GUdevClient *client,
@ -423,7 +427,8 @@ g_udev_client_query_by_device_number (GUdevClient *client,
* *
* Looks up a device for a device file. * Looks up a device for a device file.
* *
* Returns: (transfer full): A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref(). * Returns: (nullable) (transfer full): A #GUdevDevice object or %NULL
* if the device was not found. Free with g_object_unref().
*/ */
GUdevDevice * GUdevDevice *
g_udev_client_query_by_device_file (GUdevClient *client, g_udev_client_query_by_device_file (GUdevClient *client,
@ -459,7 +464,8 @@ g_udev_client_query_by_device_file (GUdevClient *client,
* *
* Looks up a device for a sysfs path. * Looks up a device for a sysfs path.
* *
* Returns: (transfer full): A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref(). * Returns: (nullable) (transfer full): A #GUdevDevice object or %NULL
* if the device was not found. Free with g_object_unref().
*/ */
GUdevDevice * GUdevDevice *
g_udev_client_query_by_sysfs_path (GUdevClient *client, g_udev_client_query_by_sysfs_path (GUdevClient *client,
@ -491,7 +497,8 @@ g_udev_client_query_by_sysfs_path (GUdevClient *client,
* *
* Looks up a device for a subsystem and name. * Looks up a device for a subsystem and name.
* *
* Returns: (transfer full): A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref(). * Returns: (nullable) (transfer full): A #GUdevDevice object or %NULL
* if the device was not found. Free with g_object_unref().
*/ */
GUdevDevice * GUdevDevice *
g_udev_client_query_by_subsystem_and_name (GUdevClient *client, g_udev_client_query_by_subsystem_and_name (GUdevClient *client,

32
src/gudev/gudevdevice.c
View File

@ -228,7 +228,8 @@ g_udev_device_get_sysfs_path (GUdevDevice *device)
* *
* Gets the name of the driver used for @device. * Gets the name of the driver used for @device.
* *
* Returns: The name of the driver for @device or %NULL if unknown. * Returns: (nullable): The name of the driver for @device or %NULL if
* unknown.
*/ */
const gchar * const gchar *
g_udev_device_get_driver (GUdevDevice *device) g_udev_device_get_driver (GUdevDevice *device)
@ -325,8 +326,8 @@ g_udev_device_get_device_number (GUdevDevice *device)
* *
* Gets the device file for @device. * Gets the device file for @device.
* *
* Returns: The device file for @device or %NULL if no device file * Returns: (nullable): The device file for @device or %NULL if no
* exists. * device file exists.
*/ */
const gchar * const gchar *
g_udev_device_get_device_file (GUdevDevice *device) g_udev_device_get_device_file (GUdevDevice *device)
@ -375,7 +376,8 @@ g_udev_device_get_device_file_symlinks (GUdevDevice *device)
* *
* Gets the immediate parent of @device, if any. * Gets the immediate parent of @device, if any.
* *
* Returns: (transfer full): A #GUdevDevice or %NULL if @device has no parent. Free with g_object_unref(). * Returns: (nullable) (transfer full): A #GUdevDevice or %NULL if
* @device has no parent. Free with g_object_unref().
*/ */
GUdevDevice * GUdevDevice *
g_udev_device_get_parent (GUdevDevice *device) g_udev_device_get_parent (GUdevDevice *device)
@ -406,7 +408,9 @@ g_udev_device_get_parent (GUdevDevice *device)
* Walks up the chain of parents of @device and returns the first * Walks up the chain of parents of @device and returns the first
* device encountered where @subsystem and @devtype matches, if any. * device encountered where @subsystem and @devtype matches, if any.
* *
* Returns: (transfer full): A #GUdevDevice or %NULL if @device has no parent with @subsystem and @devtype. Free with g_object_unref(). * Returns: (nullable) (transfer full): A #GUdevDevice or %NULL if
* @device has no parent with @subsystem and @devtype. Free with
* g_object_unref().
*/ */
GUdevDevice * GUdevDevice *
g_udev_device_get_parent_with_subsystem (GUdevDevice *device, g_udev_device_get_parent_with_subsystem (GUdevDevice *device,
@ -492,7 +496,8 @@ g_udev_device_has_property (GUdevDevice *device,
* *
* Look up the value for @key on @device. * Look up the value for @key on @device.
* *
* Returns: The value for @key or %NULL if @key doesn't exist on @device. Do not free this string, it is owned by @device. * Returns: (nullable): The value for @key or %NULL if @key doesn't
* exist on @device. Do not free this string, it is owned by @device.
*/ */
const gchar * const gchar *
g_udev_device_get_property (GUdevDevice *device, g_udev_device_get_property (GUdevDevice *device,
@ -664,7 +669,10 @@ split_at_whitespace (const gchar *s)
* horizontal tab ('\t'), and vertical tab ('\v') are considered; the * horizontal tab ('\t'), and vertical tab ('\v') are considered; the
* locale is not taken into account). * locale is not taken into account).
* *
* Returns: (transfer none) (array zero-terminated=1) (element-type utf8): The value of @key on @device split into tokens or %NULL if @key doesn't exist. This array is owned by @device and should not be freed by the caller. * Returns: (nullable) (transfer none) (array zero-terminated=1) (element-type utf8):
* The value of @key on @device split into tokens or %NULL if @key
* doesn't exist. This array is owned by @device and should not be
* freed by the caller.
*/ */
const gchar* const * const gchar* const *
g_udev_device_get_property_as_strv (GUdevDevice *device, g_udev_device_get_property_as_strv (GUdevDevice *device,
@ -758,8 +766,9 @@ g_udev_device_has_sysfs_attr (GUdevDevice *device,
* *
* Look up the sysfs attribute with @name on @device. * Look up the sysfs attribute with @name on @device.
* *
* Returns: The value of the sysfs attribute or %NULL if there is no * Returns: (nullable): The value of the sysfs attribute or %NULL if
* such attribute. Do not free this string, it is owned by @device. * there is no such attribute. Do not free this string, it is owned by
* @device.
*/ */
const gchar * const gchar *
g_udev_device_get_sysfs_attr (GUdevDevice *device, g_udev_device_get_sysfs_attr (GUdevDevice *device,
@ -907,7 +916,10 @@ g_udev_device_get_sysfs_attr_as_boolean (GUdevDevice *device,
* tab ('\t'), and vertical tab ('\v') are considered; the locale is * tab ('\t'), and vertical tab ('\v') are considered; the locale is
* not taken into account). * not taken into account).
* *
* Returns: (transfer none) (array zero-terminated=1) (element-type utf8): The value of the sysfs attribute split into tokens or %NULL if there is no such attribute. This array is owned by @device and should not be freed by the caller. * Returns: (nullable) (transfer none) (array zero-terminated=1) (element-type utf8):
* The value of the sysfs attribute split into tokens or %NULL if
* there is no such attribute. This array is owned by @device and
* should not be freed by the caller.
*/ */
const gchar * const * const gchar * const *
g_udev_device_get_sysfs_attr_as_strv (GUdevDevice *device, g_udev_device_get_sysfs_attr_as_strv (GUdevDevice *device,