Skip to content

Commit 31f64e7

Browse files
committed
Reformat comments based on JSDoc
1 parent 734c0e3 commit 31f64e7

File tree

1 file changed

+32
-16
lines changed
  • tools/snippets/benchmark/c/cephes

1 file changed

+32
-16
lines changed

tools/snippets/benchmark/c/cephes/Makefile

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -73,39 +73,55 @@ endif
7373
c_targets := benchmark.out
7474

7575

76-
# TARGETS #
76+
# RULES #
7777

78-
# Default target.
78+
#/
79+
# Compiles C source files.
7980
#
80-
# This target is the default target.
81-
81+
# @param {string} CEPHES_SRC - list of Cephes source files
82+
# @param {string} [C_COMPILER] - C compiler
83+
# @param {string} [CFLAGS] - C compiler flags
84+
# @param {(string|void)} [fPIC] - flag indicating whether to generate position independent code
85+
#
86+
# @example
87+
# make
88+
#
89+
# @example
90+
# make all
91+
#/
8292
all: $(c_targets)
8393

8494
.PHONY: all
8595

86-
87-
# Compile C source.
96+
#/
97+
# Compiles C source files.
8898
#
89-
# This target compiles C source files.
90-
99+
# @private
100+
# @param {string} CC - C compiler
101+
# @param {string} CFLAGS - C compiler flags
102+
# @param {(string|void)} fPIC - flag indicating whether to generate position independent code
103+
# @param {string} CEPHES_SRC - list of Cephes source files
104+
#/
91105
$(c_targets): %.out: %.c
92106
$(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $(CEPHES_SRC) $< -lm
93107

94-
95-
# Run a benchmark.
108+
#/
109+
# Runs compiled benchmarks.
96110
#
97-
# This target runs a benchmark.
98-
111+
# @example
112+
# make run
113+
#/
99114
run: $(c_targets)
100115
$(QUIET) ./$<
101116

102117
.PHONY: run
103118

104-
105-
# Perform clean-up.
119+
#/
120+
# Removes generated files.
106121
#
107-
# This target removes generated files.
108-
122+
# @example
123+
# make clean
124+
#/
109125
clean:
110126
$(QUIET) -rm -f *.o *.out
111127

0 commit comments

Comments
 (0)