From 4f52061b51325d8de189eb2cb1c1272b2740b8f8 Mon Sep 17 00:00:00 2001
From: RoboErik <epastern@google.com>
Date: Mon, 19 Sep 2011 17:47:53 -0700
Subject: Add a warning to changing colors in the docs

Change-Id: Ia1fdfd5e2c31c5665fb08ccc389957b6af6f3736
---
 core/java/android/provider/CalendarContract.java | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'core/java/android')

diff --git a/core/java/android/provider/CalendarContract.java b/core/java/android/provider/CalendarContract.java
index 9ba1fdb..4b4d308 100644
--- a/core/java/android/provider/CalendarContract.java
+++ b/core/java/android/provider/CalendarContract.java
@@ -292,7 +292,9 @@ public final class CalendarContract {
      */
     protected interface CalendarColumns {
         /**
-         * The color of the calendar
+         * The color of the calendar. This should only be updated by the sync
+         * adapter, not other apps, as changing a calendar's color can adversely
+         * affect its display.
          * <P>Type: INTEGER (color value)</P>
          */
         public static final String CALENDAR_COLOR = "calendar_color";
@@ -551,7 +553,6 @@ public final class CalendarContract {
      * <ul>
      * <li>{@link #NAME}</li>
      * <li>{@link #CALENDAR_DISPLAY_NAME}</li>
-     * <li>{@link #CALENDAR_COLOR}</li>
      * <li>{@link #VISIBLE}</li>
      * <li>{@link #SYNC_EVENTS}</li>
      * </ul>
@@ -559,6 +560,7 @@ public final class CalendarContract {
      * <ul>
      * <li>{@link #ACCOUNT_NAME}</li>
      * <li>{@link #ACCOUNT_TYPE}</li>
+     * <li>{@link #CALENDAR_COLOR}</li>
      * <li>{@link #_SYNC_ID}</li>
      * <li>{@link #DIRTY}</li>
      * <li>{@link #OWNER_ACCOUNT}</li>
@@ -785,7 +787,8 @@ public final class CalendarContract {
         public static final String EVENT_LOCATION = "eventLocation";
 
         /**
-         * A secondary color for the individual event. Column name.
+         * A secondary color for the individual event. Reserved for future use.
+         * Column name.
          * <P>Type: INTEGER</P>
          */
         public static final String EVENT_COLOR = "eventColor";
-- 
cgit v1.1