Skip to content

Commit 41a87bc

Browse files
committed
minor changes: review javadoc of Jooby.java + rename/set a better name to *.md files
1 parent ef63148 commit 41a87bc

60 files changed

Lines changed: 17 additions & 21 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

jooby/src/main/java/org/jooby/Jooby.java

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
import javaslang.control.Try;
147147

148148
/**
149-
* <h1>Getting Started:</h1>
149+
* <h1>jooby</h1>
150150
* <p>
151151
* A new application must extends Jooby, register one ore more {@link Renderer} and some
152152
* {@link Route routes}. It sounds like a lot of work to do, but it isn't.
@@ -159,19 +159,19 @@
159159
* renderer(new Json()); // 1. JSON serializer.
160160
*
161161
* // 2. Define a route
162-
* get("/", (req, rsp) {@literal ->} {
162+
* get("/", req {@literal ->} {
163163
* Map{@literal <}String, Object{@literal >} model = ...;
164-
* rsp.send(model);
164+
* return model;
165165
* }
166166
* }
167167
*
168168
* public static void main(String[] args) throws Exception {
169-
* new MyApp().start(); // 3. Done!
169+
* run(MyApp::new, args); // 3. Done!
170170
* }
171171
* }
172172
* </pre>
173173
*
174-
* <h1>Properties files</h1>
174+
* <h2>application.conf</h2>
175175
* <p>
176176
* Jooby delegate configuration management to <a
177177
* href="https://github.com/typesafehub/config">TypeSafe Config</a>. If you are unfamiliar with <a
@@ -212,7 +212,7 @@
212212
* System properties takes precedence over any application specific property.
213213
* </p>
214214
*
215-
* <h1>env</h1>
215+
* <h2>env</h2>
216216
* <p>
217217
* Jooby defines two modes: <strong>dev</strong> or something else. In Jooby, <strong>dev</strong>
218218
* is special and some modules could apply special settings while running in <strong>dev</strong>.
@@ -228,7 +228,7 @@
228228
* There is more at {@link Env} so take a few minutes to discover what a {@link Env} can do for you.
229229
* </p>
230230
*
231-
* <h1>Modules</h1>
231+
* <h2>modules: the jump to full-stack framework</h2>
232232
* <p>
233233
* {@link Jooby.Module Modules} are quite similar to a Guice modules except that the configure
234234
* callback has been complementing with {@link Env} and {@link Config}.
@@ -247,7 +247,7 @@
247247
* {@link Jooby.Module} can do for you.
248248
* </p>
249249
*
250-
* <h1>Path Patterns</h1>
250+
* <h2>path patterns</h2>
251251
* <p>
252252
* Jooby supports Ant-style path patterns:
253253
* </p>
@@ -264,7 +264,7 @@
264264
* <li>{@code *} - matches any path at any level, shorthand for {@code **}/{@code *}.</li>
265265
* </ul>
266266
*
267-
* <h2>Variables</h2>
267+
* <h3>variables</h3>
268268
* <p>
269269
* Jooby supports path parameters too:
270270
* </p>
@@ -278,7 +278,7 @@
278278
* <code>id</code> var.</li>
279279
* </ul>
280280
*
281-
* <h1>Routes</h1>
281+
* <h2>routes</h2>
282282
* <p>
283283
* Routes perform actions in response to a server HTTP request. There are two types of routes
284284
* callback: {@link Route.Handler} and {@link Route.Filter}.
@@ -331,7 +331,7 @@
331331
* });
332332
* </pre>
333333
*
334-
* <h2>Mvc Route</h2>
334+
* <h3>mvc routes</h3>
335335
* <p>
336336
* A Mvc route use annotations to define routes:
337337
* </p>
@@ -359,7 +359,7 @@
359359
* {@link org.jooby.mvc.Produces} {@link org.jooby.mvc.Consumes} .
360360
* </p>
361361
*
362-
* <h1>Static Files</h1>
362+
* <h2>static files</h2>
363363
* <p>
364364
* Static files, like: *.js, *.css, ..., etc... can be served with:
365365
* </p>
@@ -370,7 +370,8 @@
370370
* <p>
371371
* Classpath resources under the <code>/assets</code> folder will be accessible from client/browser.
372372
* </p>
373-
* <h1>Bootstrap</h1>
373+
*
374+
* <h2>bootstrap</h2>
374375
* <p>
375376
* The bootstrap process is defined as follows:
376377
* </p>

0 commit comments

Comments
 (0)