From c96679f3d19ffa5920528079a46dcc66fc326ec8 Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sat, 5 Dec 2015 14:52:09 +0100 Subject: [PATCH] doc: include package documentation --- doc/doxygen/riot.doxyfile | 3 +++ pkg/doc.txt | 15 +++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 pkg/doc.txt diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index e7ea3d1324..8b21edbc74 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -759,6 +759,7 @@ INPUT = ../../doc.txt \ ../../boards \ ../../drivers \ ../../sys \ + ../../pkg \ src/ \ src/mainpage.md \ src/getting-started.md @@ -836,6 +837,8 @@ EXCLUDE_PATTERNS = */board/*/tools/* \ */cpu/kw2x/include/MKW22D5.h \ */cpu/k64f/include/MK64F12.h \ */cpu/ezr32wg/include/ezr* \ + */pkg/*/*/* \ + */pkg/tlsf/patch.txt \ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names diff --git a/pkg/doc.txt b/pkg/doc.txt new file mode 100644 index 0000000000..d97acce3eb --- /dev/null +++ b/pkg/doc.txt @@ -0,0 +1,15 @@ +/* + * Copyright (C) 2015 INRIA + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @defgroup pkg Packages + * @brief RIOT supports the integration of external libraries. These + * libraries can be used as BSD-like packages, i.e. they are + * downloaded automatically at compile-time (if needed) and linked + * against RIOT. + */