aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/anarres/cpp/StringLexerSource.java
diff options
context:
space:
mode:
authorShevek <[email protected]>2015-05-13 12:31:06 -0700
committerShevek <[email protected]>2015-05-13 12:31:06 -0700
commit64f955703ce6cabbc26e5806b91a28e67591446e (patch)
tree065b414ebc17d572ba088817ae3cccdc64080f8a /src/main/java/org/anarres/cpp/StringLexerSource.java
parent1bb60e9a9bc4f2f38958ca42e98134aa6dc13470 (diff)
Fix two javadoc @param warnings.
Diffstat (limited to 'src/main/java/org/anarres/cpp/StringLexerSource.java')
-rw-r--r--src/main/java/org/anarres/cpp/StringLexerSource.java5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/main/java/org/anarres/cpp/StringLexerSource.java b/src/main/java/org/anarres/cpp/StringLexerSource.java
index 8640bc8..853cc3a 100644
--- a/src/main/java/org/anarres/cpp/StringLexerSource.java
+++ b/src/main/java/org/anarres/cpp/StringLexerSource.java
@@ -29,6 +29,7 @@ public class StringLexerSource extends LexerSource {
/**
* Creates a new Source for lexing the given String.
*
+ * @param string The input string to lex.
* @param ppvalid true if preprocessor directives are to be
* honoured within the string.
*/
@@ -39,8 +40,12 @@ public class StringLexerSource extends LexerSource {
/**
* Creates a new Source for lexing the given String.
*
+ * Equivalent to calling <code>new StringLexerSource(string, false)</code>.
+ *
* By default, preprocessor directives are not honoured within
* the string.
+ *
+ * @param string The input string to lex.
*/
public StringLexerSource(String string) {
this(string, false);