summary refs log tree commit diff stats
path: root/include/qapi/string-output-visitor.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/qapi/string-output-visitor.h')
-rw-r--r--include/qapi/string-output-visitor.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/qapi/string-output-visitor.h b/include/qapi/string-output-visitor.h
index d99717f650..e10522a35b 100644
--- a/include/qapi/string-output-visitor.h
+++ b/include/qapi/string-output-visitor.h
@@ -17,6 +17,11 @@
 
 typedef struct StringOutputVisitor StringOutputVisitor;
 
+/*
+ * The string output visitor does not implement support for visiting
+ * QAPI structs, alternates, null, or arbitrary QTypes.  It also
+ * requires a non-null list argument to visit_start_list().
+ */
 StringOutputVisitor *string_output_visitor_new(bool human);
 void string_output_visitor_cleanup(StringOutputVisitor *v);