Skip to content

Commit 26d1fb1

Browse files
committed
clarifications for readSettings()
1 parent a5d0afe commit 26d1fb1

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

app/src/processing/app/Util.java

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,15 @@ static public StringDict readSettings(File inputFile, boolean allowHex) {
9494
* by = (the equals sign). The # (hash) symbol is used to denote comments.
9595
* As of 4.0.2, set allowHex to true if hex colors are used in the file.
9696
* This will disable support for comments that begin later in the line.
97-
* If allowHex is false, then comments can appear later on a line, which is
98-
* necessary for the contribution .properties files. Blank lines are ignored.
97+
* Blank lines are always ignored.
98+
*
99+
* @param filename Name of the input file; only used for error messages.
100+
* @param lines Lines already parsed from the input file.
101+
* @param allowHex If false, # indicates comment to the end of line,
102+
* which is necessary for the .properties files
103+
* used by Contributions. If true, # is unharmed,
104+
* allowing for hex characters and colors (used by
105+
* themes and preferences).
99106
*/
100107
static public StringDict readSettings(String filename, String[] lines, boolean allowHex) {
101108
StringDict settings = new StringDict();

0 commit comments

Comments
 (0)