瀏覽代碼

Added error docs.

Piotrek Koszuliński 9 年之前
父節點
當前提交
1a0cd7d90f
共有 1 個文件被更改,包括 6 次插入0 次删除
  1. 6 0
      packages/ckeditor5-utils/src/keyboard.js

+ 6 - 0
packages/ckeditor5-utils/src/keyboard.js

@@ -45,6 +45,12 @@ export function getCode( key ) {
 		keyCode = keyNames[ key.toLowerCase() ];
 
 		if ( !keyCode ) {
+			/**
+			 * Unknown key name. Only key names contained by the {@link utils.keyboard.keyNames} can be used.
+			 *
+			 * @errror keyboard-unknown-key
+			 * @param {String} key
+			 */
 			throw new CKEditorError( 'keyboard-unknown-key: Unknown key name.', { key } );
 		}
 	} else {