X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Flibsigrok-internal.h;h=2ab6347ff5390796ee5a2a95601465d9cdf9fbbb;hb=effb9dd1c22dd10e1f276544bdadf4d3acf7dcc3;hp=092d7d534ec7ccc0b3ca3c6eeec542472fd5b00c;hpb=5bf0dd6aff6cc0ef1f18362faa0c6185a50996a4;p=libsigrok.git

diff --git a/src/libsigrok-internal.h b/src/libsigrok-internal.h
index 092d7d53..2ab6347f 100644
--- a/src/libsigrok-internal.h
+++ b/src/libsigrok-internal.h
@@ -263,8 +263,13 @@ struct sr_input_module {
 	 *
 	 * @param[in] metadata Metadata the module can use to identify the stream.
 	 *
-	 * @retval TRUE This module knows the format.
-	 * @retval FALSE This module does not know the format.
+	 * @retval SR_OK This module knows the format.
+	 * @retval SR_OK_CONTINUE There wasn't enough data for this module to
+	 *   positively identify the format.
+	 * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
+	 *   This means the stream is either corrupt, or indicates a feature
+	 *   that the module does not support.
+	 * @retval SR_ERR This module does not know the format.
 	 */
 	int (*format_match) (GHashTable *metadata);