Skip to content

Commit d66288f

Browse files
kgrytekgryte
committed
Update source docs
1 parent c4f3361 commit d66288f

1 file changed

Lines changed: 35 additions & 27 deletions

File tree

  • tools/make/lib/licenses

‎tools/make/lib/licenses/ls.mk‎

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,12 @@
1818

1919
# RULES #
2020

21-
# List package licenses.
21+
#/
22+
# Lists the license for each package dependency in the package dependency tree.
2223
#
23-
# This target lists the license for each package dependency in the package dependency tree.
24-
24+
# @example
25+
# make list-licenses
26+
#/
2527
list-licenses: $(NODE_MODULES)
2628
$(QUIET) $(LIST_LICENSES) \
2729
--dir $(ROOT_DIR) \
@@ -31,11 +33,12 @@ list-licenses: $(NODE_MODULES)
3133

3234
.PHONY: list-licenses
3335

34-
35-
# List package licenses by group.
36+
#/
37+
# Groups the licenses of package dependencies by license type.
3638
#
37-
# This target groups the licenses of package dependencies by license type.
38-
39+
# @example
40+
# make list-licenses-group
41+
#/
3942
list-licenses-group: $(NODE_MODULES)
4043
$(QUIET) $(LIST_LICENSES) \
4144
--dir $(ROOT_DIR) \
@@ -45,11 +48,12 @@ list-licenses-group: $(NODE_MODULES)
4548

4649
.PHONY: list-licenses-group
4750

48-
49-
# List dependency licenses.
51+
#/
52+
# Lists the license for each root package dependency.
5053
#
51-
# This target lists the license for each root package dependency.
52-
54+
# @example
55+
# make list-deps-licenses
56+
#/
5357
list-deps-licenses: $(NODE_MODULES)
5458
$(QUIET) $(LIST_LICENSES) \
5559
--dir $(ROOT_DIR) \
@@ -60,11 +64,12 @@ list-deps-licenses: $(NODE_MODULES)
6064

6165
.PHONY: list-deps-licenses
6266

63-
64-
# List missing licenses.
67+
#/
68+
# Lists package dependencies missing license information.
6569
#
66-
# This target lists packages missing license information.
67-
70+
# @example
71+
# make list-missing-licenses
72+
#/
6873
list-missing-licenses: $(NODE_MODULES)
6974
$(QUIET) $(LIST_LICENSES) \
7075
--dir $(ROOT_DIR) \
@@ -74,11 +79,12 @@ list-missing-licenses: $(NODE_MODULES)
7479

7580
.PHONY: list-missing-licenses
7681

77-
78-
# List ambiguous licenses.
82+
#/
83+
# Lists package dependencies having ambiguous license information (e.g., conflicting or unknown licenses).
7984
#
80-
# This target lists packages having ambiguous license information.
81-
85+
# @example
86+
# make list-ambiguous-licenses
87+
#/
8288
list-ambiguous-licenses: $(NODE_MODULES)
8389
$(QUIET) $(LIST_LICENSES) \
8490
--dir $(ROOT_DIR) \
@@ -88,11 +94,12 @@ list-ambiguous-licenses: $(NODE_MODULES)
8894

8995
.PHONY: list-ambiguous-licenses
9096

91-
92-
# List excluded licenses.
97+
#/
98+
# Lists package dependencies having excluded license information (as determined by a license whitelist).
9399
#
94-
# This target lists packages excluded license information.
95-
100+
# @example
101+
# make list-excluded-licenses
102+
#/
96103
list-excluded-licenses: $(NODE_MODULES)
97104
$(QUIET) $(LIST_LICENSES) \
98105
--dir $(ROOT_DIR) \
@@ -103,11 +110,12 @@ list-excluded-licenses: $(NODE_MODULES)
103110

104111
.PHONY: list-excluded-licenses
105112

106-
107-
# Generate a license summary.
113+
#/
114+
# Prints a summary of package dependency license information.
108115
#
109-
# This target summaries package dependency license information.
110-
116+
# @example
117+
# make list-licenses-summary
118+
#/
111119
list-licenses-summary: $(NODE_MODULES)
112120
$(QUIET) $(LIST_LICENSES) \
113121
--dir $(ROOT_DIR) \

0 commit comments

Comments
 (0)