aboutsummaryrefslogtreecommitdiffhomepage
path: root/sprinter.h
diff options
context:
space:
mode:
authorGravatar Jani Nikula <jani@nikula.org>2012-12-17 00:05:09 +0200
committerGravatar David Bremner <bremner@debian.org>2012-12-18 17:03:24 -0400
commit1358f93a9f9c827f43ad174dc7bbf27b90d2ef8a (patch)
tree0a932777d0bc9a0c6d11618ee6630bc2cd46d4b2 /sprinter.h
parent480f44fbe47a068626dbb7c7d9e9b1fb72a5da0f (diff)
sprinter: clarify separator documentation
For text printers, the separator is a syntactic element.
Diffstat (limited to 'sprinter.h')
-rw-r--r--sprinter.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/sprinter.h b/sprinter.h
index 59776a9c..f43a8443 100644
--- 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 *);