From e4a0584f60d3dd1409d75ef73c1479b9cc371a07 Mon Sep 17 00:00:00 2001
From: Colin Cross <ccross@android.com>
Date: Tue, 28 May 2019 10:17:14 -0700
Subject: [PATCH] Document escaping

Document that strings can contain double quotes escaped as \", and
the droiddoc args argument can contain a dollar signe escaped as $$.

Test: none
Change-Id: I91d3fa73f484094c9ce8cbecc93189850856de84
---
 README.md        | 2 ++
 java/droiddoc.go | 1 +
 2 files changed, 3 insertions(+)

diff --git a/README.md b/README.md
index b0b61a8e9..f527355cf 100644
--- a/README.md
+++ b/README.md
@@ -81,6 +81,8 @@ types are:
 Maps may values of any type, including nested maps.  Lists and maps may have
 trailing commas after the last value.
 
+Strings can contain double quotes using `\"`, for example `"cat \"a b\""`.
+
 ### Operators
 
 Strings, lists of strings, and maps can be appended using the `+` operator.
diff --git a/java/droiddoc.go b/java/droiddoc.go
index fd7e2a48a..57da6b621 100644
--- a/java/droiddoc.go
+++ b/java/droiddoc.go
@@ -211,6 +211,7 @@ type JavadocProperties struct {
 	// Available variables for substitution:
 	//
 	//  $(location <label>): the path to the arg_files with name <label>
+	//  $$: a literal $
 	Args *string
 
 	// names of the output files used in args that will be generated