Skip to content

Commit 3e8f403

Browse files
committed
updates documentation, closes #229
1 parent 1788478 commit 3e8f403

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Documentation.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// # Flapi (v0.7)
1+
// # Flapi (v2.0)
22
// ### _A fluent API generator for Java_
33

44
/**
@@ -22,7 +22,7 @@
2222
* There are two build plugins availble, one for
2323
* [Maven](https://github.com/UnquietCode/Flapi/wiki/Maven-Build-Plugin)
2424
* and one for [Gradle](https://github.com/UnquietCode/Flapi/wiki/Gradle-Build-Plugin)
25-
* which allow you to regenerate your sources on the fly.
25+
* which allow you to regenerate your descriptor as part of your build.
2626
*
2727
*
2828
* ### At Run Time
@@ -53,7 +53,7 @@
5353

5454
// Set the Java source version for the generated code. Some features
5555
// are only enabled when the source version is set high enough. As of
56-
// version 0.7 the default is set at JDK 7.
56+
// version 2.0 the default is set at JDK 8.
5757
.setJDKVersion(SourceVersion version)
5858

5959
// Get the current source version used for generating code.
@@ -122,7 +122,7 @@
122122

123123
// Set the return type for the entire descriptor. (optional,
124124
// default is `void`)
125-
.setReturnType(Class class)
125+
.setReturnType(Class<?> class)
126126

127127
// As above, except the type can be specified without
128128
// creating a compile-time dependency on the class.
@@ -269,7 +269,7 @@ public enum TestEnum {
269269
// comprised of every enum in the provided enum class.
270270
// Returns a `MethodBuilder` which can be used to configure
271271
// the method's invocation in the parent block.
272-
.addEnumSelector(Class enumClass, String methodSignature)
272+
.addEnumSelector(Class<?> enumClass, String methodSignature)
273273

274274

275275
/**
@@ -314,7 +314,7 @@ public enum TestEnum {
314314
.addMixin(String blockName)
315315

316316
// mixin the contents of an annotated interface or class
317-
.addMixin(Class blockType)
317+
.addMixin(Class<?> blockType)
318318

319319

320320
/**
@@ -329,12 +329,12 @@ public enum TestEnum {
329329
* methods allow a method to become _visible_ only after another
330330
* method is called.
331331
*
332-
* 'visible' here means listed as a method in an interface which
332+
* 'Visible' here means listed as a method in an interface which
333333
* the user of our descriptor will interact with. If a user
334334
* attempts to invoke a method which is invisible, the method will
335335
* not be a member of the current class and a compile error
336336
* will occur! When using autocomplete it is very clear that the
337-
* method is no longer available to be called.
337+
* method is no longer available to be invoked.
338338
*/
339339

340340
.addMethod("unlimited()").any()
@@ -397,7 +397,7 @@ public enum TestEnum {
397397
// The method, in addition to being last, will also
398398
// return the specified type. This overrides any
399399
// return type set for the block.
400-
.last(Class class)
400+
.last(Class<?> class)
401401

402402
// As above, except the type can be specified without
403403
// creating a compile-time dependency on the class.

0 commit comments

Comments
 (0)