Merge "Improve KeyboardShortcutInfo documentation for Modifiers" into nyc-dev

am: f48f390

* commit 'f48f390a60694df6f4b72bd0ac462dd19c5e1191':
  Improve KeyboardShortcutInfo documentation for Modifiers

Change-Id: I36a85346b9b5a8606b75cf670ddbc67ab9831377
This commit is contained in:
Clara Bayarri
2016-04-25 09:39:35 +00:00
committed by android-build-merger

View File

@@ -62,8 +62,9 @@ public final class KeyboardShortcutInfo implements Parcelable {
* defined in {@link KeyEvent}. * defined in {@link KeyEvent}.
* @param modifiers The set of modifiers that, combined with the key, trigger the shortcut. * @param modifiers The set of modifiers that, combined with the key, trigger the shortcut.
* These should be a combination of {@link KeyEvent#META_CTRL_ON}, * These should be a combination of {@link KeyEvent#META_CTRL_ON},
* {@link KeyEvent#META_SHIFT_ON}, {@link KeyEvent#META_META_ON} and * {@link KeyEvent#META_SHIFT_ON}, {@link KeyEvent#META_META_ON},
* {@link KeyEvent#META_ALT_ON}. * {@link KeyEvent#META_ALT_ON}, {@link KeyEvent#META_FUNCTION_ON} and
* {@link KeyEvent#META_SYM_ON}.
*/ */
public KeyboardShortcutInfo(CharSequence label, int keycode, int modifiers) { public KeyboardShortcutInfo(CharSequence label, int keycode, int modifiers) {
this(label, null, keycode, modifiers); this(label, null, keycode, modifiers);
@@ -74,8 +75,9 @@ public final class KeyboardShortcutInfo implements Parcelable {
* @param baseCharacter The character that triggers the shortcut. * @param baseCharacter The character that triggers the shortcut.
* @param modifiers The set of modifiers that, combined with the key, trigger the shortcut. * @param modifiers The set of modifiers that, combined with the key, trigger the shortcut.
* These should be a combination of {@link KeyEvent#META_CTRL_ON}, * These should be a combination of {@link KeyEvent#META_CTRL_ON},
* {@link KeyEvent#META_SHIFT_ON}, {@link KeyEvent#META_META_ON} and * {@link KeyEvent#META_SHIFT_ON}, {@link KeyEvent#META_META_ON},
* {@link KeyEvent#META_ALT_ON}. * {@link KeyEvent#META_ALT_ON}, {@link KeyEvent#META_FUNCTION_ON} and
* {@link KeyEvent#META_SYM_ON}.
*/ */
public KeyboardShortcutInfo(CharSequence label, char baseCharacter, int modifiers) { public KeyboardShortcutInfo(CharSequence label, char baseCharacter, int modifiers) {
mLabel = label; mLabel = label;
@@ -114,7 +116,8 @@ public final class KeyboardShortcutInfo implements Parcelable {
/** /**
* Returns the base keycode that, combined with the modifiers, triggers this shortcut. If the * Returns the base keycode that, combined with the modifiers, triggers this shortcut. If the
* base character was set instead, returns {@link KeyEvent#KEYCODE_UNKNOWN}. * base character was set instead, returns {@link KeyEvent#KEYCODE_UNKNOWN}. Valid keycodes are
* defined as constants in {@link KeyEvent}.
*/ */
public int getKeycode() { public int getKeycode() {
return mKeycode; return mKeycode;
@@ -129,7 +132,10 @@ public final class KeyboardShortcutInfo implements Parcelable {
} }
/** /**
* Returns the set of modifiers that, combined with the key, trigger this shortcut. * Returns the set of modifiers that, combined with the key, trigger this shortcut. These can
* be a combination of {@link KeyEvent#META_CTRL_ON}, {@link KeyEvent#META_SHIFT_ON},
* {@link KeyEvent#META_META_ON}, {@link KeyEvent#META_ALT_ON},
* {@link KeyEvent#META_FUNCTION_ON} and {@link KeyEvent#META_SYM_ON}.
*/ */
public int getModifiers() { public int getModifiers() {
return mModifiers; return mModifiers;