Java: add missing QLDoc for GWT.qll, GwtUiBinder.qll, GwtXml.qll

yo-h · yo-h · commit 45b502a82ff1 · 2020-05-11T20:01:45.000-04:00
diff --git a/java/ql/src/semmle/code/java/frameworks/gwt/GWT.qll b/java/ql/src/semmle/code/java/frameworks/gwt/GWT.qll
@@ -1,3 +1,5 @@
+/** Provides classes and predicates for working with the GWT framework. */
+
 import java
 import GwtXml
 import GwtUiBinder
diff --git a/java/ql/src/semmle/code/java/frameworks/gwt/GwtUiBinder.qll b/java/ql/src/semmle/code/java/frameworks/gwt/GwtUiBinder.qll
@@ -8,26 +8,44 @@
 import java
 import GwtUiBinderXml
 
+/**
+ * An annotation in the package `com.google.gwt.uibinder.client`.
+ */
 class GwtUiBinderClientAnnotation extends Annotation {
   GwtUiBinderClientAnnotation() { getType().getPackage().hasName("com.google.gwt.uibinder.client") }
 }
 
+/**
+ * A `@com.google.gwt.uibinder.client.UiHandler` annotation.
+ */
 class GwtUiHandlerAnnotation extends GwtUiBinderClientAnnotation {
   GwtUiHandlerAnnotation() { getType().hasName("UiHandler") }
 }
 
+/**
+ * A `@com.google.gwt.uibinder.client.UiField` annotation.
+ */
 class GwtUiFieldAnnotation extends GwtUiBinderClientAnnotation {
   GwtUiFieldAnnotation() { getType().hasName("UiField") }
 }
 
+/**
+ * A `@com.google.gwt.uibinder.client.UiTemplate` annotation.
+ */
 class GwtUiTemplateAnnotation extends GwtUiBinderClientAnnotation {
   GwtUiTemplateAnnotation() { getType().hasName("UiTemplate") }
 }
 
+/**
+ * A `@com.google.gwt.uibinder.client.UiFactory` annotation.
+ */
 class GwtUiFactoryAnnotation extends GwtUiBinderClientAnnotation {
   GwtUiFactoryAnnotation() { getType().hasName("UiFactory") }
 }
 
+/**
+ * A `@com.google.gwt.uibinder.client.UiConstructor` annotation.
+ */
 class GwtUiConstructorAnnotation extends GwtUiBinderClientAnnotation {
   GwtUiConstructorAnnotation() { getType().hasName("UiConstructor") }
 }
diff --git a/java/ql/src/semmle/code/java/frameworks/gwt/GwtXml.qll b/java/ql/src/semmle/code/java/frameworks/gwt/GwtXml.qll
@@ -1,3 +1,5 @@
+/** Provides classes and predicates for working with `*.gwt.xml` files. */
+
 import semmle.code.xml.XML
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+/** Provides classes and predicates for working with the GWT framework. */`
	`2`	`+`
`1`	`3`	`import java`
`2`	`4`	`import GwtXml`
`3`	`5`	`import GwtUiBinder`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	+/** Provides classes and predicates for working with `.gwt.xml` files. /
	`2`	`+`
`1`	`3`	`import semmle.code.xml.XML`
`2`	`4`
`3`	`5`	`/**`