Add class comment to describe how to use OAuthParameters
Change-Id: I56fc2769a998342040009849f0e200bddaedd362
diff --git a/org.eclipse.userstorage.oauth/src/org/eclipse/userstorage/oauth/OAuthParameters.java b/org.eclipse.userstorage.oauth/src/org/eclipse/userstorage/oauth/OAuthParameters.java
index 2f31424..9131149 100644
--- a/org.eclipse.userstorage.oauth/src/org/eclipse/userstorage/oauth/OAuthParameters.java
+++ b/org.eclipse.userstorage.oauth/src/org/eclipse/userstorage/oauth/OAuthParameters.java
@@ -25,6 +25,22 @@
import java.util.Random;
/**
+ * An obfucscated encapsulation of OAuth parameters for USS. To use this
+ * class and launch the {@link #main()} method as a a Java application.
+ * Provide your OAuth Client ID and Secret, and the class will generate encoded
+ * values. Then decide on a service name, and subclass this class, and configure
+ * the required values. The encoded values can be (and are) decoded programmatically,
+ * which is acceptable since USS is not intended for private data.
+ * <p>
+ * The values can be overridden at runtime by setting the following properties:
+ * <ul>
+ * <li> OAuth Service: <tt><em>serviceName</em>.oauth.service</tt> (the authorization endpoint)
+ * <li> OAuth Client ID: <tt><em>serviceName</em>.oauth.client.id</tt>
+ * <li> OAuth Client Secret: <tt><em>serviceName</em>.oauth.client.secret</tt>
+ * <li> OAuth Callback: <tt><em>serviceName</em>.oauth.expected.callback</tt>
+ * <li> OAuth Callback: <tt><em>serviceName</em>.oauth.expected.callback</tt>
+ * </ul>
+ *
* @author Carsten Reckord
* @author Eike Stepper
*/
