RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

blobs: include documentation in doxygen

Browse Source
This commit is contained in:
Koen Zandberg 2023-01-25 22:52:30 +01:00
parent 719787bd7f
commit 96e37a4f41
No known key found for this signature in database
GPG Key ID: BA1718B37D79F51C
2 changed files with 34 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/doxygen/riot.doxyfile
View File

@ -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

59
makefiles/blob.inc.mk
View File

@ -1,29 +1,36 @@
#
# makes any file in BLOBS available via '#include "blob/<filename>.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.