Merge pull request #3700 from lewisbirks/fix-docs

Fix Javadoc links on the site

Author: jknack

docs/asciidoc/configuration.adoc

@@ -251,7 +251,7 @@ To skip/ignore Jooby loading and precedence mechanism, just instantiate and set
 ----
 
 <1> Loads and parses configuration
-<2> Create a new environment with configuration and (http://optionally[optionally]) active names
+<2> Create a new environment with configuration and (optionally) active names
 <3> Set environment on Jooby instance
 
 IMPORTANT: Custom configuration is very flexible. You can reuse Jooby mechanism or provide your own.

docs/asciidoc/context.adoc

@@ -90,7 +90,7 @@ There are several parameter types: `header`, `cookie`, `path`, `query`, `form`,
 `session` and `flash`. All them share a unified/type-safe API for accessing and manipulating their values.
 
 We are going to describe them briefly in the next sections, then go into specific features of the
-<<Value API>>.
+<<context-value-api,Value API>>.
 
 There is also a <<context-parameters-parameter-lookup,parameter lookup>> feature by which you can access a parameter from any combination
 of the above types with well-defined priority.
@@ -540,7 +540,7 @@ File upload are available ONLY for multipart requests.
 
 ==== Session
 
-Session parameters are available via javadoc::Context[session] or javadoc::Context[sessionOrNull]
+Session parameters are available via javadoc:Context[session] or javadoc:Context[sessionOrNull]
 methods. HTTP Session is covered in his own <<session, chapter>>, but here is a quick look:
 
 .Java
@@ -599,7 +599,7 @@ a javadoc:Session[] but the lifecycle is shorter: *data is kept for only one req
 <3> Display an existing flash attribute `success` or shows `Welcome!`
 
 Flash attributes are implemented using an `HTTP Cookie`. To customize the cookie
-(its name defaults to `jooby.flash`) use the javadoc:Router[setFlashCookie, Cookie] method:
+(its name defaults to `jooby.flash`) use the javadoc:Router[setFlashCookie, io.jooby.Cookie] method:
 
 .Java
 [source,java,role="primary"]
@@ -626,7 +626,7 @@ Flash attributes are implemented using an `HTTP Cookie`. To customize the cookie
 ==== Parameter Lookup
 
 You can search for parameters in multiple sources with an explicitly defined priority using the
-javadoc:Context[lookup] or javadoc:Context[lookup, java.lang.String, ParamSource...] method:
+javadoc:Context[lookup] or javadoc:Context[lookup, java.lang.String, io.jooby.ParamSource...] method:
 
 .Java
 [source,java,role="primary"]

docs/asciidoc/dev-tools.adoc

@@ -143,7 +143,7 @@ joobyRun {
 <3> Source extensions. A change on these files trigger a compilation request, followed by a restart request.
 <4> Application port
 <5> How long to wait after last file change to restart. Default is: `500` milliseconds.
-<5> Use a single/fat class loader to run your application. This is required on complex project classpath where you start seeing weird reflection errors. This was the default mode in Jooby 2.x. The new model since 3.x uses a modular classloader which improves restart times and memory usage making it faster. Default is: `false`.
+<6> Use a single/fat class loader to run your application. This is required on complex project classpath where you start seeing weird reflection errors. This was the default mode in Jooby 2.x. The new model since 3.x uses a modular classloader which improves restart times and memory usage making it faster. Default is: `false`.
 
 For Maven and Gradle there are two variant `mvn jooby:testRun` and `./gradlew joobyTestRun` they work
 by expanding the classpath to uses the `test` scope or source set.

docs/asciidoc/error-handler.adoc

@@ -1,7 +1,7 @@
 == Error Handler
 
 Jooby catches application exception using the javadoc:ErrorHandler[] class. The
-javadoc:ErrorHandler[DEFAULT] error handler produces simple HTML page or JSON based on the value
+javadoc:DefaultErrorHandler[] error handler produces simple HTML page or JSON based on the value
 of the `ACCEPT` header and log the exception.
 
 .HTML:
@@ -32,7 +32,7 @@ io.jooby.StatusCodeException: Not found
 	at java.lang.Thread.run(Thread.java:748)
 ----
 
-The javadoc:StatusCodeException[] works as generic exception that let you specify an status code.
+The javadoc:exception.StatusCodeException[] works as generic exception that let you specify an status code.
 
 ----
 throw new StatusCodeException(StatusCode.FORBIDDEN);

docs/asciidoc/execution-model.adoc

@@ -354,7 +354,7 @@ worker executor is used when:
 
 Each web server provides a default *worker executor*:
 
-- Netty: The javadoc:netty.Netty[text=Netty server] implementation multiply the number of available processors
+- Netty: The javadoc:netty.NettyServer[text=Netty server, artifact=jooby-netty] implementation multiply the number of available processors
 (with a minimum of 2) by 8.
 
 ----
@@ -363,7 +363,7 @@ workerThreads = Math.max(Runtime.getRuntime().availableProcessors(), 2) * 8
 
 For example `8` cores gives us `64` worker threads.
 
-- Undertow: The javadoc:utow.Utow[text=Undertow server] implementation multiply the number of available processors
+- Undertow: The javadoc:undertow.UndertowServer[text=Undertow server, artifact=jooby-undertow] implementation multiply the number of available processors
 by 8.
 
 ----
@@ -372,7 +372,7 @@ workerThreads = Runtime.getRuntime().availableProcessors() * 8
 
 For `8` cores gives us `64` worker threads.
 
-- Jetty: The javadoc:jetty.Jetty[text=Jetty server] implementation uses the default configuration
+- Jetty: The javadoc:jetty.JettyServer[text=Jetty server, artifact=jooby-jetty] implementation uses the default configuration
 with `200` worker threads.
 
 These are sensible defaults suggested by the server implementation. If you need to increase/decrease

docs/asciidoc/handlers/access-log.adoc

@@ -1,12 +1,12 @@
 === AccessLogHandler
 
-The javadoc:AccessLogHandler[] logs incoming requests using the https://en.wikipedia.org/wiki/Common_Log_Format[NCSA format] (a.k.a common log format).
+The javadoc:handler.AccessLogHandler[] logs incoming requests using the https://en.wikipedia.org/wiki/Common_Log_Format[NCSA format] (a.k.a common log format).
 
 .Usage
 [source, java, role = "primary"]
 ----
 import io.jooby.Jooby;
-import io.jooby.AccessLogHandler;
+import io.jooby.handler.AccessLogHandler;
 ...
 {
   
@@ -21,7 +21,7 @@ import io.jooby.AccessLogHandler;
 .Kotlin
 [source, kotlin, role = "secondary"]
 ----
-import io.jooby.AccessLogHandler
+import io.jooby.handler.AccessLogHandler
 ...
 {
   use(AccessLogHandler())      <1>
@@ -50,8 +50,8 @@ Message is represented by:
 
 Extra request or response headers can be appended at the end using the available methods:
 
-- javadoc:AccessLogHandler[requestHeader, java.lang.String...]
-- javadoc:AccessLogHandler[responseHeader, java.lang.String...]
+- javadoc:handler.AccessLogHandler[requestHeader, java.lang.String...]
+- javadoc:handler.AccessLogHandler[responseHeader, java.lang.String...]
 
 [TIP]
 ====

docs/asciidoc/handlers/cors.adoc

@@ -7,13 +7,13 @@ request when it requests a resource that has a different origin (domain, protoco
 its own origin.
 
 Jooby supports CORS out of the box. By default, **CORS requests will be rejected**.
-To enable processing of CORS requests, use the javadoc:CorsHandler[]:
+To enable processing of CORS requests, use the javadoc:handler.CorsHandler[]:
 
 .CorsExample
 [source, java, role = "primary"]
 ----
 import io.jooby.Jooby;
-import io.jooby.CorsHandler;
+import io.jooby.handler.CorsHandler;
 ...
 {
   
@@ -28,7 +28,7 @@ import io.jooby.CorsHandler;
 .Kotlin
 [source, kotlin, role = "secondary"]
 ----
-import io.jooby.CorsHandler
+import io.jooby.handler.CorsHandler
 ...
 {
   use(CorsHandler())      <1>
@@ -49,13 +49,14 @@ Default options are:
 - allowed headers: `X-Requested-With`, `Content-Type`, `Accept` and `Origin`
 - max age: `30m`;
 
-To customize default options use javadoc:Cors[]:
+To customize default options use javadoc:handler.Cors[]:
 
 .Cors options
 [source, java, role = "primary"]
 ----
 import io.jooby.Jooby;
-import io.jooby.CorsHandler;
+import io.jooby.handler.Cors;
+import io.jooby.handler.CorsHandler;
 ...
 {
   Cors cors = new Cors()
@@ -73,7 +74,7 @@ import io.jooby.CorsHandler;
 [source, kotlin, role = "secondary"]
 ----
 import io.jooby.Jooby
-import io.jooby.CorsHandler
+import io.jooby.handler.CorsHandler
 import io.jooby.cors
 ...
 {
@@ -110,7 +111,8 @@ cors {
 [source, java, role = "primary"]
 ----
 import io.jooby.Jooby;
-import io.jooby.CorsHandler;
+import io.jooby.handler.Cors;
+import io.jooby.handler.CorsHandler;
 ...
 {
   Cors cors = Cors.from(getConfig());  <1>
@@ -127,7 +129,7 @@ import io.jooby.CorsHandler;
 [source, kotlin, role = "secondary"]
 ----
 import io.jooby.Jooby
-import io.jooby.CorsHandler
+import io.jooby.handler.CorsHandler
 ...
 {
   val cors = Cors.from(config)         <1>

docs/asciidoc/handlers/csrf.adoc

@@ -1,6 +1,6 @@
 === CsrfHandler
 
-The javadoc:CsrfHandler[text="Cross Site Request Forgery Handler"] helps to protect from (CSRF) 
+The javadoc:handler.CsrfHandler[text="Cross Site Request Forgery Handler"] helps to protect from (CSRF) 
 attacks. Cross-site request forgeries are a type of malicious exploit whereby unauthorized commands
 are performed on behalf of an authenticated user.
 
@@ -20,10 +20,10 @@ field in the form so that the CSRF protection middleware can validate the reques
 </form>
 ----
 
-The `csrf` is a request attribute created by the javadoc:CsrfHandler[] handler and rendered by a
+The `csrf` is a request attribute created by the javadoc:handler.CsrfHandler[] handler and rendered by a
 template engine. Here `{{csrf}}` we use Handlebars template engine (as example).
 
-The javadoc:CsrfHandler[] handler, will automatically verify that the token in the request input 
+The javadoc:handler.CsrfHandler[] handler, will automatically verify that the token in the request input 
 matches the token stored in the session.
 
 The token defaults name is `csrf` and can be provided as:
@@ -34,5 +34,5 @@ The token defaults name is `csrf` and can be provided as:
 
 Configuration methods:
 
-- javadoc:CsrfHandler["setTokenGenerator", java.util.Function]: Set a custom token generator. Defaults uses a random UUID.
-- javadoc:CsrfHandler["setRequestFilter", java.util.Predicate]: Set a custom request filter. Defaults is to process `POST`, `PUT`, `PATCH` and `DELETE`.
+- javadoc:handler.CsrfHandler["setTokenGenerator", java.util.function.Function]: Set a custom token generator. Defaults uses a random UUID.
+- javadoc:handler.CsrfHandler["setRequestFilter", java.util.function.Predicate]: Set a custom request filter. Defaults is to process `POST`, `PUT`, `PATCH` and `DELETE`.

docs/asciidoc/handlers/head.adoc

@@ -5,13 +5,13 @@ Jooby doesn't support `HTTP HEAD` requests by default. To support them you have
 - Use the built-in `HeadHandler`
 - Write your own head handler
 
-The javadoc:HeadHandler[] supports `HEAD` requests over existing `GET` handlers.
+The javadoc:handler.HeadHandler[] supports `HEAD` requests over existing `GET` handlers.
 
 .Head Example
 [source, java, role = "primary"]
 ----
 import io.jooby.Jooby;
-import io.jooby.HeadHandler;
+import io.jooby.handler.HeadHandler;
 ...
 {
   

docs/asciidoc/handlers/ssl.adoc

@@ -1,12 +1,12 @@
 === SSLHandler
 
-The javadoc:SSLHandler[] forces client to use HTTPS by redirecting non-HTTPS calls to the HTTPS version.
+The javadoc:handler.SSLHandler[] forces client to use HTTPS by redirecting non-HTTPS calls to the HTTPS version.
 
 .Force SSL
 [source, java, role = "primary"]
 ----
 import io.jooby.Jooby;
-import io.jooby.SSLHandler;
+import io.jooby.handler.SSLHandler;
 ...
 {
   
@@ -24,7 +24,7 @@ import io.jooby.SSLHandler;
 [source, kotlin, role = "secondary"]
 ----
 import io.jooby.Jooby
-import io.jooby.SSHandler
+import io.jooby.handler.SSHandler
 ...
 {
   serverOptions {
@@ -42,15 +42,15 @@ import io.jooby.SSHandler
 <1> Install SSLHandler
 
 The SSL Handler recreates the HTTPs URL version using the `Host` header, if you are behind a proxy
-you will need to use the `X-Forwarded-Host` header. To do that set the <<router-trust-proxy, trust proxy>> option.
+you will need to use the `X-Forwarded-Host` header. To do that set the <<router-options-trust-proxy, trust proxy>> option.
 
 Optionally, you can specify the host to use:
 
 .Force SSL
 [source, java, role = "primary"]
 ----
 import io.jooby.Jooby;
-import io.jooby.SSLHandler;
+import io.jooby.handler.SSLHandler;
 ...
 {
   
@@ -68,7 +68,7 @@ import io.jooby.SSLHandler;
 [source, kotlin, role = "secondary"]
 ----
 import io.jooby.Jooby
-import io.jooby.SSHandler
+import io.jooby.handler.SSHandler
 ...
 {
   serverOptions {
@@ -88,5 +88,5 @@ For more information about SSL, please check the <<server-https-support, configu
 [TIP]
 ====
 If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header,
-please consider to add the link:proxy-peer-address.adoc[] to your pipeline.
+please consider to add the <<router-options-trust-proxy, trust proxy>> to your pipeline.
 ====