From e914d2d0376a7986ec3a434035e8df6f656be509 Mon Sep 17 00:00:00 2001
From: Lukas Eder <lukas.eder@gmail.com>
Date: Sat, 3 Mar 2012 13:17:29 +0000
Subject: [PATCH] Documented descending ordering by index

---
 jOOQ/src/main/java/org/jooq/OrderProvider.java  | 17 +++++++++++------
 .../main/java/org/jooq/SelectOrderByStep.java   |  4 ++++
 .../java/org/jooq/SimpleSelectOrderByStep.java  |  4 ++++
 3 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/jOOQ/src/main/java/org/jooq/OrderProvider.java b/jOOQ/src/main/java/org/jooq/OrderProvider.java
index 44454d3b4b..c1cb108b04 100644
--- a/jOOQ/src/main/java/org/jooq/OrderProvider.java
+++ b/jOOQ/src/main/java/org/jooq/OrderProvider.java
@@ -84,6 +84,10 @@ public interface OrderProvider {
      * Adds ordering fields
      * <p>
      * Indexes start at <code>1</code> in SQL!
+     * <p>
+     * Note, you can use <code>addOrderBy(Factory.val(1).desc())</code> or
+     * <code>addOrderBy(Factory.literal(1).desc())</code> to apply descending
+     * ordering
      *
      * @param fieldIndexes The ordering fields
      */
@@ -108,8 +112,9 @@ public interface OrderProvider {
      * <p>
      * If there is no <code>LIMIT</code> or <code>TOP</code> clause in your
      * RDBMS, or the <code>LIMIT</code> or <code>TOP</code> clause does not
-     * support bind values, this may be simulated with a <code>ROW_NUMBER()</code>
-     * window function and nested <code>SELECT</code> statements.
+     * support bind values, this may be simulated with a
+     * <code>ROW_NUMBER()</code> window function and nested <code>SELECT</code>
+     * statements.
      * <p>
      * This is the same as calling {@link #addLimit(int, int)} with offset = 0
      *
@@ -144,8 +149,8 @@ public interface OrderProvider {
      * If there is no <code>LIMIT</code> or <code>TOP</code> clause in your
      * RDBMS, or the <code>LIMIT</code> or <code>TOP</code> clause does not
      * support bind values, or if your RDBMS does not natively support offsets,
-     * this may be simulated with a <code>ROW_NUMBER()</code> window function and
-     * nested <code>SELECT</code> statements.
+     * this may be simulated with a <code>ROW_NUMBER()</code> window function
+     * and nested <code>SELECT</code> statements.
      *
      * @param offset The lowest offset starting at 0
      * @param numberOfRows The number of rows to return
@@ -162,8 +167,8 @@ public interface OrderProvider {
      * If there is no <code>LIMIT</code> or <code>TOP</code> clause in your
      * RDBMS, or the <code>LIMIT</code> or <code>TOP</code> clause does not
      * support bind values, or if your RDBMS does not natively support offsets,
-     * this may be simulated with a <code>ROW_NUMBER()</code> window function and
-     * nested <code>SELECT</code> statements.
+     * this may be simulated with a <code>ROW_NUMBER()</code> window function
+     * and nested <code>SELECT</code> statements.
      *
      * @param offset The lowest offset starting at 0
      * @param numberOfRows The number of rows to return
diff --git a/jOOQ/src/main/java/org/jooq/SelectOrderByStep.java b/jOOQ/src/main/java/org/jooq/SelectOrderByStep.java
index 4b1ad7c989..a4a7013ea6 100644
--- a/jOOQ/src/main/java/org/jooq/SelectOrderByStep.java
+++ b/jOOQ/src/main/java/org/jooq/SelectOrderByStep.java
@@ -103,6 +103,10 @@ public interface SelectOrderByStep extends SelectLimitStep {
      * Add an <code>ORDER BY</code> clause to the query
      * <p>
      * Indexes start at <code>1</code> in SQL!
+     * <p>
+     * Note, you can use <code>orderBy(Factory.val(1).desc())</code> or
+     * <code>orderBy(Factory.literal(1).desc())</code> to apply descending
+     * ordering
      */
     @Support
     SelectLimitStep orderBy(int... fieldIndexes);
diff --git a/jOOQ/src/main/java/org/jooq/SimpleSelectOrderByStep.java b/jOOQ/src/main/java/org/jooq/SimpleSelectOrderByStep.java
index 7c24374911..2333e9a0f8 100644
--- a/jOOQ/src/main/java/org/jooq/SimpleSelectOrderByStep.java
+++ b/jOOQ/src/main/java/org/jooq/SimpleSelectOrderByStep.java
@@ -80,6 +80,10 @@ public interface SimpleSelectOrderByStep<R extends Record> extends SimpleSelectL
      * Add an <code>ORDER BY</code> clause to the query
      * <p>
      * Indexes start at <code>1</code> in SQL!
+     * <p>
+     * Note, you can use <code>orderBy(Factory.val(1).desc())</code> or
+     * <code>orderBy(Factory.literal(1).desc())</code> to apply descending
+     * ordering
      */
     @Support
     SimpleSelectLimitStep<R> orderBy(int... fieldIndexes);