[#1762] Add package-info.java to add Javadoc documentation to all

packages
This commit is contained in:
Lukas Eder 2012-08-30 20:34:21 +02:00
parent 549eb19ef4
commit 334cd69b19
25 changed files with 158 additions and 0 deletions

View 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;

View File

@ -0,0 +1,4 @@
/**
* The <code>org.jooq.exception</code> package contains jOOQ's exceptions
*/
package org.jooq.exception;

View 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;

View 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;

View 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;

View 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;

View 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;

View File

@ -0,0 +1,4 @@
/**
* The <code>org.jooq.tools</code> package contains jOOQ's public utilities
*/
package org.jooq.tools;

View 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;

View 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;

View 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;

View 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;

View File

@ -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;

View 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;

View 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;

View File

@ -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;

View 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;

View File

@ -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;

View File

@ -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;

View 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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;