[media] media-entity.h: document the remaining functions
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Wed, 16 Dec 2015 17:15:18 +0000 (15:15 -0200)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Mon, 11 Jan 2016 14:19:24 +0000 (12:19 -0200)
There are two ancillary functions that are missing comments.

While those are used only internally at media-entity.c,
document them, for completeness.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
include/media/media-entity.h

index 54be1496d542d7a617ebea874578ffda55a5124c..79dd81fd463e80d28fafb63c81ec29aafe35ca4e 100644 (file)
@@ -301,11 +301,22 @@ static inline enum media_gobj_type media_type(struct media_gobj *gobj)
        return gobj->id >> MEDIA_BITS_PER_ID;
 }
 
+/**
+ * media_id() - return the media object ID
+ *
+ * @gobj:      pointer to the media graph object
+ */
 static inline u32 media_id(struct media_gobj *gobj)
 {
        return gobj->id & MEDIA_ID_MASK;
 }
 
+/**
+ * media_gobj_gen_id() - encapsulates type and ID on at the object ID
+ *
+ * @type:      object type as define at enum &media_gobj_type.
+ * @local_id:  next ID, from struct &media_device.@id.
+ */
 static inline u32 media_gobj_gen_id(enum media_gobj_type type, u64 local_id)
 {
        u32 id;