Skip to content

Commit e56ec1e

Browse files
cescoffiercescoffier
committed
update documentation
* use the new variable format * fix style issue in the header * add instruction to download the client in a stack
1 parent 28df7bc commit e56ec1e

File tree

5 files changed

+50
-30
lines changed

5 files changed

+50
-30
lines changed

‎src/main/asciidoc/groovy/index.adoc‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Vert.x MySQL / PostgreSQL client
22

3-
The `link:../../groovydoc/io/vertx/groovy/ext/asyncsql/AsyncSQLClient.html[MySQL / PostgreSQL Client]` is responsible for providing an
3+
The Async MySQL / PostgreSQL Client is responsible for providing an
44
interface for Vert.x applications that need to interact with a MySQL or PostgreSQL database.
55

66
It uses Mauricio Linhares https://github.com/mauricio/postgresql-async[async driver] to interact with the MySQL
@@ -15,7 +15,7 @@ application.
1515

1616
To use this client, you need to add the following jar to your `CLASSPATH`:
1717

18-
* {maven-artifactId} {maven-version} (the client)
18+
* vertx-mysql-postgresql-client 3.3.0-SNAPSHOT (the client)
1919
* scala-library 2.11.4
2020
* the postgress-async-2.11 and mysdql-async-2.11 from https://github.com/mauricio/postgresql-async
2121
* joda time
@@ -31,23 +31,27 @@ If you are building a _Fat-jar_ using Maven or Gradle, just add the following de
3131
[source,xml,subs="+attributes"]
3232
----
3333
<dependency>
34-
<groupId>{maven-groupId}</groupId>
35-
<artifactId>{maven-artifactId}</artifactId>
36-
<version>{maven-version}</version>
34+
<groupId>io.vertx</groupId>
35+
<artifactId>vertx-mysql-postgresql-client</artifactId>
36+
<version>3.3.0-SNAPSHOT</version>
3737
</dependency>
3838
----
3939

4040
* Gradle (in your `build.gradle` file):
4141

4242
[source,groovy,subs="+attributes"]
4343
----
44-
compile "{maven-groupId}:{maven-artifactId}:{maven-version}"
44+
compile 'io.vertx:vertx-mysql-postgresql-client:3.3.0-SNAPSHOT'
4545
----
4646

4747
=== In an application using a vert.x distributions
4848

4949
If you are using a vert.x distribution, add the jar files listed above to the `$VERTX_HOME/lib` directory.
5050

51+
Alternatively, you can edit the `vertx-stack.json` file located in `$VERTX_HOME`, and set `"included": true`
52+
for the `vertx-mysql-postgresql-client` dependency. Once done, launch: `vertx resolve --dir=lib --stack=
53+
./vertx-stack.json`. It downloads the client and its dependencies.
54+
5155
== Creating a the client
5256

5357
There are several ways to create a client. Let's go through them all.

‎src/main/asciidoc/java/index.adoc‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Vert.x MySQL / PostgreSQL client
22

3-
The `link:../../apidocs/io/vertx/ext/asyncsql/AsyncSQLClient.html[MySQL / PostgreSQL Client]` is responsible for providing an
3+
The Async MySQL / PostgreSQL Client is responsible for providing an
44
interface for Vert.x applications that need to interact with a MySQL or PostgreSQL database.
55

66
It uses Mauricio Linhares https://github.com/mauricio/postgresql-async[async driver] to interact with the MySQL
@@ -15,7 +15,7 @@ application.
1515

1616
To use this client, you need to add the following jar to your `CLASSPATH`:
1717

18-
* {maven-artifactId} {maven-version} (the client)
18+
* vertx-mysql-postgresql-client 3.3.0-SNAPSHOT (the client)
1919
* scala-library 2.11.4
2020
* the postgress-async-2.11 and mysdql-async-2.11 from https://github.com/mauricio/postgresql-async
2121
* joda time
@@ -31,23 +31,27 @@ If you are building a _Fat-jar_ using Maven or Gradle, just add the following de
3131
[source,xml,subs="+attributes"]
3232
----
3333
<dependency>
34-
<groupId>{maven-groupId}</groupId>
35-
<artifactId>{maven-artifactId}</artifactId>
36-
<version>{maven-version}</version>
34+
<groupId>io.vertx</groupId>
35+
<artifactId>vertx-mysql-postgresql-client</artifactId>
36+
<version>3.3.0-SNAPSHOT</version>
3737
</dependency>
3838
----
3939

