Skip to content

Commit 22f9dc8

Browse files
authored
Use single-line syntax for private types comments (#8420)
This prevents the comments from appearing in editors
1 parent 33dff03 commit 22f9dc8

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

types/config.d.ts

+19-19
Original file line numberDiff line numberDiff line change
@@ -64,26 +64,26 @@ type ExperimentalConfig = Expand<'all' | Partial<Record<ExperimentalConfigValues
6464

6565
// DarkMode related config
6666
type DarkModeConfig =
67-
/** Use the `media` query strategy. */
67+
// Use the `media` query strategy.
6868
| 'media'
69-
/** Use the `class` stategy, which requires a `.dark` class on the `html`. */
69+
// Use the `class` stategy, which requires a `.dark` class on the `html`.
7070
| 'class'
71-
/** Use the `class` stategy with a custom class instead of `.dark`. */
71+
// Use the `class` stategy with a custom class instead of `.dark`.
7272
| ['class', string]
7373

7474
type Screen = { raw: string } | { min: string } | { max: string } | { min: string; max: string }
7575
type ScreensConfig = string[] | KeyValuePair<string, string | Screen | Screen[]>
7676

7777
// Theme related config
7878
interface ThemeConfig {
79-
/** Responsiveness */
79+
// Responsiveness
8080
screens: ResolvableTo<ScreensConfig>
8181

82-
/** Reusable base configs */
82+
// Reusable base configs
8383
colors: ResolvableTo<RecursiveKeyValuePair>
8484
spacing: ResolvableTo<KeyValuePair>
8585

86-
/** Components */
86+
// Components
8787
container: ResolvableTo<
8888
Partial<{
8989
screens: ScreensConfig
@@ -92,7 +92,7 @@ interface ThemeConfig {
9292
}>
9393
>
9494

95-
/** Utilities */
95+
// Utilities
9696
inset: ThemeConfig['spacing']
9797
zIndex: ResolvableTo<KeyValuePair>
9898
order: ResolvableTo<KeyValuePair>
@@ -215,7 +215,7 @@ interface ThemeConfig {
215215
willChange: ResolvableTo<KeyValuePair>
216216
content: ResolvableTo<KeyValuePair>
217217

218-
/** Custom */
218+
// Custom
219219
[key: string]: any
220220
}
221221

@@ -240,15 +240,15 @@ type ValueType =
240240
| 'relative-size'
241241
| 'shadow'
242242
export interface PluginAPI {
243-
/** for registering new static utility styles */
243+
// for registering new static utility styles
244244
addUtilities(
245245
utilities: RecursiveKeyValuePair | RecursiveKeyValuePair[],
246246
options?: Partial<{
247247
respectPrefix: boolean
248248
respectImportant: boolean
249249
}>
250250
): void
251-
/** for registering new dynamic utility styles */
251+
// for registering new dynamic utility styles
252252
matchUtilities<T>(
253253
utilities: KeyValuePair<string, (value: T) => RecursiveKeyValuePair>,
254254
options?: Partial<{
@@ -259,15 +259,15 @@ export interface PluginAPI {
259259
supportsNegativeValues: boolean
260260
}>
261261
): void
262-
/** for registering new static component styles */
262+
// for registering new static component styles
263263
addComponents(
264264
components: RecursiveKeyValuePair | RecursiveKeyValuePair[],
265265
options?: Partial<{
266266
respectPrefix: boolean
267267
respectImportant: boolean
268268
}>
269269
): void
270-
/** for registering new dynamic component styles */
270+
// for registering new dynamic component styles
271271
matchComponents<T>(
272272
components: KeyValuePair<string, (value: T) => RecursiveKeyValuePair>,
273273
options?: Partial<{
@@ -278,20 +278,20 @@ export interface PluginAPI {
278278
supportsNegativeValues: boolean
279279
}>
280280
): void
281-
/** for registering new base styles */
281+
// for registering new base styles
282282
addBase(base: RecursiveKeyValuePair | RecursiveKeyValuePair[]): void
283-
/** for registering custom variants */
283+
// for registering custom variants
284284
addVariant(name: string, definition: string | string[] | (() => string) | (() => string)[]): void
285-
/** for looking up values in the user’s theme configuration */
285+
// for looking up values in the user’s theme configuration
286286
theme: <TDefaultValue = Config['theme']>(
287287
path?: string,
288288
defaultValue?: TDefaultValue
289289
) => TDefaultValue
290-
/** for looking up values in the user’s Tailwind configuration */
290+
// for looking up values in the user’s Tailwind configuration
291291
config: <TDefaultValue = Config>(path?: string, defaultValue?: TDefaultValue) => TDefaultValue
292-
/** for checking if a core plugin is enabled */
292+
// for checking if a core plugin is enabled
293293
corePlugins(path: string): boolean
294-
/** for manually escaping strings meant to be used in class names */
294+
// for manually escaping strings meant to be used in class names
295295
e: (className: string) => string
296296
}
297297
export type PluginCreator = (api: PluginAPI) => void
@@ -318,7 +318,7 @@ interface OptionalConfig {
318318
theme: Partial<ThemeConfig & { extend: Partial<ThemeConfig> }>
319319
corePlugins: Partial<CorePluginsConfig>
320320
plugins: Partial<PluginsConfig>
321-
/** Custom */
321+
// Custom
322322
[key: string]: any
323323
}
324324

0 commit comments

Comments
 (0)