Mention logging.properties in handler-related javadoc

mziccard · mziccard · commit 60a00b37a3bd · 2016-07-19T12:56:05.000+02:00
diff --git a/gcloud-java-examples/src/main/java/com/google/cloud/examples/logging/snippets/AddLoggingHandler.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/logging/snippets/AddLoggingHandler.java
@@ -24,7 +24,10 @@
  * A snippet showing how to use {@link java.util.logging.Logger} to log entries to Stackdriver
  * Logging. The snippet shows how to install a Stackdriver Logging handler using
  * {@link com.google.cloud.logging.LoggingHandler#addHandler(Logger, LoggingHandler)}. Notice that
- * this could also be done through the {@code logging.properties} file.
+ * this could also be done through the {@code logging.properties} file, adding the following line:
+ * <pre>
+ * {@code com.google.cloud.examples.logging.snippets.AddLoggingHandler.handlers=com.google.cloud.logging.LoggingHandler}
+ * </pre>
  */
 public class AddLoggingHandler {
 
diff --git a/gcloud-java-logging/src/main/java/com/google/cloud/logging/AsyncLoggingHandler.java b/gcloud-java-logging/src/main/java/com/google/cloud/logging/AsyncLoggingHandler.java
@@ -70,7 +70,11 @@
  * </ul>
  *
  * <p>To add a {@code LoggingHandler} to an existing {@link Logger} and be sure to avoid infinite
- * recursion when logging, use the {@link #addHandler(Logger, LoggingHandler)} method.
+ * recursion when logging, use the {@link #addHandler(Logger, LoggingHandler)} method. Alternatively
+ * you can add the handler via {@code logging.properties}. For example using the following line:
+ * <pre>
+ * {@code com.example.mypackage.handlers=com.google.cloud.logging.AsyncLoggingHandler}
+ * </pre>
  */
 public class AsyncLoggingHandler extends LoggingHandler {
 
diff --git a/gcloud-java-logging/src/main/java/com/google/cloud/logging/LoggingHandler.java b/gcloud-java-logging/src/main/java/com/google/cloud/logging/LoggingHandler.java
@@ -83,7 +83,11 @@
  * </ul>
  *
  * <p>To add a {@code LoggingHandler} to an existing {@link Logger} and be sure to avoid infinite
- * recursion when logging, use the {@link #addHandler(Logger, LoggingHandler)} method.
+ * recursion when logging, use the {@link #addHandler(Logger, LoggingHandler)} method. Alternatively
+ * you can add the handler via {@code logging.properties}. For example using the following line:
+ * <pre>
+ * {@code com.example.mypackage.handlers=com.google.cloud.logging.LoggingHandler}
+ * </pre>
  */
 public class LoggingHandler extends Handler {
 
