Browse Source

media: media-entity.h: add kernel-doc markups for nested structs

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>
Mauro Carvalho Chehab 7 years ago
parent
commit
bd945e4799
1 changed files with 5 additions and 0 deletions
  1. 5 0
      include/media/media-entity.h

+ 5 - 0
include/media/media-entity.h

@@ -88,6 +88,8 @@ struct media_entity_enum {
  * @stack:		Graph traversal stack; the stack contains information
  * @stack:		Graph traversal stack; the stack contains information
  *			on the path the media entities to be walked and the
  *			on the path the media entities to be walked and the
  *			links through which they were reached.
  *			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
  * @ent_enum:		Visited entities
  * @top:		The top of the stack
  * @top:		The top of the stack
  */
  */
@@ -247,6 +249,9 @@ enum media_entity_type {
  * @pipe:	Pipeline this entity belongs to.
  * @pipe:	Pipeline this entity belongs to.
  * @info:	Union with devnode information.  Kept just for backward
  * @info:	Union with devnode information.  Kept just for backward
  *		compatibility.
  *		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
  * @major:	Devnode major number (zero if not applicable). Kept just
  *		for backward compatibility.
  *		for backward compatibility.
  * @minor:	Devnode minor number (zero if not applicable). Kept just
  * @minor:	Devnode minor number (zero if not applicable). Kept just