Skip to content

Commit 85732f6

Browse files
kgrytekgryte
committed
Update source docs
1 parent 7174ff8 commit 85732f6

1 file changed

Lines changed: 24 additions & 15 deletions

File tree

‎tools/make/lib/init/eslint.mk‎

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,16 @@ BROWSERIFY_STDLIB_CUSTOM_ESLINT_RULES_PLUGIN_FLAGS ?= \
3939

4040
# RULES #
4141

42-
# Initialize custom ESLint rules.
42+
#/
43+
# Initializes custom ESLint rules.
4344
#
44-
# This target bundles a custom ESLint rules plugin as a node module and installs the plugin in the `node_modules` directory.
45-
45+
# ## Notes
46+
#
47+
# - This rule bundles a custom ESLint rules plugin as a node module and installs the plugin in the project `node_modules` directory.
48+
#
49+
# @example
50+
# make init-stdlib-custom-eslint-rules-plugin
51+
#/
4652
init-stdlib-custom-eslint-rules-plugin: $(NODE_MODULES)
4753
$(QUIET) $(MKDIR_RECURSIVE) $(STDLIB_CUSTOM_ESLINT_RULES_PLUGIN_OUT)
4854
$(QUIET) NODE_PATH="$(NODE_PATH)" \
@@ -52,30 +58,33 @@ init-stdlib-custom-eslint-rules-plugin: $(NODE_MODULES)
5258

5359
.PHONY: init-stdlib-custom-eslint-rules-plugin
5460

55-
56-
# Initialize custom ESLint plugins.
61+
#/
62+
# Initializes custom ESLint plugins.
5763
#
58-
# This target initializes custom ESLint plugins specific to the project.
59-
64+
# @example
65+
# make init-stdlib-custom-eslint-plugins
66+
#/
6067
init-stdlib-custom-eslint-plugins: init-stdlib-custom-eslint-rules-plugin
6168

6269
.PHONY: init-stdlib-custom-eslint-plugins
6370

64-
65-
# Remove custom ESLint rules plugin.
71+
#/
72+
# Removes a custom ESLint rule plugin.
6673
#
67-
# This target cleans up a custom ESLint rules plugin by removing the plugin directory.
68-
74+
# @example
75+
# make clean-stdlib-custom-eslint-rules-plugin
76+
#/
6977
clean-stdlib-custom-eslint-rules-plugin:
7078
$(QUIET) $(DELETE) $(DELETE_FLAGS) $(STDLIB_CUSTOM_ESLINT_RULES_PLUGIN_OUT)
7179

7280
.PHONY: clean-stdlib-custom-eslint-rules-plugin
7381

74-
75-
# Remove custom ESLint plugin directories.
82+
#/
83+
# Removes custom ESLint plugins.
7684
#
77-
# This target cleans up custom ESLint plugin directories by removing them entirely.
78-
85+
# @example
86+
# make clean-stdlib-custom-eslint-plugins
87+
#/
7988
clean-stdlib-custom-eslint-plugins: clean-stdlib-custom-eslint-rules-plugin
8089

8190
.PHONY: clean-stdlib-custom-eslint-plugins

0 commit comments

Comments
 (0)