4040
* Gradle (in your `build.gradle` file):
4141

4242
[source,groovy,subs="+attributes"]
4343
----
44-
compile "{maven-groupId}:{maven-artifactId}:{maven-version}"
44+
compile 'io.vertx:vertx-mysql-postgresql-client:3.3.0-SNAPSHOT'
4545
----
4646

4747
=== In an application using a vert.x distributions
4848

4949
If you are using a vert.x distribution, add the jar files listed above to the `$VERTX_HOME/lib` directory.
5050

51+
Alternatively, you can edit the `vertx-stack.json` file located in `$VERTX_HOME`, and set `"included": true`
52+
for the `vertx-mysql-postgresql-client` dependency. Once done, launch: `vertx resolve --dir=lib --stack=
53+
./vertx-stack.json`. It downloads the client and its dependencies.
54+
5155
== Creating a the client
5256

5357
There are several ways to create a client. Let's go through them all.

‎src/main/asciidoc/js/index.adoc‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Vert.x MySQL / PostgreSQL client
22

3-
The `link:../../jsdoc/async_sql_client-AsyncSQLClient.html[MySQL / PostgreSQL Client]` is responsible for providing an
3+
The Async MySQL / PostgreSQL Client is responsible for providing an
44
interface for Vert.x applications that need to interact with a MySQL or PostgreSQL database.
55

66
It uses Mauricio Linhares https://github.com/mauricio/postgresql-async[async driver] to interact with the MySQL
@@ -15,7 +15,7 @@ application.
1515

1616
To use this client, you need to add the following jar to your `CLASSPATH`:
1717

18-
* {maven-artifactId} {maven-version} (the client)
18+
* vertx-mysql-postgresql-client 3.3.0-SNAPSHOT (the client)
1919
* scala-library 2.11.4
2020
* the postgress-async-2.11 and mysdql-async-2.11 from https://github.com/mauricio/postgresql-async
2121
* joda time
@@ -31,23 +31,27 @@ If you are building a _Fat-jar_ using Maven or Gradle, just add the following de
3131
[source,xml,subs="+attributes"]
3232
----
3333
<dependency>
34-
<groupId>{maven-groupId}</groupId>
35-
<artifactId>{maven-artifactId}</artifactId>
36-
<version>{maven-version}</version>
34+
<groupId>io.vertx</groupId>
35+
<artifactId>vertx-mysql-postgresql-client</artifactId>
36+
<version>3.3.0-SNAPSHOT</version>
3737
</dependency>
3838
----
3939

4040
* Gradle (in your `build.gradle` file):
4141

4242
[source,groovy,subs="+attributes"]
4343
----
44-
compile "{maven-groupId}:{maven-artifactId}:{maven-version}"
44+
compile 'io.vertx:vertx-mysql-postgresql-client:3.3.0-SNAPSHOT'
4545
----
4646

4747
=== In an application using a vert.x distributions
4848

4949
If you are using a vert.x distribution, add the jar files listed above to the `$VERTX_HOME/lib` directory.
5050

51+
Alternatively, you can edit the `vertx-stack.json` file located in `$VERTX_HOME`, and set `"included": true`
52+
for the `vertx-mysql-postgresql-client` dependency. Once done, launch: `vertx resolve --dir=lib --stack=
53+
./vertx-stack.json`. It downloads the client and its dependencies.
54+
5155
== Creating a the client
5256

5357
There are several ways to create a client. Let's go through them all.

‎src/main/asciidoc/ruby/index.adoc‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Vert.x MySQL / PostgreSQL client
22

3-
The `link:../../yardoc/VertxMysqlPostgresql/AsyncSQLClient.html[MySQL / PostgreSQL Client]` is responsible for providing an
3+
The Async MySQL / PostgreSQL Client is responsible for providing an
44
interface for Vert.x applications that need to interact with a MySQL or PostgreSQL database.
55

66
It uses Mauricio Linhares https://github.com/mauricio/postgresql-async[async driver] to interact with the MySQL
@@ -15,7 +15,7 @@ application.
1515

1616
To use this client, you need to add the following jar to your `CLASSPATH`:
1717

