Skip to content

Commit cda99da

Browse files
committed
Reformat comments based on JSDoc
1 parent 61113a5 commit cda99da

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

tools/snippets/benchmark/c/Makefile

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -67,39 +67,53 @@ endif
6767
c_targets := benchmark.out
6868

6969

70-
# TARGETS #
70+
# RULES #
7171

72-
# Default target.
72+
#/
73+
# Compiles C source files.
7374
#
74-
# This target is the default target.
75-
75+
# @param {string} [C_COMPILER] - C compiler
76+
# @param {string} [CFLAGS] - C compiler flags
77+
# @param {(string|void)} [fPIC] - flag indicating whether to generate position independent code
78+
#
79+
# @example
80+
# make
81+
#
82+
# @example
83+
# make all
84+
#/
7685
all: $(c_targets)
7786

7887
.PHONY: all
7988

80-
81-
# Compile C source.
89+
#/
90+
# Compiles C source files.
8291
#
83-
# This target compiles C source files.
84-
92+
# @private
93+
# @param {string} CC - C compiler
94+
# @param {string} CFLAGS - C compiler flags
95+
# @param {(string|void)} fPIC - flag indicating whether to generate position independent code
96+
#/
8597
$(c_targets): %.out: %.c
8698
$(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $< -lm
8799

88-
89-
# Run a benchmark.
100+
#/
101+
# Runs compiled benchmarks.
90102
#
91-
# This target runs a benchmark.
92-
103+
# @example
104+
# make run
105+
#/
93106
run: $(c_targets)
94107
$(QUIET) ./$<
95108

96109
.PHONY: run
97110

98-
99-
# Perform clean-up.
111+
#/
112+
# Removes generated files.
100113
#
101-
# This target removes generated files.
102-
114+
# @example
115+
# make clean
116+
#/
103117
clean:
104118
$(QUIET) -rm -f *.o *.out
105119

0 commit comments

Comments
 (0)