Add JS doc to indicate that the function may throw an error.

2017-07-28 16:19:20 +01:00
parent a901ca5308
commit 6f57fe96f2
1 changed files with 1 additions and 0 deletions
--- a/src/WidgetUtils.js
+++ b/src/WidgetUtils.js
@@ -21,6 +21,7 @@ export default class WidgetUtils {
    /* Returns true if user is able to send state events to modify widgets in this room
     * @param roomId -- The ID of the room to check
     * @return Boolean -- true if the user can modify widgets in this room
+     * @throws Error -- specifies the error reason
     */
    static canUserModifyWidgets(roomId) {
        if (!roomId) {