media: media-entity.h: add kernel-doc markups for nested structs
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 27 Sep 2017 19:54:43 +0000 (15:54 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 18 Dec 2017 15:22:40 +0000 (10:22 -0500)
Now that nested structs are parsed by kernel-doc, add markups
to them.

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
include/media/media-entity.h

index 222d379..d7a6690 100644 (file)
@@ -88,6 +88,8 @@ struct media_entity_enum {
  * @stack:             Graph traversal stack; the stack contains information
  *                     on the path the media entities to be walked and the
  *                     links through which they were reached.
+ * @stack.entity:      pointer to &struct media_entity at the graph.
+ * @stack.link:                pointer to &struct list_head.
  * @ent_enum:          Visited entities
  * @top:               The top of the stack
  */
@@ -247,6 +249,9 @@ enum media_entity_type {
  * @pipe:      Pipeline this entity belongs to.
  * @info:      Union with devnode information.  Kept just for backward
  *             compatibility.
+ * @info.dev:  Contains device major and minor info.
+ * @info.dev.major: device node major, if the device is a devnode.
+ * @info.dev.minor: device node minor, if the device is a devnode.
  * @major:     Devnode major number (zero if not applicable). Kept just
  *             for backward compatibility.
  * @minor:     Devnode minor number (zero if not applicable). Kept just