History

drm: improve kernel-docs in drm_mode.h

- Remove duplicate doc-comments for struct members - Add missing @member markers for in-line member comments

Simon Ser committed 5 years ago

Commit 52aa3001 parent 3e3e59e1 file · +32 −34Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/drm/drm_mode.h+32−34
@@ -905,24 +905,23 @@ struct drm_format_modifier { · 904 unmodified lines
905 905
906/**906/**
907 * struct drm_mode_create_blob - Create New block property907 * struct drm_mode_create_blob - Create New block property
908 * @data: Pointer to data to copy.908 *
909 * @length: Length of data to copy.
910 * @blob_id: new property ID.
911 * Create a new 'blob' data property, copying length bytes from data pointer,909 * Create a new 'blob' data property, copying length bytes from data pointer,
912 * and returning new blob ID.910 * and returning new blob ID.
913 */911 */
914struct drm_mode_create_blob {912struct drm_mode_create_blob {
915 /** Pointer to data to copy. */913 /** @data: Pointer to data to copy. */
916 __u64 data;914 __u64 data;
917 /** Length of data to copy. */915 /** @length: Length of data to copy. */
918 __u32 length;916 __u32 length;
919 /** Return: new property ID. */917 /** @blob_id: Return: new property ID. */
920 __u32 blob_id;918 __u32 blob_id;
921};919};
922 920
923/**921/**
924 * struct drm_mode_destroy_blob - Destroy user blob922 * struct drm_mode_destroy_blob - Destroy user blob
925 * @blob_id: blob_id to destroy923 * @blob_id: blob_id to destroy
924 *
926 * Destroy a user-created blob property.925 * Destroy a user-created blob property.
927 *926 *
928 * User-space can release blobs as soon as they do not need to refer to them by927 * User-space can release blobs as soon as they do not need to refer to them by
@@ -937,36 +936,32 @@ struct drm_mode_destroy_blob { · 8 unmodified lines
937 936
938/**937/**
939 * struct drm_mode_create_lease - Create lease938 * struct drm_mode_create_lease - Create lease
940 * @object_ids: Pointer to array of object ids.939 *
941 * @object_count: Number of object ids.
942 * @flags: flags for new FD.
943 * @lessee_id: unique identifier for lessee.
944 * @fd: file descriptor to new drm_master file.
945 * Lease mode resources, creating another drm_master.940 * Lease mode resources, creating another drm_master.
946 */941 */
947struct drm_mode_create_lease {942struct drm_mode_create_lease {
948 /** Pointer to array of object ids (__u32) */943 /** @object_ids: Pointer to array of object ids (__u32) */
949 __u64 object_ids;944 __u64 object_ids;
950 /** Number of object ids */945 /** @object_count: Number of object ids */
951 __u32 object_count;946 __u32 object_count;
952 /** flags for new FD (O_CLOEXEC, etc) */947 /** @flags: flags for new FD (O_CLOEXEC, etc) */
953 __u32 flags;948 __u32 flags;
954 949
955 /** Return: unique identifier for lessee. */950 /** @lessee_id: Return: unique identifier for lessee. */
956 __u32 lessee_id;951 __u32 lessee_id;
957 /** Return: file descriptor to new drm_master file */952 /** @fd: Return: file descriptor to new drm_master file */
958 __u32 fd;953 __u32 fd;
959};954};
960 955
961/**956/**
962 * struct drm_mode_list_lessees - List lessees957 * struct drm_mode_list_lessees - List lessees
963 * @count_lessees: Number of lessees.958 *
964 * @pad: pad.959 * List lesses from a drm_master.
965 * @lessees_ptr: Pointer to lessess.
966 * List lesses from a drm_master
967 */960 */
968struct drm_mode_list_lessees {961struct drm_mode_list_lessees {
969 /** Number of lessees.962 /**
963 * @count_lessees: Number of lessees.
964 *
970 * On input, provides length of the array.965 * On input, provides length of the array.
971 * On output, provides total number. No966 * On output, provides total number. No
972 * more than the input number will be written967 * more than the input number will be written
@@ -974,23 +969,26 @@ struct drm_mode_list_lessees { · 1 unmodified line
974 * the size and then the data.969 * the size and then the data.
975 */970 */
976 __u32 count_lessees;971 __u32 count_lessees;
972 /** @pad: Padding. */
977 __u32 pad;973 __u32 pad;
978 974
979 /** Pointer to lessees.975 /**
980 * pointer to __u64 array of lessee ids976 * @lessees_ptr: Pointer to lessees.
977 *
978 * Pointer to __u64 array of lessee ids
981 */979 */
982 __u64 lessees_ptr;980 __u64 lessees_ptr;
983};981};
984 982
985/**983/**
986 * struct drm_mode_get_lease - Get Lease984 * struct drm_mode_get_lease - Get Lease
987 * @count_objects: Number of leased objects.985 *
988 * @pad: pad.986 * Get leased objects.
989 * @objects_ptr: Pointer to objects.
990 * Get leased objects
991 */987 */
992struct drm_mode_get_lease {988struct drm_mode_get_lease {
993 /** Number of leased objects.989 /**
990 * @count_objects: Number of leased objects.
991 *
994 * On input, provides length of the array.992 * On input, provides length of the array.
995 * On output, provides total number. No993 * On output, provides total number. No
996 * more than the input number will be written994 * more than the input number will be written
@@ -998,22 +996,22 @@ struct drm_mode_get_lease { · 1 unmodified line
998 * the size and then the data.996 * the size and then the data.
999 */997 */
1000 __u32 count_objects;998 __u32 count_objects;
999 /** @pad: Padding. */
1001 __u32 pad;1000 __u32 pad;
1002 1001
1003 /** Pointer to objects.1002 /**
1004 * pointer to __u32 array of object ids1003 * @objects_ptr: Pointer to objects.
1004 *
1005 * Pointer to __u32 array of object ids.
1005 */1006 */
1006 __u64 objects_ptr;1007 __u64 objects_ptr;
1007};1008};
1008 1009
1009/**1010/**
1010 * struct drm_mode_revoke_lease - Revoke lease1011 * struct drm_mode_revoke_lease - Revoke lease
1011 * @lessee_id: Unique ID of lessee.
1012 * Revoke lease
1013 */1012 */
1014struct drm_mode_revoke_lease {1013struct drm_mode_revoke_lease {
1015 /** Unique ID of lessee1014 /** @lessee_id: Unique ID of lessee */
1016 */
1017 __u32 lessee_id;1015 __u32 lessee_id;
1018};1016};
1019 1017

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t