updated doc comments

UnderlineWords · UnderlineWords · commit 7487dc78f3e7 · 2023-03-29T23:20:47.000+03:00
diff --git a/src/Components/Alert/variables.scss b/src/Components/Alert/variables.scss
@@ -4,7 +4,7 @@
 
 /// STYLES ==============================================
 $alert-styles: (
-	// style name, theme variable
+	// style name (class), theme variable
 	"primary"	: theme('color', 'primary'),
 	"success"	: theme('color', 'success'),
 	"warning"	: theme('color', 'warning'),
@@ -15,12 +15,12 @@ $alert-styles: (
 /// SIZES ===============================================
 $alert-sizes: (
     (
-    	"small", // size name
+    	"small", // size name (class)
     	.749rem, // font-size
     	.4rem // padding
     ),
     (
-    	"large", // size name
+    	"large", // size name (class)
     	1.1rem, // font-size
     	.8rem // padding
     )
diff --git a/src/Components/Badge/variables.scss b/src/Components/Badge/variables.scss
@@ -4,6 +4,7 @@
 
 /// STYLES ==============================================
 $badge-styles: (
+	// style name (class), theme variable
 	"primary"	: theme('color', 'primary'),
 	"success"	: theme('color', 'success'),
 	"warning"	: theme('color', 'warning'),
@@ -14,17 +15,17 @@ $badge-styles: (
 /// SIZES ===============================================
 $badge-sizes: (
     (
-		"tiny", // size name
+		"tiny", // size name (class)
 		.659rem!important, // font-size
 		0 4px!important // padding
     ),
     (
-    	"small", // size name
+    	"small", // size name (class)
     	.749rem!important, // font-size
     	1px 4px!important // padding
     ),
     (
-    	"large", // size name
+    	"large", // size name (class)
     	1.1rem!important, // font-size
     	2px 8px!important // padding
     )
diff --git a/src/Components/Billboard/variables.scss b/src/Components/Billboard/variables.scss
@@ -4,6 +4,7 @@
 
 /// STYLES ==============================================
 $billboard-styles: (
+	// style name (class), theme variable
 	"primary"	: theme('color', 'primary'),
 	"success"	: theme('color', 'success'),
 	"warning"	: theme('color', 'warning'),
@@ -14,24 +15,24 @@ $billboard-styles: (
 /// SIZES ===============================================
 $billboard-sizes: (
 	(
-		"small", // size name
+		"small", // size name (class)
 		2.5rem 1.5rem, // padding
 		1em // font-size
 	),
 	(
-		"large", // size name
+		"large", // size name (class)
 		7.5rem 4rem, // padding
 		1.6em // font-size
 	)
 );
 $billboard-responsive-sizes	: ( 
 	(
-		"small", // size name
+		"small", // size name (class)
 		1rem, // padding
 		1em // font-size
 	),
 	(
-		"large", // size name
+		"large", // size name (class)
 		1rem, // padding
 		1.358em // font-size
 	)
diff --git a/src/Components/Breadcrumb/variables.scss b/src/Components/Breadcrumb/variables.scss
@@ -5,13 +5,13 @@
 /// SIZES ===============================================
 $breadcrumb-sizes: (
     (
-    	'small', // size name
+    	'small', // size name (class)
     	.9589em, // font-size
     	.15em, // seperator-padding
     	1.25rem // seperator-size
     ),
     (
-    	'large', // size name
+    	'large', // size name (class)
     	1.18em, // font-size
     	.18em, // seperator-padding
     	1.7rem // seperator-size
diff --git a/src/Components/Navbar/variables.scss b/src/Components/Navbar/variables.scss
@@ -6,7 +6,7 @@
 // you can add your own custom styles.
 $navbar-themes: (
 	(
-		"light", // theme name
+		"light", // theme name (class)
 		white, // bg color
 		#303232, // text color
 		white, // input bg
@@ -15,7 +15,7 @@ $navbar-themes: (
 		theme('color', 'grey') // divider color
 	),
 	(
-		"dark", // theme name
+		"dark", // theme name (class)
 		theme('color', 'dark'), // bg color
 		theme('color', 'negative'), // text color
 		lighten(theme('color', 'dark'), 7%), // input bg
@@ -29,21 +29,21 @@ $navbar-themes: (
 // you can add your own custom sizes.
 $navbar-sizes: (
     (
-		"mini", // size name
+		"mini", // size name (class)
 		45px, // min-height
 		.9839em, // button font-size
 		.445rem .9rem, // button padding
 		70px // top spacer for navbar (min-height + 25px)
     ),
     (
-		"small", // size name
+		"small", // size name (class)
 		65px, // min-height
 		1em, // button font-size
 		.645rem 1.4rem, // button padding
 		90px // top spacer for navbar (min-height + 25px)
     ),
     (
-		"large", // size name
+		"large", // size name (class)
 		95px, // min-height
 		1.28em, // button font-size
 		.645rem 1.4rem, // button padding
diff --git a/src/Components/Panel/variables.scss b/src/Components/Panel/variables.scss
@@ -5,12 +5,12 @@
 /// SIZES ===============================================
 $panel-sizes: (
     (
-    	"mini", // size name
+    	"mini", // size name (class)
     	.985rem, // font-size (title)
     	4px 8px // padding (title/content/bottom)
     ),
     (
-    	"small", // size name
+    	"small", // size name (class)
     	1.038rem, // font-size (title)
     	8px 12px // padding (title/content/bottom)
     )
diff --git a/src/Components/Process/variables.scss b/src/Components/Process/variables.scss
@@ -3,8 +3,8 @@
 /////////////////////////////////////////////////////////
 
 /// STYLES ==============================================
-$process-styles	: (
-	// style name, color theme
+$process-styles: (
+	// style name (class), color theme
 	"success"	: theme('color', 'success'),
 	"warning"	: theme('color', 'warning'),
 	"error"		: theme('color', 'error'),
diff --git a/src/Components/Progress/variables.scss b/src/Components/Progress/variables.scss
@@ -3,7 +3,8 @@
 /////////////////////////////////////////////////////////
 
 /// STYLES ==============================================
-$progress-styles : (
+$progress-styles: (
+	// style name (class), color theme
 	"success"	: theme('color', 'success'),
 	"warning"	: theme('color', 'warning'),
 	"error"		: theme('color', 'error'),
diff --git a/src/Components/Stats/variables.scss b/src/Components/Stats/variables.scss
@@ -4,7 +4,7 @@
 
 /// STYLES ==============================================
 $stats-styles: (
-	// style name, theme variable
+	// style name (class), theme variable
 	"primary"	: theme('color', 'primary'),
 	"success"	: theme('color', 'success'),
 	"warning"	: theme('color', 'warning'),
diff --git a/src/Components/Tabnav/variables.scss b/src/Components/Tabnav/variables.scss
@@ -5,19 +5,19 @@
 /// STYLES ==============================================
 $tabnav-styles: (
 	(
-		'success', // style name
+		'success', // style name (class)
 		theme('color', 'success') // color
 	),
 	(
-		'warning', // style name
+		'warning', // style name (class)
 		theme('color', 'warning') // color
 	),
 	(
-		'error', // style name
+		'error', // style name (class)
 		theme('color', 'error') // color
 	),
 	(
-		'dark', // style name
+		'dark', // style name (class)
 		theme('color', 'text') // color
 	)
 );
diff --git a/src/Components/Timeline/variables.scss b/src/Components/Timeline/variables.scss
@@ -5,27 +5,27 @@
 /// STYLES ==============================================
 $timeline-styles: (
 	(
-		"primary", // style name
+		"primary", // style name (class)
 		theme('color', 'primary'), // bg color
 		theme('color', 'negative') // text color
 	),
 	(
-		"success", // style name
+		"success", // style name (class)
 		theme('color', 'success'), // bg color
 		theme('color', 'negative') // text color
 	),
 	(
-		"warning", // style name
+		"warning", // style name (class)
 		theme('color', 'warning'), // bg color
 		theme('color', 'negative') // text color
 	),
 	(
-		"error", // style name
+		"error", // style name (class)
 		theme('color', 'error'), // bg color
 		theme('color', 'negative') // text color
 	),
 	(
-		"dark", // style name
+		"dark", // style name (class)
 		theme('color', 'text'), // bg color
 		theme('color', 'grey') // text color
 	),
diff --git a/src/Elements/Button/variables.scss b/src/Elements/Button/variables.scss
@@ -5,27 +5,27 @@
 // SIZES ================================================
 $button-sizes: (
 	(
-		"tiny", // size name
+		"tiny", // size name (class)
 		.809em, // font-size
 		.415rem .5rem // padding
 	),
 	(
-		"mini", // size name
+		"mini", // size name (class)
 		.909em, // font-size
 		.445rem .9rem // padding
 	),
 	(
-		"small", // size name
+		"small", // size name (class)
 		.979em, // font-size
 		.645rem 1.4rem // padding
 	),
 	(
-		"large", // size name
+		"large", // size name (class)
 		1.25em, // font-size
 		1.15rem 2.1rem // padding
 	),
 	(
-		"huge", // size name
+		"huge", // size name (class)
 		1.45em, // font-size
 		1.3rem 2.4rem // padding
 	)
@@ -34,27 +34,27 @@ $button-sizes: (
 /// STYLES ==============================================
 $button-styles: (
 	(
-		'primary', // name
+		'primary', // class name
 		theme('color', 'primary'), // bg color
 		lighten(theme('color', 'primary'), 7%) // border color
 	),
 	(
-		'success', // name
+		'success', // class name
 		theme('color', 'success'), // bg color
 		lighten(theme('color', 'success'), 7%) // border color
 	),
 	(
-		'warning', // name
+		'warning', // class name
 		theme('color', 'warning'), // bg color
 		lighten(theme('color', 'warning'), 7%) // border color
 	),
 	(
-		'error', // name
+		'error', // class name
 		theme('color', 'error'), // bg color
 		lighten(theme('color', 'error'), 7%) // border color
 	),
 	(
-		'dark', // name
+		'dark', // class name
 		theme('color', 'dark'), // bg color
 		lighten(theme('color', 'dark'), 7%) // border color
 	)
diff --git a/src/Elements/Caption/variables.scss b/src/Elements/Caption/variables.scss
@@ -5,13 +5,13 @@
 /// SIZES =============================================== 
 $caption-sizes: (
     (
-    	"small", // size name
+    	"small", // size name (class)
     	1em .1rem, // margin
     	1.65rem, // font-size
     	theme('typography', 'font-weight') // font-weight
     ),
     (
-    	"large", // size name
+    	"large", // size name (class)
     	1.4em .3rem, // margin
     	2.35rem, // font-size
     	theme('typography', 'header-weight') // font-weight
diff --git a/src/Elements/Form/variables.scss b/src/Elements/Form/variables.scss
@@ -6,14 +6,14 @@
 // [*] referenced from button variables
 $form-input-sizes: (
 	(
-		'small', // name
+		'small', // class name
 		1em, // font-size
 		1.9rem, // input height
 		.645rem 1.4rem, // button padding[*]
 		.979em // button font size[*]
 	),
 	(
-		'large', // name
+		'large', // class name
 		1.2em, // font-size
 		2.9rem, // input height
 		1.15rem 2.1rem, // button padding[*]
@@ -25,11 +25,11 @@ $form-input-sizes: (
 // for input validations
 $form-input-styles: (
 	(
-		'success', // name
+		'success', // class name
 		theme('color', 'success') // color
 	),
 	(
-		'error', // name
+		'error', // class name
 		theme('color', 'error') // color
 	)
 );
diff --git a/src/Elements/Label/variables.scss b/src/Elements/Label/variables.scss
@@ -3,7 +3,8 @@
 /////////////////////////////////////////////////////////
 
 /// STYLES ==============================================
-$label-styles	: (
+$label-styles: (
+	// style name (class), theme variable
 	"primary"	: theme('color', 'primary'),
 	"success"	: theme('color', 'success'),
 	"warning"	: theme('color', 'warning'),
@@ -14,12 +15,12 @@ $label-styles	: (
 /// SIZES =============================================== 
 $label-sizes: (
     (
-    	"small", // size name
+    	"small", // size name (class)
     	.18rem .85rem, // padding
     	.8195em // font-size
     ),
     (
-    	"large", // size name
+    	"large", // size name (class)
     	.415rem 1.159rem, // padding
     	1em // font-size
     )
diff --git a/src/Elements/Typography/variables.scss b/src/Elements/Typography/variables.scss

Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,12 @@`
`5`	`5`	`/// SIZES ===============================================`
`6`	`6`	`$panel-sizes: (`
`7`	`7`	`(`
`8`		`- "mini", // size name`
	`8`	`+ "mini", // size name (class)`
`9`	`9`	`.985rem, // font-size (title)`
`10`	`10`	`4px 8px // padding (title/content/bottom)`
`11`	`11`	`),`
`12`	`12`	`(`
`13`		`- "small", // size name`
	`13`	`+ "small", // size name (class)`
`14`	`14`	`1.038rem, // font-size (title)`
`15`	`15`	`8px 12px // padding (title/content/bottom)`
`16`	`16`	`)`
Original file line number	Diff line number	Diff line change
`@@ -5,19 +5,19 @@`
`5`	`5`	`/// STYLES ==============================================`
`6`	`6`	`$tabnav-styles: (`
`7`	`7`	`(`
`8`		`- 'success', // style name`
	`8`	`+ 'success', // style name (class)`
`9`	`9`	`theme('color', 'success') // color`
`10`	`10`	`),`
`11`	`11`	`(`
`12`		`- 'warning', // style name`
	`12`	`+ 'warning', // style name (class)`
`13`	`13`	`theme('color', 'warning') // color`
`14`	`14`	`),`
`15`	`15`	`(`
`16`		`- 'error', // style name`
	`16`	`+ 'error', // style name (class)`
`17`	`17`	`theme('color', 'error') // color`
`18`	`18`	`),`
`19`	`19`	`(`
`20`		`- 'dark', // style name`
	`20`	`+ 'dark', // style name (class)`
`21`	`21`	`theme('color', 'text') // color`
`22`	`22`	`)`
`23`	`23`	`);`