aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/include/media/media-entity.h
diff options
context:
space:
mode:
authorSakari Ailus <sakari.ailus@iki.fi>2015-12-16 11:32:20 -0200
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>2016-01-11 12:19:18 -0200
commit434257f19ce0a6b635a84882257034ae79d2f274 (patch)
tree07c97bc8b0a1e00501320ccf7dd8d2852498e0d9 /include/media/media-entity.h
parent[media] media: Move struct media_entity_graph definition up (diff)
downloadwireguard-linux-434257f19ce0a6b635a84882257034ae79d2f274.tar.xz
wireguard-linux-434257f19ce0a6b635a84882257034ae79d2f274.zip
[media] media: Add KernelDoc documentation for struct media_entity_graph
KernelDoc doesn't appear to handle anonymous structs defined inside another gracefully. As the struct is internal to the framework graph walk algorithm, detailed documentation isn't seen very important. Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Diffstat (limited to 'include/media/media-entity.h')
-rw-r--r--include/media/media-entity.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/include/media/media-entity.h b/include/media/media-entity.h
index e8ef40c809ad..edfb6163caa3 100644
--- a/include/media/media-entity.h
+++ b/include/media/media-entity.h
@@ -97,6 +97,15 @@ struct media_entity_enum {
int idx_max;
};
+/**
+ * struct media_entity_graph - Media graph traversal state
+ *
+ * @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.
+ * @entities: Visited entities
+ * @top: The top of the stack
+ */
struct media_entity_graph {
struct {
struct media_entity *entity;