From 8ec05997a4c0ccdbf2e9c9bfc15ea74e3759ab64 Mon Sep 17 00:00:00 2001
From: azu <azuciao@gmail.com>
Date: Fri, 25 Mar 2016 14:04:45 +0900
Subject: [PATCH] docs(src): add description to function

---
 src/suitcss-classnames.js | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/src/suitcss-classnames.js b/src/suitcss-classnames.js
index bc3b7fd..a20d731 100644
--- 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) {