diff --git a/src/main/groovy/org/groocss/Color.groovy b/src/main/groovy/org/groocss/Color.groovy index 2ec037e..c403b18 100644 --- a/src/main/groovy/org/groocss/Color.groovy +++ b/src/main/groovy/org/groocss/Color.groovy @@ -21,6 +21,19 @@ import java.math.MathContext /** * Controls Color for CSS styles and has methods for brighter, darker, etc. + * + *
Colors can be created using many different methods: + *
The final CSS result from a Color depends on how it was created and what methods were called on it. + * For example, if {@link Color#alpha(double)} is used, the output color uses rgba. + * + *
Methods from {@link ColorMethods} are available to modify Colors. + * + * @see ColorMethods */ @EqualsAndHashCode class Color { diff --git a/src/main/groovy/org/groocss/Config.groovy b/src/main/groovy/org/groocss/Config.groovy index 2a043c2..3ed7b24 100644 --- a/src/main/groovy/org/groocss/Config.groovy +++ b/src/main/groovy/org/groocss/Config.groovy @@ -22,7 +22,15 @@ import groovy.transform.builder.Builder import org.groocss.valid.Processor /** - * Configuration for GrooCSS conversions. + * Configuration for GrooCSS conversions. There are at least four different ways to configure GrooCSS: + * + *
* Measurements are created using the DSL syntax such as:
- * 2.s //== two seconds
+ *
+ * 20.deg //== 20 degrees
*
* @see org.groocss.ext.NumberExtension
* @see org.groocss.valid.DefaultValidator
diff --git a/src/main/groovy/org/groocss/PseudoClass.groovy b/src/main/groovy/org/groocss/PseudoClass.groovy
index e794f26..295a421 100644
--- a/src/main/groovy/org/groocss/PseudoClass.groovy
+++ b/src/main/groovy/org/groocss/PseudoClass.groovy
@@ -19,6 +19,13 @@ import groovy.transform.*
/**
* Represents a CSS pseudo-class such as :active, :focus, or :nthChild(odd).
+ * 2.s //== two seconds
* 20.px //== 20 pixels
- * 20.deg //== 20 degrees
+ * Pseudo classes are appended to selectors using the % operator. They are chainable as well meaning
+ * the following is possible: a %active %hover
becomes a:active:hover.
+ *
+ * Special abbreviations exist such as "odd" for ":nthChild(odd)" and "even" for :nthChild(even).
+ *
+ * @see GrooCSS
*/
@TypeChecked
@TupleConstructor
diff --git a/src/main/groovy/org/groocss/Raw.groovy b/src/main/groovy/org/groocss/Raw.groovy
index dd0127d..e6bcbc7 100644
--- a/src/main/groovy/org/groocss/Raw.groovy
+++ b/src/main/groovy/org/groocss/Raw.groovy
@@ -20,7 +20,7 @@ import groovy.transform.EqualsAndHashCode
import groovy.transform.TupleConstructor
/**
- * Created by adavis on 8/9/17.
+ * Raw contains unescaped CSS that will be output in final CSS. Created by adavis on 8/9/17.
*/
@TupleConstructor
@EqualsAndHashCode
diff --git a/src/main/groovy/org/groocss/valid/AbstractValidator.groovy b/src/main/groovy/org/groocss/valid/AbstractValidator.groovy
index e08c371..c8378b0 100644
--- a/src/main/groovy/org/groocss/valid/AbstractValidator.groovy
+++ b/src/main/groovy/org/groocss/valid/AbstractValidator.groovy
@@ -1,6 +1,5 @@
package org.groocss.valid
-import groovy.transform.AutoImplement
import groovy.transform.CompileStatic
import org.groocss.CSSPart
@@ -10,7 +9,6 @@ import org.groocss.CSSPart
* @see Processor
* @see DefaultValidator
*/
-@AutoImplement(exception = Processor.NotImplementedException)
@CompileStatic
abstract class AbstractValidator Makes sure that time values are time Measurements and size values (such as top, left, width, and fontSize)
+ * are size values such as 1.px or 1.em or 10%.
+ *
+ * @see org.groocss.Config
+ * @see RequireMeasurements
*/
@CompileStatic
class DefaultValidator extends AbstractValidator