qobject-input-visitor: Document full_name_nth()

Backports commit 6c02258e143700314ebf268dae47eb23db17d1cf from qemu
This commit is contained in:
Markus Armbruster 2018-03-03 17:39:08 -05:00 committed by Lioncash
parent 0d433af617
commit d70f3bfc6b
No known key found for this signature in database
GPG key ID: 4E3C3CC1031BA9C7

View file

@ -50,6 +50,17 @@ static QObjectInputVisitor *to_qiv(Visitor *v)
return container_of(v, QObjectInputVisitor, visitor);
}
/*
* Find the full name of something @qiv is currently visiting.
* @qiv is visiting something named @name in the stack of containers
* @qiv->stack.
* If @n is zero, return its full name.
* If @n is positive, return the full name of the @n-th container
* counting from the top. The stack of containers must have at least
* @n elements.
* The returned string is valid until the next full_name_nth(@v) or
* destruction of @v.
*/
static const char *full_name_nth(QObjectInputVisitor *qiv, const char *name,
int n)
{