Reformat comments based on JSDoc and update description

kgryte · kgryte · commit 1999afa3ef24 · 2018-01-11T00:43:02.000-08:00
diff --git a/tools/make/lib/benchmark/Makefile b/tools/make/lib/benchmark/Makefile
@@ -12,19 +12,38 @@ include $(TOOLS_MAKE_LIB_DIR)/benchmark/r.mk
 
 # TARGETS #
 
-# Run benchmarks.
+#/
+# Runs benchmarks.
 #
-# This target runs benchmarks.
-
+# @param {string} [BENCHMARKS_FILTER] - file path pattern (e.g., `.*/blas/base/dasum/.*`)
+#
+# @example
+# make benchmark
+#
+# @example
+# make benchmark BENCHMARKS_FILTER=.*/blas/base/dasum/.*
+#/
 benchmark: benchmark-javascript
 
 .PHONY: benchmark
 
-
-# Run cross-language benchmarks.
+#/
+# Runs cross-language benchmarks.
 #
-# This target runs cross-language benchmarks.
-
+# ## Notes
+#
+# -   This recipe supports the environment variables supported by each language-specific (`benchmark-<lang>`) prerequisite.
+# -   This recipe is useful when wanting to glob for benchmark files, irrespective of language, for a particular package in order to compare cross-language performance.
+#
+#
+# @param {string} [BENCHMARKS_FILTER] - file path pattern (e.g., `.*/blas/base/dasum/.*`)
+#
+# @example
+# make benchmark-lang
+#
+# @example
+# make benchmark-lang BENCHMARKS_FILTER=.*/blas/base/dasum/.*
+#/
 benchmark-lang: benchmark-javascript benchmark-julia benchmark-python benchmark-r benchmark-c benchmark-cpp benchmark-fortran
 
 .PHONY: benchmark-lang
diff --git a/tools/make/lib/benchmark/README.md b/tools/make/lib/benchmark/README.md
@@ -51,7 +51,7 @@ Runs cross-language benchmarks.
 $ make benchmark-lang
 ```
 
-The recipe supports the environment variables for each language-specific (`benchmark-<lang>`) recipe documented below.
+The recipe supports the environment variables supported by each language-specific (`benchmark-<lang>`) recipe documented below.
 
 This recipe is useful when wanting to glob for benchmark files, irrespective of language, for a particular package in order to compare cross-language performance. 
 
