[#1762] Add package-info.java to add Javadoc documentation to all
packages
This commit is contained in:
parent
549eb19ef4
commit
334cd69b19
9
jOOQ/src/main/java/org/jooq/conf/package-info.java
Normal file
9
jOOQ/src/main/java/org/jooq/conf/package-info.java
Normal file
@ -0,0 +1,9 @@
|
||||
/**
|
||||
* The <code>org.jooq.conf</code> package contains jOOQ's runtime configuration
|
||||
* classes
|
||||
* <p>
|
||||
* This package contains JAXB-annotated configuration classes that can be
|
||||
* provided to a {@link org.jooq.impl.Factory} in order to influence jOOQ's
|
||||
* runtime behaviour.
|
||||
*/
|
||||
package org.jooq.conf;
|
||||
4
jOOQ/src/main/java/org/jooq/exception/package-info.java
Normal file
4
jOOQ/src/main/java/org/jooq/exception/package-info.java
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* The <code>org.jooq.exception</code> package contains jOOQ's exceptions
|
||||
*/
|
||||
package org.jooq.exception;
|
||||
9
jOOQ/src/main/java/org/jooq/impl/package-info.java
Normal file
9
jOOQ/src/main/java/org/jooq/impl/package-info.java
Normal file
@ -0,0 +1,9 @@
|
||||
/**
|
||||
* The <code>org.jooq.impl</code> package contains jOOQ's implementation classes
|
||||
* <p>
|
||||
* This package provides implementations for the jOOQ API from
|
||||
* <code>org.jooq</code>, whose interfaces are constructed mostly through the
|
||||
* {@link org.jooq.impl.Factory} class, which hides implementation facts from
|
||||
* the public API
|
||||
*/
|
||||
package org.jooq.impl;
|
||||
9
jOOQ/src/main/java/org/jooq/package-info.java
Normal file
9
jOOQ/src/main/java/org/jooq/package-info.java
Normal file
@ -0,0 +1,9 @@
|
||||
/**
|
||||
* The <code>org.jooq</code> package contains jOOQ's public API
|
||||
* <p>
|
||||
* This package mostly contains interfaces that are implemented by the
|
||||
* <code>org.jooq.impl</code> package. These interfaces are constructed mostly
|
||||
* through the {@link org.jooq.impl.Factory} class, which hides implementation
|
||||
* facts from the public API
|
||||
*/
|
||||
package org.jooq;
|
||||
10
jOOQ/src/main/java/org/jooq/tools/csv/package-info.java
Normal file
10
jOOQ/src/main/java/org/jooq/tools/csv/package-info.java
Normal file
@ -0,0 +1,10 @@
|
||||
/**
|
||||
* The <code>org.jooq.tools.csv</code> package contains parts of OpenCSV
|
||||
* <p>
|
||||
* jOOQ has no external dependencies. Nevertheless, some libraries that are
|
||||
* compatible with jOOQ's Apache License 2.0 are embedded into jOOQ. See the
|
||||
* OpenCSV website for more details about OpenCSV:
|
||||
* <p>
|
||||
* <a href="http://opencsv.sourceforge.net/">http://opencsv.sourceforge.net/</a>
|
||||
*/
|
||||
package org.jooq.tools.csv;
|
||||
5
jOOQ/src/main/java/org/jooq/tools/jdbc/package-info.java
Normal file
5
jOOQ/src/main/java/org/jooq/tools/jdbc/package-info.java
Normal file
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.tools.jdbc</code> package contains compatibility classes
|
||||
* to bridge between JDBC 4.0 and JDBC 4.1
|
||||
*/
|
||||
package org.jooq.tools.jdbc;
|
||||
10
jOOQ/src/main/java/org/jooq/tools/json/package-info.java
Normal file
10
jOOQ/src/main/java/org/jooq/tools/json/package-info.java
Normal file
@ -0,0 +1,10 @@
|
||||
/**
|
||||
* The <code>org.jooq.tools.json</code> package contains parts of JSON Simple
|
||||
* <p>
|
||||
* jOOQ has no external dependencies. Nevertheless, some libraries that are
|
||||
* compatible with jOOQ's Apache License 2.0 are embedded into jOOQ. See the
|
||||
* JSON Simple website for more details about JSON Simple:
|
||||
* <p>
|
||||
* <a href="http://code.google.com/p/json-simple/">http://code.google.com/p/json-simple/</a>
|
||||
*/
|
||||
package org.jooq.tools.json;
|
||||
4
jOOQ/src/main/java/org/jooq/tools/package-info.java
Normal file
4
jOOQ/src/main/java/org/jooq/tools/package-info.java
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* The <code>org.jooq.tools</code> package contains jOOQ's public utilities
|
||||
*/
|
||||
package org.jooq.tools;
|
||||
10
jOOQ/src/main/java/org/jooq/tools/reflect/package-info.java
Normal file
10
jOOQ/src/main/java/org/jooq/tools/reflect/package-info.java
Normal file
@ -0,0 +1,10 @@
|
||||
/**
|
||||
* The <code>org.jooq.tools.reflect</code> package contains parts of jOOR
|
||||
* <p>
|
||||
* jOOQ has no external dependencies. Nevertheless, some libraries that are
|
||||
* compatible with jOOQ's Apache License 2.0 are embedded into jOOQ. See the
|
||||
* jOOR website for more details about jOOR:
|
||||
* <p>
|
||||
* <a href="http://code.google.com/p/joor/">http://code.google.com/p/joor/</a>
|
||||
*/
|
||||
package org.jooq.tools.reflect;
|
||||
10
jOOQ/src/main/java/org/jooq/tools/unsigned/package-info.java
Normal file
10
jOOQ/src/main/java/org/jooq/tools/unsigned/package-info.java
Normal file
@ -0,0 +1,10 @@
|
||||
/**
|
||||
* The <code>org.jooq.tools.unsigned</code> package contains parts of jOOU
|
||||
* <p>
|
||||
* jOOQ has no external dependencies. Nevertheless, some libraries that are
|
||||
* compatible with jOOQ's Apache License 2.0 are embedded into jOOQ. See the
|
||||
* jOOU website for more details about jOOU:
|
||||
* <p>
|
||||
* <a href="http://code.google.com/p/joou/">http://code.google.com/p/joou/</a>
|
||||
*/
|
||||
package org.jooq.tools.unsigned;
|
||||
8
jOOQ/src/main/java/org/jooq/types/package-info.java
Normal file
8
jOOQ/src/main/java/org/jooq/types/package-info.java
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* The <code>org.jooq.tools.types</code> package contains data types that are
|
||||
* missing in JDBC
|
||||
* <p>
|
||||
* JDBC is missing some important SQL data types, such as INTERVAL types, or
|
||||
* UNSIGNED NUMBER types. These are provided here in this package by jOOQ
|
||||
*/
|
||||
package org.jooq.types;
|
||||
5
jOOQ/src/main/java/org/jooq/util/ase/package-info.java
Normal file
5
jOOQ/src/main/java/org/jooq/util/ase/package-info.java
Normal file
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#CUBRID} dialect
|
||||
*/
|
||||
package org.jooq.util.ase;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#ASE} dialect
|
||||
*/
|
||||
package org.jooq.util.cubrid;
|
||||
5
jOOQ/src/main/java/org/jooq/util/db2/package-info.java
Normal file
5
jOOQ/src/main/java/org/jooq/util/db2/package-info.java
Normal file
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#DB2} dialect
|
||||
*/
|
||||
package org.jooq.util.db2;
|
||||
5
jOOQ/src/main/java/org/jooq/util/derby/package-info.java
Normal file
5
jOOQ/src/main/java/org/jooq/util/derby/package-info.java
Normal file
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#DERBY} dialect
|
||||
*/
|
||||
package org.jooq.util.derby;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#FIREBIRD} dialect
|
||||
*/
|
||||
package org.jooq.util.firebird;
|
||||
5
jOOQ/src/main/java/org/jooq/util/h2/package-info.java
Normal file
5
jOOQ/src/main/java/org/jooq/util/h2/package-info.java
Normal file
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#H2} dialect
|
||||
*/
|
||||
package org.jooq.util.h2;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#HSQLDB} dialect
|
||||
*/
|
||||
package org.jooq.util.hsqldb;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#INGRES} dialect
|
||||
*/
|
||||
package org.jooq.util.ingres;
|
||||
5
jOOQ/src/main/java/org/jooq/util/mysql/package-info.java
Normal file
5
jOOQ/src/main/java/org/jooq/util/mysql/package-info.java
Normal file
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#ORACLE} dialect
|
||||
*/
|
||||
package org.jooq.util.mysql;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#MYSQL} dialect
|
||||
*/
|
||||
package org.jooq.util.oracle;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#POSTGRES} dialect
|
||||
*/
|
||||
package org.jooq.util.postgres;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#SQLITE} dialect
|
||||
*/
|
||||
package org.jooq.util.sqlite;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#SQLSERVER} dialect
|
||||
*/
|
||||
package org.jooq.util.sqlserver;
|
||||
@ -0,0 +1,5 @@
|
||||
/**
|
||||
* The <code>org.jooq.util.ase</code> package contains classes related to the
|
||||
* {@link org.jooq.SQLDialect#SYBASE} dialect
|
||||
*/
|
||||
package org.jooq.util.sybase;
|
||||
Loading…
Reference in New Issue
Block a user