Skip to content

Commit c3022a5

Browse files
docs(SassDocs): Fix Warnings and Annotations (#12318)
* docs(SassDocs): Fix Warnings and Annotations Co-authored-by: Simeon Simeonoff <[email protected]>
1 parent 268f366 commit c3022a5

File tree

247 files changed

+968
-2544
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

247 files changed

+968
-2544
lines changed

projects/igniteui-angular/src/lib/core/styles/base/_functions.scss

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@
33
@use 'sass:list';
44
@use 'sass:string';
55

6-
////
76
/// @group Utilities
87
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
9-
////
10-
118
/// @access private
129
@function is-used($name, $checklist) {
1310
$used: true;

projects/igniteui-angular/src/lib/core/styles/components/action-strip/_action-strip-component.scss

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
@use '../../base' as *;
22
@use 'sass:string';
33

4-
////
5-
/// @group components
4+
/// @access private
65
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
7-
/// @requires {mixin} bem-block
8-
/// @requires {mixin} bem-elem
9-
/// @requires {mixin} bem-mod
10-
////
11-
126
@mixin component {
137
@include b(igx-action-strip) {
148
// Register the component in the component registry

projects/igniteui-angular/src/lib/core/styles/components/action-strip/_action-strip-theme.scss

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,10 @@
1818
/// @param {Color} $delete-action [null] - The color used for the delete icon in action strip component.
1919
/// @param {actions-border-radius} $actions-border-radius [null] - The border radius used for actions container inside action strip component.
2020
///
21-
/// @requires extend
22-
/// @requires digest-schema
23-
/// @requires text-contrast
24-
///
2521
/// @example scss Change the background and icon colors in action strip
2622
/// $my-action-strip-theme: action-strip-theme($background: black);
27-
/// // Pass the theme to the action-strip component mixin
28-
/// @include action-strip($my-action-strip-theme);
23+
/// // Pass the theme to the css-vars() mixin
24+
/// @include css-vars($my-action-strip-theme);
2925
@function action-strip-theme(
3026
$schema: $light-schema,
3127
@@ -65,9 +61,6 @@
6561
}
6662

6763
/// @param {Map} $theme - The theme used to style the component.
68-
/// @requires {mixin} css-vars
69-
/// @requires rem
70-
/// @requires var-get
7164
@mixin action-strip($theme) {
7265
@include css-vars($theme);
7366

projects/igniteui-angular/src/lib/core/styles/components/avatar/_avatar-component.scss

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
@use '../../base' as *;
22
@use 'sass:string';
33

4-
////
5-
/// @group components
4+
/// @access private
65
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
7-
/// @requires {mixin} bem-block
8-
/// @requires {mixin} bem-elem
9-
/// @requires {mixin} bem-mod
10-
////
116
@mixin component {
127
@include b(igx-avatar) {
138
// Register the component in the component registry

projects/igniteui-angular/src/lib/core/styles/components/avatar/_avatar-theme.scss

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,12 @@
1616
/// @param {Color} $background [null] - The background color used of the avatar.
1717
/// @param {number} $border-radius [null] - The border-radius used of the avatar.
1818
/// @param {number} $size [null] - The size of the avatar.
19-
/// @requires $default-palette
2019
/// @requires $light-schema
21-
/// @requires digest-schema
22-
/// @requires text-contrast
23-
/// @requires extend
2420
///
2521
/// @example scss Change the background and icon colors in icon avatars
2622
/// $my-avatar-theme: avatar-theme($icon-background: black, $icon-color: white);
27-
/// // Pass the theme to the avatar component mixin
28-
/// @include avatar($my-avatar-theme);
23+
/// // Pass the theme to the css-vars() mixin
24+
/// @include css-vars($my-avatar-theme);
2925
@function avatar-theme(
3026
$schema: $light-schema,
3127
$background: null,
@@ -62,9 +58,6 @@
6258
}
6359

6460
/// @param {Map} $theme - The theme used to style the component.
65-
/// @requires {mixin} css-vars
66-
/// @requires rem
67-
/// @requires var-get
6861
@mixin avatar($theme) {
6962
@include css-vars($theme);
7063

projects/igniteui-angular/src/lib/core/styles/components/badge/_badge-component.scss

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
@use '../../base' as *;
22
@use 'sass:string';
33

4-
////
5-
/// @group components
4+
/// @access private
65
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
7-
/// @requires {mixin} bem-block
8-
/// @requires {mixin} bem-elem
9-
/// @requires {mixin} bem-mod
10-
////
11-
126
@mixin component {
137
@include b(igx-badge) {
148
$this: bem--selector-to-string(&);

projects/igniteui-angular/src/lib/core/styles/components/badge/_badge-theme.scss

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,10 @@
2323
/// @param {border-radius} $border-radius [null] - The border radius used for badge component.
2424
///
2525
/// @requires $light-schema
26-
/// @requires digest-schema
27-
/// @requires extend
28-
/// @requires elevation
29-
/// @requires text-contrast
30-
/// @requires rem
3126
///
3227
/// @example scss Change the text and icon colors in a badge
3328
/// $my-badge-theme: badge-theme($icon-color: black, $background-color: white);
34-
/// // IE Supported theme - Pass the theme to the badge component mixin
35-
/// @include badge($my-badge-theme);
36-
///
37-
/// // Theming using css variables (not supported in IE11):
29+
/// // Pass the theme to the css-vars() mixin
3830
/// @include css-vars($my-badge-theme);
3931
@function badge-theme(
4032
$schema: $light-schema,
@@ -91,10 +83,6 @@
9183
}
9284

9385
/// @param {Map} $theme - The theme used to style the component.
94-
/// @requires {mixin} css-vars
95-
/// @requires color
96-
/// @requires rem
97-
/// @requires var-get
9886
@mixin badge($theme) {
9987
@include css-vars($theme);
10088

projects/igniteui-angular/src/lib/core/styles/components/banner/_banner-component.scss

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
@use '../../base' as *;
22
@use 'sass:string';
33

4-
////
5-
/// @group components
4+
/// @access private
65
/// @author <a href="https://github.com/desig9stein" target="_blank">Marin Popov</a>
7-
/// @requires {mixin} bem-block
8-
/// @requires {mixin} bem-elem
9-
/// @requires {mixin} bem-mod
10-
////
11-
126
@mixin component {
137
@include b(igx-banner-host) {
148
@extend %igx-banner-host !optional;

projects/igniteui-angular/src/lib/core/styles/components/banner/_banner-theme.scss

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,11 @@
1818
/// @param {Color} $banner-illustration-color [null] - The color used banner illustration.
1919
///
2020
/// @requires $light-schema
21-
/// @requires digest-schema
22-
/// @requires text-contrast
23-
/// @requires extend
2421
///
2522
/// @example scss Change the background in banner
2623
/// $my-banner-theme: banner-theme($banner-background: #000);
27-
/// // Pass the theme to the banner component mixin
28-
/// @include banner($my-banner-theme);
24+
/// // Pass the theme to the css-vars() mixin
25+
/// @include css-vars($my-banner-theme);
2926
@function banner-theme(
3027
$schema: $light-schema,
3128
$banner-background: null,
@@ -60,9 +57,6 @@
6057
}
6158

6259
/// @param {Map} $theme - The theme used to style the component.
63-
/// @requires {mixin} css-vars
64-
/// @requires rem
65-
/// @requires var-get
6660
@mixin banner($theme) {
6761
@include css-vars($theme);
6862
$variant: map.get($theme, 'variant');
@@ -165,7 +159,6 @@
165159
/// Uses the 'body-2' category from the typographic scale.
166160
/// @group typography
167161
/// @param {Map} $categories [(message: 'body-2')] - The categories from the typographic scale used for type styles.
168-
/// @requires {mixin} type-style
169162
@mixin banner-typography($categories: (
170163
message: 'body-2')
171164
) {

projects/igniteui-angular/src/lib/core/styles/components/bottom-nav/_bottom-nav-component.scss

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
@use '../../base' as *;
22
@use 'sass:string';
33

4-
////
5-
/// @group components
4+
/// @access private
65
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
7-
/// @requires {mixin} bem-block
8-
/// @requires {mixin} bem-elem
9-
/// @requires {mixin} bem-mod
10-
////
11-
126
@mixin component {
137
@include b(igx-bottom-nav) {
148
$this: bem--selector-to-string(&);

0 commit comments

Comments
 (0)