Issue #10: Improve documentation

pocmo · Oct 1, 2020 · 4cae10a · 4cae10a
1 parent 8674b94
commit 4cae10a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/recompose-ast/src/main/kotlin/recompose/ast/view/EditTextNode.kt b/recompose-ast/src/main/kotlin/recompose/ast/view/EditTextNode.kt
@@ -21,6 +21,11 @@ import recompose.ast.attributes.ViewAttributes
 import recompose.ast.values.InputType
 import recompose.visitor.Visitor
 
+/**
+ * Data class holding the attributes of a parsed `<EditText>`.
+ *
+ * https://developer.android.com/reference/android/widget/EditText
+ */
 data class EditTextNode(
     override val view: ViewAttributes,
     val text: String,

diff --git a/recompose-parser/src/main/kotlin/recompose/parser/values/InputType.kt b/recompose-parser/src/main/kotlin/recompose/parser/values/InputType.kt
@@ -21,7 +21,7 @@ import recompose.ast.values.InputType
 import recompose.parser.Parser
 
 /**
- * Parses an orientation attribute (from `android:inputType`) and returns the matching [InputType]
+ * Parses an inputType attribute (from `android:inputType`) and returns the matching [InputType]
  * object. Throws [Parser.ParserException] if the inputType could not be parsed.
  */
 internal fun XmlPullParser.inputType(): InputType {