tests: qemu: Document qemuMonitorTestNewFromFile

diff --git a/tests/qemumonitortestutils.c b/tests/qemumonitortestutils.c
index f8f23c3d72ff990006e1d5fa6b664641fcafe2c7..3722b072982a58a02c9bdc05a94aa3848743e49e 100644 (file)
--- a/tests/qemumonitortestutils.c
+++ b/tests/qemumonitortestutils.c
@@ -1037,6 +1037,19 @@ qemuMonitorTestNew(bool json,
 }
 
 
+/**
+ * qemuMonitorTestNewFromFile:
+ * @fileName: File name to load monitor replies from
+ * @xmlopt: XML parser configuration object
+ * @simple: see below
+ *
+ * Create a JSON test monitor simulator object and fill it with replies
+ * specified in @fileName. The file contains JSON reply objects separated by
+ * empty lines. If @simple is true a generic QMP greeting is automatically
+ * added as the first reply, otherwise the first entry in the file is used.
+ *
+ * Returns the monitor object on success; NULL on error.
+ */
 qemuMonitorTestPtr
 qemuMonitorTestNewFromFile(const char *fileName,
                            virDomainXMLOptionPtr xmlopt,