[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 <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
This commit is contained in:
Sakari Ailus 2015-12-16 11:32:20 -02:00 • committed by Mauro Carvalho Chehab
commit 434257f19c

View file

@ -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;