Merge pull request #221 from nhnent/feat/apply-tuidoc/change-annotation

feat: change annotations for typedef object description (close #220)

src/js/factory/calendar.js

@@ -108,9 +108,9 @@ var mmin = Math.min;
 
 /**
  * @typedef {object} CalendarColor
- * @property {string} [CalendarColor.color] - calendar color
- * @property {string} [CalendarColor.bgColor] - calendar background color
- * @property {string} [CalendarColor.borderColor] - calendar left border color
+ * @property {string} [color] - calendar color
+ * @property {string} [bgColor] - calendar background color
+ * @property {string} [borderColor] - calendar left border color
  */
 
 /**
@@ -145,16 +145,16 @@ var mmin = Math.min;
  * @property {Array.<Calendar>} [calendars=[]] - list of Calendars that can be used to add new schedule
  * @property {boolean} [useCreationPopup=false] - whether use default creation popup or not
  * @property {boolean} [useDetailPopup=false] - whether use default detail popup or not
- * @property {Array.<Timezone>} [timezones] - timezone array. 
+ * @property {Array.<Timezone>} [timezones] - timezone array.
  *  The first Timezone element is primary and can override Calendar#setTimezoneOffset function.
  *  The rest timezone elements are shown in left timegrid of weekly/daily view.
  * @property {boolean} [disableDblClick=false] - disable double click to create a schedule
  * @property {boolean} [isReadOnly=false] - Calendar is read-only mode and a user can't create and modify any schedule.
  */
 
 /**
- * @typedef {class} CustomEvents
  * {@link https://nhnent.github.io/tui.code-snippet/latest/tui.util.CustomEvents.html CustomEvents} document at {@link https://github.com/nhnent/tui.code-snippet tui-code-snippet}
+ * @typedef {class} CustomEvents
  */
 
 /**
@@ -1113,7 +1113,7 @@ Calendar.prototype._onAfterRenderSchedule = function(scheduleData) {
      * Fire this event by every single schedule after rendering whole calendar.
      * @event Calendar#afterRenderSchedule
      * @type {object}
-     * @property {Schedule} schedule - a rendered schedule instance 
+     * @property {Schedule} schedule - a rendered schedule instance
      * @example
      * calendar.on('afterRenderSchedule', function(event) {
      *     var schedule = event.schedule;
@@ -1214,7 +1214,7 @@ Calendar.prototype._toggleViewSchedule = function(isAttach, view) {
  * calendar.setOptions({week: {startDayOfWeek: 1}}, true);
  * calendar.setOptions({month: {startDayOfWeek: 1}}, true);
  * calendar.changeView(calendar.getViewName(), true);
- * 
+ *
  * // work week
  * calendar.setOptions({week: {workweek: true}}, true);
  * calendar.setOptions({month: {workweek: true}}, true);

src/js/theme/themeConfig.js

@@ -5,11 +5,11 @@
 'use strict';
 
 /**
- * @typedef {object} themeConfig
- * Full configuration for theme.<br>
- * "common" prefix is for entire calendar. "common" properties can be overriden by "week", "month".<br>
- * "week" prefix is for weekly and daily view.<br>
+ * Full configuration for theme.
+ * "common" prefix is for entire calendar. "common" properties can be overriden by "week", "month".
+ * "week" prefix is for weekly and daily view.
  * "month" prefix is for monthly view.
+ * @typedef {object} themeConfig
  * @example
  // default keys and styles
  var themeConfig = {