sprinter: clarify separator documentation

[notmuch] / sprinter.h

diff --git a/sprinter.h b/sprinter.h
index 912a5262a56756add44b41843ad32bb18446ad75..f43a8443f2352b3583e2f976b501907164373724 100644 (file)
--- a/sprinter.h
+++ b/sprinter.h
@@ -42,10 +42,11 @@ typedef struct sprinter {
      */
     void (*map_key) (struct sprinter *, const char *);
 
-    /* Insert a separator (usually extra whitespace) for improved
-     * readability without affecting the abstract syntax of the
-     * structure being printed.
-     * For JSON, this could simply be a line break.
+    /* Insert a separator (usually extra whitespace). For the text
+     * printers, this is a syntactic separator. For the structured
+     * printers, this is for improved readability without affecting
+     * the abstract syntax of the structure being printed. For JSON,
+     * this could simply be a line break.
      */
     void (*separator) (struct sprinter *);
 
@@ -70,4 +71,8 @@ sprinter_text_create (const void *ctx, FILE *stream);
 struct sprinter *
 sprinter_json_create (const void *ctx, FILE *stream);
 
+/* Create a new structure printer that emits S-Expressions. */
+struct sprinter *
+sprinter_sexp_create (const void *ctx, FILE *stream);
+
 #endif // NOTMUCH_SPRINTER_H