Skip to content

Commit

Permalink
Experiment: partial migration to jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrian Vasiliu committed Mar 11, 2014
1 parent 09efc3a commit 9193e59
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion ScrollableContainer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/** @module deliteful/ScrollableContainer */
define([
"delite/register",
"delite/Container",
Expand All @@ -7,7 +8,18 @@ define([
// module:
// deliteful/ScrollableContainer

return register("d-scrollable-container", [HTMLElement, Container, Scrollable], {
/**
* @summary
* A container widget with scrolling capabilities.
* @description
* A container widget which can scroll its content
* horizontally and/or vertically. Its scrolling capabilities
* and API are provided by the mixin delite/Scrollable.
* @class module:deliteful/ScrollableContainer
* @augments {module:delite/Container}
* @augments {module:delite/Scrollable}
*/
return register("d-scrollable-container", [HTMLElement, Container, Scrollable], /** @lends module:deliteful/ScrollableContainer# */{
// summary:
// A container widget with scrolling capabilities.
// description:
Expand All @@ -23,6 +35,12 @@ define([

// baseClass: String
// The name of the CSS class of this widget.

/**
* The name of the CSS class of this widget.
* @type {string}
* @default "d-scrollable-container"
*/
baseClass: "d-scrollable-container"
});
});

0 comments on commit 9193e59

Please sign in to comment.