docs(src): add description to function

dwango-js · Mar 25, 2016 · 8ec0599 · 8ec0599
1 parent 108f3ba
commit 8ec0599
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/src/suitcss-classnames.js b/src/suitcss-classnames.js
@@ -19,12 +19,14 @@ const DefaultSuitCSSObject = {
  *
  */
 /**
- *
+ * Create class names string from object.
+ * The option object should have `component` property.
+ * It it based name of the class names.
  * @param {{
- * namespace: string, descendant: ?string, component: ?string,
+ * namespace: ?string, descendant: ?string, component: string,
  * modifiers: (?string[] | ?Object), states: (?string[] | ?Object), utilities: (?string[] | ?Object)
  * }} suitCSSObject
- * @returns {string}
+ * @returns {string} class names string. it could be assigned to `class` attribute of element.
  */
 export default function suitClassNames(suitCSSObject) {
     if (suitCSSObject == null) {