From 96e37a4f41691e60de7c480efa82e8f61f819777 Mon Sep 17 00:00:00 2001 From: Koen Zandberg Date: Wed, 25 Jan 2023 22:52:30 +0100 Subject: [PATCH] blobs: include documentation in doxygen --- doc/doxygen/riot.doxyfile | 1 + makefiles/blob.inc.mk | 59 ++++++++++++++++++++++----------------- 2 files changed, 34 insertions(+), 26 deletions(-) diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index cb56850175..0a8821f41b 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -778,6 +778,7 @@ INPUT = ../../doc.txt \ src/changelog.md \ ../../LOSTANDFOUND.md \ ../../makefiles/pseudomodules.inc.mk \ + ../../makefiles/blob.inc.mk \ ../../sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c # This tag can be used to specify the character encoding of the source files diff --git a/makefiles/blob.inc.mk b/makefiles/blob.inc.mk index c907fbe8b1..337b5b9983 100644 --- a/makefiles/blob.inc.mk +++ b/makefiles/blob.inc.mk @@ -1,29 +1,36 @@ -# -# makes any file in BLOBS available via '#include "blob/.h" -# -# # Usage: -# -# Add this to an application or module Makefile: -# -# BLOBS += foo.ext -# -# Then include in C file or header: -# -# #include "blob/foo.ext.h" -# -# The blob can then be accessed using the symbols "foo_ext" and "foo_ext_len". -# -# # Subfolders -# -# It is possible to add files from subfolders to BLOBS: -# -# BLOBS += subfolder/my_file.foo -# -# The subfolder will be part of the generated header's path, but *not* of the -# generated symbols. E.g., above blob would be made available by including -# "blobs/subfolder/my_file.ext.h", which would define the symbols "my_file_ext" -# and "my_file_ext_len". Beware possible symbol name clashes. -# +## @defgroup utils_blob Blob file module +## @ingroup utils +## @brief Include any file content as binary data in a RIOT application +## +## makes any file in BLOBS available via an include directive in the C code. +## +## # Usage: +## +## Add this to an application or module Makefile: +## +## ``` +## BLOBS += foo.ext +## ``` +## +## Then include in C file or header: +## +## ``` +## #include "blob/foo.ext.h" +## ``` +## +## The blob can then be accessed using the symbols "foo_ext" and "foo_ext_len". +## +## # Subfolders +## +## It is possible to add files from subfolders to BLOBS: +## +## BLOBS += subfolder/my_file.foo +## +## The subfolder will be part of the generated header's path, but *not* of the +## generated symbols. E.g., above blob would be made available by including +## "blobs/subfolder/my_file.ext.h", which would define the symbols "my_file_ext" +## and "my_file_ext_len". Beware possible symbol name clashes. +## # use "blobs/blob" so the headers can be included as "blob/foo.h", but # we don't have to add $(BINDIR)/$(MODULE) to the include path.