diff options
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | include/gran/packet.h | 3 | ||||
| -rw-r--r-- | include/gran/snoop.h | 3 | ||||
| -rwxr-xr-x | scripts/warn-undocumented | 11 | ||||
| -rw-r--r-- | src/clock_domain.c | 6 | ||||
| -rw-r--r-- | src/main.c | 8 | ||||
| -rw-r--r-- | src/packet.c | 3 | ||||
| -rw-r--r-- | src/snoop.c | 3 | ||||
| -rw-r--r-- | tests/simple_riscv32/sim.c | 3 |
9 files changed, 37 insertions, 6 deletions
@@ -46,7 +46,8 @@ license: .PHONY: docs docs: - ./scripts/warn-undocumented + find src include -iname '*.[ch]' |\ + xargs -n 10 -P 0 ./scripts/warn-undocumented doxygen docs/doxygen.conf .PHONY: check diff --git a/include/gran/packet.h b/include/gran/packet.h index 25275f9..d18dfd6 100644 --- a/include/gran/packet.h +++ b/include/gran/packet.h @@ -1,3 +1,6 @@ +/* SPDX-License-Identifier: copyleft-next-0.3.1 */ +/* Copyright 2023 Kim Kuparinen < kimi.h.kuparinen@gmail.com > */ + #ifndef GRAN_PACKET_H #define GRAN_PACKET_H diff --git a/include/gran/snoop.h b/include/gran/snoop.h index 39c0e33..5254984 100644 --- a/include/gran/snoop.h +++ b/include/gran/snoop.h @@ -1,3 +1,6 @@ +/* SPDX-License-Identifier: copyleft-next-0.3.1 */ +/* Copyright 2023 Kim Kuparinen < kimi.h.kuparinen@gmail.com > */ + #ifndef GRAN_SNOOP_H #define GRAN_SNOOP_H diff --git a/scripts/warn-undocumented b/scripts/warn-undocumented index f1367bd..db22249 100755 --- a/scripts/warn-undocumented +++ b/scripts/warn-undocumented @@ -1,6 +1,7 @@ #!/bin/sh -# look through all files for either @file or \file, grep -c will report -# ./example.file:0 if it is not found. -find src -iname '*.[ch]' -exec \ - grep -c '[@\]file' {} \+ \ - | awk -F':' '$2 == 0 {print "Undocumented file:", $1}' +# look through all files for either @file or \file +for file in $@ +do + grep -c '[@\]file' "$file" |\ + awk -F':' "\$1 == 0 {print \"Undocumented file: $file\"}" +done diff --git a/src/clock_domain.c b/src/clock_domain.c index 15f1793..65dc72a 100644 --- a/src/clock_domain.c +++ b/src/clock_domain.c @@ -1,6 +1,12 @@ /* SPDX-License-Identifier: copyleft-next-0.3.1 */ /* Copyright 2023 Kim Kuparinen < kimi.h.kuparinen@gmail.com > */ +/** + * @file clock_domain.c + * + * Clock domain implementation stuff. + */ + #include <stdlib.h> #include <threads.h> #include <assert.h> @@ -1,6 +1,14 @@ /* SPDX-License-Identifier: copyleft-next-0.3.1 */ /* Copyright 2023 Kim Kuparinen < kimi.h.kuparinen@gmail.com > */ +/** + * @file main.c + * + * Empty main file, fill up with your simulator if you'd like. + * Although I really think gran should just be a library, why + * haven't I done this that way? + */ + int main(int argc, char **argv) { diff --git a/src/packet.c b/src/packet.c index c778965..9442307 100644 --- a/src/packet.c +++ b/src/packet.c @@ -1,3 +1,6 @@ +/* SPDX-License-Identifier: copyleft-next-0.3.1 */ +/* Copyright 2023 Kim Kuparinen < kimi.h.kuparinen@gmail.com > */ + #include <gran/packet.h> #include <stdlib.h> #include <assert.h> diff --git a/src/snoop.c b/src/snoop.c index 36ecd24..23970a8 100644 --- a/src/snoop.c +++ b/src/snoop.c @@ -1,3 +1,6 @@ +/* SPDX-License-Identifier: copyleft-next-0.3.1 */ +/* Copyright 2023 Kim Kuparinen < kimi.h.kuparinen@gmail.com > */ + #include <stdlib.h> #include <gran/snoop.h> diff --git a/tests/simple_riscv32/sim.c b/tests/simple_riscv32/sim.c index df2127d..fcf19a1 100644 --- a/tests/simple_riscv32/sim.c +++ b/tests/simple_riscv32/sim.c @@ -1,3 +1,6 @@ +/* SPDX-License-Identifier: copyleft-next-0.3.1 */ +/* Copyright 2023 Kim Kuparinen < kimi.h.kuparinen@gmail.com > */ + #include <assert.h> #include <gran/root.h> |