Permalink
Browse files

Merge pull request #1119 from xael-fry/1115_fixJavadoc

[#1115] documentation(code): fix warnings of the javadoc
  • Loading branch information...
2 parents 735471e + f94b56b commit 789f23e05870f9f6e2347a4bee86a72df5eb10c6 @xael-fry xael-fry committed on GitHub Mar 9, 2017
Showing with 3,400 additions and 1,932 deletions.
  1. +4 −3 framework/build.xml
  2. +4 −0 framework/src/play/CorePlugin.java
  3. +40 −22 framework/src/play/Invoker.java
  4. +84 −70 framework/src/play/Play.java
  5. +225 −105 framework/src/play/PlayPlugin.java
  6. +13 −0 framework/src/play/classloading/ApplicationClasses.java
  7. +57 −38 framework/src/play/classloading/ApplicationClassloader.java
  8. +7 −4 framework/src/play/classloading/ApplicationCompiler.java
  9. +81 −29 framework/src/play/classloading/enhancers/Enhancer.java
  10. +42 −24 framework/src/play/classloading/enhancers/LocalvariablesNamesEnhancer.java
  11. +6 −4 framework/src/play/data/binding/AnnotationHelper.java
  12. +143 −29 framework/src/play/data/binding/Binder.java
  13. +17 −8 framework/src/play/data/binding/TypeUnbinder.java
  14. +238 −221 framework/src/play/data/parsing/ApacheMultipartParser.java
  15. +6 −7 framework/src/play/data/validation/Equals.java
  16. +84 −77 framework/src/play/db/Configuration.java
  17. +37 −10 framework/src/play/db/DB.java
  18. +13 −15 framework/src/play/db/Evolutions.java
  19. +99 −83 framework/src/play/db/SQLSplitter.java
  20. +254 −51 framework/src/play/db/jpa/GenericModel.java
  21. +100 −63 framework/src/play/db/jpa/JPA.java
  22. +33 −16 framework/src/play/db/jpa/JPABase.java
  23. +4 −5 framework/src/play/db/jpa/NoTransaction.java
  24. +3 −2 framework/src/play/db/jpa/Transactional.java
  25. +8 −3 framework/src/play/inject/Injector.java
  26. +84 −68 framework/src/play/jobs/Job.java
  27. +28 −7 framework/src/play/libs/Codec.java
  28. +97 −109 framework/src/play/libs/CronExpression.java
  29. +54 −31 framework/src/play/libs/Crypto.java
  30. +37 −20 framework/src/play/libs/Files.java
  31. +91 −35 framework/src/play/libs/IO.java
  32. +71 −12 framework/src/play/libs/Images.java
  33. +40 −27 framework/src/play/libs/Mail.java
  34. +38 −23 framework/src/play/libs/MimeTypes.java
  35. +50 −29 framework/src/play/libs/OAuth.java
  36. +27 −26 framework/src/play/libs/OAuth2.java
  37. +6 −0 framework/src/play/libs/OpenID.java
  38. +141 −62 framework/src/play/libs/WS.java
  39. +36 −20 framework/src/play/libs/XML.java
  40. +28 −11 framework/src/play/libs/XPath.java
  41. +42 −25 framework/src/play/libs/ws/WSAsync.java
  42. +3 −3 framework/src/play/libs/ws/WSUrlFetch.java
  43. +11 −1 framework/src/play/mvc/After.java
  44. +10 −0 framework/src/play/mvc/Before.java
  45. +4 −1 framework/src/play/mvc/Catch.java
  46. +128 −133 framework/src/play/mvc/Controller.java
  47. +20 −9 framework/src/play/mvc/CookieDataCodec.java
  48. +12 −3 framework/src/play/mvc/Finally.java
  49. +72 −54 framework/src/play/mvc/Http.java
  50. +50 −41 framework/src/play/mvc/Mailer.java
  51. +110 −6 framework/src/play/mvc/Router.java
  52. +3 −2 framework/src/play/mvc/Scope.java
  53. +55 −32 framework/src/play/mvc/results/RenderBinary.java
  54. +2 −0 framework/src/play/mvc/results/Result.java
  55. +31 −19 framework/src/play/plugins/PluginCollection.java
  56. +104 −61 framework/src/play/templates/GroovyTemplate.java
  57. +4 −0 framework/src/play/templates/GroovyTemplateCompiler.java
  58. +47 −12 framework/src/play/templates/JavaExtensions.java
  59. +12 −8 framework/src/play/templates/Template.java
  60. +55 −47 framework/src/play/templates/TemplateLoader.java
  61. +6 −3 framework/src/play/test/BaseTest.java
  62. +17 −8 framework/src/play/test/CleanTest.java
  63. +42 −3 framework/src/play/test/Fixtures.java
  64. +11 −12 framework/src/play/test/FunctionalTest.java
  65. +25 −11 framework/src/play/utils/HTML.java
  66. +18 −14 framework/src/play/utils/HTTP.java
  67. +16 −2 framework/src/play/utils/Java.java
  68. +33 −33 framework/src/play/utils/Utils.java
  69. +27 −20 framework/src/play/vfs/VirtualFile.java
View
@@ -94,12 +94,13 @@
<classpath refid="classpath.test"/>
<doctitle><![CDATA[<h1>Play! ${version}</h1>]]></doctitle>
<bottom><![CDATA[<a href="http://guillaume.bort.fr">Guillaume Bort</a> &amp; <a href="http://www.zenexity.fr">zenexity</a> - Distributed under <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2 licence</a>, without any warrantly]]></bottom>
- <tag name="todo" scope="all" description="To do:"/>
+ <tag name="play.todo" scope="all" description="To do:"/>
+ <tag name="todo" scope="all" description="To do:"/>
<group title="Libs" packages="play.libs.*"/>
<link offline="false" href="http://docs.oracle.com/javaee/7/api/" />
- <link offline="false" href="http://docs.oracle.com/javase/7/docs/api/" />
+ <link offline="false" href="https://docs.oracle.com/javase/8/docs/api//" />
<link offline="false" href="http://commons.apache.org/proper/commons-fileupload/apidocs/" />
- <link offline="false" href="http://google-gson.googlecode.com/svn/tags/gson-2.2.4/docs/javadocs/" />
+ <link offline="false" href="https://static.javadoc.io/com.google.code.gson/gson/2.8.0/" />
<link offline="false" href="https://docs.jboss.org/hibernate/orm/4.2/javadocs/" />
<link offline="false" href="http://www.mchange.com/projects/c3p0/apidocs/" />
</javadoc>
@@ -42,6 +42,10 @@
/**
* Get the application status
+ *
+ * @param json
+ * true if the status should be return in JSON
+ * @return application status
*/
public static String computeApplicationStatus(boolean json) {
if (json) {
@@ -13,6 +13,9 @@
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
+import com.jamonapi.Monitor;
+import com.jamonapi.MonitorFactory;
+
import play.Play.Mode;
import play.classloading.ApplicationClassloader;
import play.classloading.enhancers.LocalvariablesNamesEnhancer.LocalVariablesNamesTracer;
@@ -23,9 +26,6 @@
import play.libs.F.Promise;
import play.utils.PThreadFactory;
-import com.jamonapi.Monitor;
-import com.jamonapi.MonitorFactory;
-
/**
* Run some code in a Play! context
*/
@@ -38,7 +38,9 @@
/**
* Run the code in a new thread took from a thread pool.
- * @param invocation The code to run
+ *
+ * @param invocation
+ * The code to run
* @return The future object, to know when the task is completed
*/
public static Future<?> invoke(Invocation invocation) {
@@ -50,8 +52,11 @@
/**
* Run the code in a new thread after a delay
- * @param invocation The code to run
- * @param millis The time to wait before, in milliseconds
+ *
+ * @param invocation
+ * The code to run
+ * @param millis
+ * The time to wait before, in milliseconds
* @return The future object, to know when the task is completed
*/
public static Future<?> invoke(Invocation invocation, long millis) {
@@ -62,7 +67,9 @@
/**
* Run the code in the same thread than caller.
- * @param invocation The code to run
+ *
+ * @param invocation
+ * The code to run
*/
public static void invokeInThread(DirectInvocation invocation) {
boolean retry = true;
@@ -154,8 +161,10 @@ public InvocationContext(String invocationType, Annotation[]... annotations) {
}
/**
- * Returns the InvocationType for this invocation - Ie: A plugin can use this to
- * find out if it runs in the context of a background Job
+ * Returns the InvocationType for this invocation - Ie: A plugin can use this to find out if it runs in the
+ * context of a background Job
+ *
+ * @return the InvocationType for this invocation
*/
public String getInvocationType() {
return invocationType;
@@ -186,15 +195,15 @@ public String toString() {
/**
* Override this method
+ *
* @throws java.lang.Exception
+ * Thrown if Invocation encounters any problems
*/
public abstract void execute() throws Exception;
-
/**
- * Needs this method to do stuff *before* init() is executed.
- * The different Invocation-implementations does a lot of stuff in init()
- * and they might do it before calling super.init()
+ * Needs this method to do stuff *before* init() is executed. The different Invocation-implementations does a
+ * lot of stuff in init() and they might do it before calling super.init()
*/
protected void preInit() {
// clear language for this request - we're resolving it later when it is needed
@@ -203,6 +212,8 @@ protected void preInit() {
/**
* Init the call (especially useful in DEV mode to detect changes)
+ *
+ * @return true if successful
*/
public boolean init() {
Thread.currentThread().setContextClassLoader(Play.classloader);
@@ -217,7 +228,6 @@ public boolean init() {
return true;
}
-
public abstract InvocationContext getInvocationContext();
/**
@@ -229,8 +239,7 @@ public void before() {
}
/**
- * Things to do after an Invocation.
- * (if the Invocation code has not thrown any exception)
+ * Things to do after an Invocation. (if the Invocation code has not thrown any exception)
*/
public void after() {
Play.pluginCollection.afterInvocation();
@@ -239,13 +248,19 @@ public void after() {
/**
* Things to do when the whole invocation has succeeded (before + execute + after)
+ *
+ * @throws java.lang.Exception
+ * Thrown if Invoker encounters any problems
*/
public void onSuccess() throws Exception {
Play.pluginCollection.onInvocationSuccess();
}
/**
* Things to do if the Invocation code thrown an exception
+ *
+ * @param e
+ * The exception
*/
public void onException(Throwable e) {
Play.pluginCollection.onInvocationException(e);
@@ -257,7 +272,9 @@ public void onException(Throwable e) {
/**
* The request is suspended
+ *
* @param suspendRequest
+ * the suspended request
*/
public void suspend(Suspend suspendRequest) {
if (suspendRequest.task != null) {
@@ -276,10 +293,10 @@ public void _finally() {
}
private void withinFilter(play.libs.F.Function0<Void> fct) throws Throwable {
- F.Option<PlayPlugin.Filter<Void>> filters = Play.pluginCollection.composeFilters();
- if (filters.isDefined()) {
- filters.get().withinFilter(fct);
- }
+ F.Option<PlayPlugin.Filter<Void>> filters = Play.pluginCollection.composeFilters();
+ if (filters.isDefined()) {
+ filters.get().withinFilter(fct);
+ }
}
/**
@@ -351,7 +368,8 @@ public InvocationContext getInvocationContext() {
* Init executor at load time.
*/
static {
- int core = Integer.parseInt(Play.configuration.getProperty("play.pool", Play.mode == Mode.DEV ? "1" : ((Runtime.getRuntime().availableProcessors() + 1) + "")));
+ int core = Integer.parseInt(Play.configuration.getProperty("play.pool",
+ Play.mode == Mode.DEV ? "1" : ((Runtime.getRuntime().availableProcessors() + 1) + "")));
executor = new ScheduledThreadPoolExecutor(core, new PThreadFactory("play"), new ThreadPoolExecutor.AbortPolicy());
}
@@ -364,7 +382,7 @@ public InvocationContext getInvocationContext() {
* Suspend for a timeout (in milliseconds).
*/
long timeout;
-
+
/**
* Wait for task execution.
*/
Oops, something went wrong.

0 comments on commit 789f23e

Please sign in to comment.