18-
* {maven-artifactId} {maven-version} (the client)
18+
* vertx-mysql-postgresql-client 3.3.0-SNAPSHOT (the client)
1919
* scala-library 2.11.4
2020
* the postgress-async-2.11 and mysdql-async-2.11 from https://github.com/mauricio/postgresql-async
2121
* joda time
@@ -31,23 +31,27 @@ If you are building a _Fat-jar_ using Maven or Gradle, just add the following de
3131
[source,xml,subs="+attributes"]
3232
----
3333
<dependency>
34-
<groupId>{maven-groupId}</groupId>
35-
<artifactId>{maven-artifactId}</artifactId>
36-
<version>{maven-version}</version>
34+
<groupId>io.vertx</groupId>
35+
<artifactId>vertx-mysql-postgresql-client</artifactId>
36+
<version>3.3.0-SNAPSHOT</version>
3737
</dependency>
3838
----
3939

4040
* Gradle (in your `build.gradle` file):
4141

4242
[source,groovy,subs="+attributes"]
4343
----
44-
compile "{maven-groupId}:{maven-artifactId}:{maven-version}"
44+
compile 'io.vertx:vertx-mysql-postgresql-client:3.3.0-SNAPSHOT'
4545
----
4646

4747
=== In an application using a vert.x distributions
4848

4949
If you are using a vert.x distribution, add the jar files listed above to the `$VERTX_HOME/lib` directory.
5050

51+
Alternatively, you can edit the `vertx-stack.json` file located in `$VERTX_HOME`, and set `"included": true`
52+
for the `vertx-mysql-postgresql-client` dependency. Once done, launch: `vertx resolve --dir=lib --stack=
53+
./vertx-stack.json`. It downloads the client and its dependencies.
54+
5155
== Creating a the client
5256

5357
There are several ways to create a client. Let's go through them all.

‎src/main/java/io/vertx/ext/asyncsql/package-info.java‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/**
1818
* = Vert.x MySQL / PostgreSQL client
1919
*
20-
* The {@link io.vertx.ext.asyncsql.AsyncSQLClient MySQL / PostgreSQL Client} is responsible for providing an
20+
* The Async MySQL / PostgreSQL Client is responsible for providing an
2121
* interface for Vert.x applications that need to interact with a MySQL or PostgreSQL database.
2222
*
2323
* It uses Mauricio Linhares https://github.com/mauricio/postgresql-async[async driver] to interact with the MySQL
@@ -32,7 +32,7 @@
3232
*
3333
* To use this client, you need to add the following jar to your `CLASSPATH`:
3434
*
35-
* * {maven-artifactId} {maven-version} (the client)
35+
* * ${maven.artifactId} ${maven.version} (the client)
3636
* * scala-library 2.11.4
3737
* * the postgress-async-2.11 and mysdql-async-2.11 from https://github.com/mauricio/postgresql-async
3838
* * joda time
@@ -48,23 +48,27 @@
4848
* [source,xml,subs="+attributes"]
4949
* ----
5050
* <dependency>
51-
* <groupId>{maven-groupId}</groupId>
52-
* <artifactId>{maven-artifactId}</artifactId>
53-
* <version>{maven-version}</version>
51+
* <groupId>${maven.groupId}</groupId>
52+
* <artifactId>${maven.artifactId}</artifactId>
53+
* <version>${maven.version}</version>
5454
* </dependency>
5555
* ----
5656
*
5757
* * Gradle (in your `build.gradle` file):
5858
*
5959
* [source,groovy,subs="+attributes"]
6060
* ----
61-
* compile "{maven-groupId}:{maven-artifactId}:{maven-version}"
61+
* compile '${maven.groupId}:${maven.artifactId}:${maven.version}'
6262
* ----
6363
*
6464
* === In an application using a vert.x distributions
6565
*
6666
* If you are using a vert.x distribution, add the jar files listed above to the `$VERTX_HOME/lib` directory.
6767
*
68+
* Alternatively, you can edit the `vertx-stack.json` file located in `$VERTX_HOME`, and set `"included": true`
69+
* for the `vertx-mysql-postgresql-client` dependency. Once done, launch: `vertx resolve --dir=lib --stack=
70+
* ./vertx-stack.json`. It downloads the client and its dependencies.
71+
*
6872
* == Creating a the client
6973
*
7074
* There are several ways to create a client. Let's go through them all.

0 commit comments

Comments
 (0)