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
905905
906906 /**
907907 * struct drm_mode_create_blob - Create New block property
908− * @data: Pointer to data to copy.
909− * @length: Length of data to copy.
910− * @blob_id: new property ID.
908+ *
911909 * Create a new 'blob' data property, copying length bytes from data pointer,
912910 * and returning new blob ID.
913911 */
914912 struct drm_mode_create_blob {
915− /** Pointer to data to copy. */
913+ /** @data: Pointer to data to copy. */
916914 __u64 data;
917− /** Length of data to copy. */
915+ /** @length: Length of data to copy. */
918916 __u32 length;
919− /** Return: new property ID. */
917+ /** @blob_id: Return: new property ID. */
920918 __u32 blob_id;
921919 };
922920
923921 /**
924922 * struct drm_mode_destroy_blob - Destroy user blob
925923 * @blob_id: blob_id to destroy
924+ *
926925 * Destroy a user-created blob property.
927926 *
928927 * 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
937936
938937 /**
939938 * struct drm_mode_create_lease - Create lease
940− * @object_ids: Pointer to array of object ids.
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.
939+ *
945940 * Lease mode resources, creating another drm_master.
946941 */
947942 struct drm_mode_create_lease {
948− /** Pointer to array of object ids (__u32) */
943+ /** @object_ids: Pointer to array of object ids (__u32) */
949944 __u64 object_ids;
950− /** Number of object ids */
945+ /** @object_count: Number of object ids */
951946 __u32 object_count;
952− /** flags for new FD (O_CLOEXEC, etc) */
947+ /** @flags: flags for new FD (O_CLOEXEC, etc) */
953948 __u32 flags;
954949
955− /** Return: unique identifier for lessee. */
950+ /** @lessee_id: Return: unique identifier for lessee. */
956951 __u32 lessee_id;
957− /** Return: file descriptor to new drm_master file */
952+ /** @fd: Return: file descriptor to new drm_master file */
958953 __u32 fd;
959954 };
960955
961956 /**
962957 * struct drm_mode_list_lessees - List lessees
963− * @count_lessees: Number of lessees.
964− * @pad: pad.
965− * @lessees_ptr: Pointer to lessess.
966− * List lesses from a drm_master
958+ *
959+ * List lesses from a drm_master.
967960 */
968961 struct drm_mode_list_lessees {
969− /** Number of lessees.
962+ /**
963+ * @count_lessees: Number of lessees.
964+ *
970965 * On input, provides length of the array.
971966 * On output, provides total number. No
972967 * more than the input number will be written
@@ -974,23 +969,26 @@ struct drm_mode_list_lessees { · 1 unmodified line
974969 * the size and then the data.
975970 */
976971 __u32 count_lessees;
972+ /** @pad: Padding. */
977973 __u32 pad;
978974
979− /** Pointer to lessees.
980− * pointer to __u64 array of lessee ids
975+ /**
976+ * @lessees_ptr: Pointer to lessees.
977+ *
978+ * Pointer to __u64 array of lessee ids
981979 */
982980 __u64 lessees_ptr;
983981 };
984982
985983 /**
986984 * struct drm_mode_get_lease - Get Lease
987− * @count_objects: Number of leased objects.
988− * @pad: pad.
989− * @objects_ptr: Pointer to objects.
990− * Get leased objects
985+ *
986+ * Get leased objects.
991987 */
992988 struct drm_mode_get_lease {
993− /** Number of leased objects.
989+ /**
990+ * @count_objects: Number of leased objects.
991+ *
994992 * On input, provides length of the array.
995993 * On output, provides total number. No
996994 * more than the input number will be written
@@ -998,22 +996,22 @@ struct drm_mode_get_lease { · 1 unmodified line
998996 * the size and then the data.
999997 */
1000998 __u32 count_objects;
999+ /** @pad: Padding. */
10011000 __u32 pad;
10021001
1003− /** Pointer to objects.
1004− * pointer to __u32 array of object ids
1002+ /**
1003+ * @objects_ptr: Pointer to objects.
1004+ *
1005+ * Pointer to __u32 array of object ids.
10051006 */
10061007 __u64 objects_ptr;
10071008 };
10081009
10091010 /**
10101011 * struct drm_mode_revoke_lease - Revoke lease
1011− * @lessee_id: Unique ID of lessee.
1012− * Revoke lease
10131012 */
10141013 struct drm_mode_revoke_lease {
1015− /** Unique ID of lessee
1016− */
1014+ /** @lessee_id: Unique ID of lessee */
10171015 __u32 lessee_id;
10181016 };
10191017

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