From d75ece250580e472ec60d32cfc93b3853cd730ed Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Mon, 25 Jul 2016 08:16:39 +0200 Subject: [PATCH] Add some of the .txt files in /doc subdir to doxygen documentation --- doc/doxygen/contrib.h | 4 ++++ doc/doxygen/lwip.Doxyfile | 4 ++-- doc/doxygen/ppp.h | 4 ++++ doc/doxygen/rawapi.h | 4 ++++ doc/doxygen/sys_arch.h | 4 ++++ src/include/lwip/raw.h | 3 ++- src/include/lwip/tcp.h | 3 ++- src/include/lwip/udp.h | 3 ++- 8 files changed, 24 insertions(+), 5 deletions(-) create mode 100644 doc/doxygen/contrib.h create mode 100644 doc/doxygen/ppp.h create mode 100644 doc/doxygen/rawapi.h create mode 100644 doc/doxygen/sys_arch.h diff --git a/doc/doxygen/contrib.h b/doc/doxygen/contrib.h new file mode 100644 index 00000000..11643666 --- /dev/null +++ b/doc/doxygen/contrib.h @@ -0,0 +1,4 @@ +/** + * @page contrib How to contribute to lwIP + * @verbinclude "contrib.txt" + */ diff --git a/doc/doxygen/lwip.Doxyfile b/doc/doxygen/lwip.Doxyfile index 9e2160e6..0af10249 100644 --- a/doc/doxygen/lwip.Doxyfile +++ b/doc/doxygen/lwip.Doxyfile @@ -781,7 +781,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../../src main_page.h +INPUT = ../../src main_page.h rawapi.h ppp.h contrib.h sys_arch.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -875,7 +875,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = +EXAMPLE_PATH = ../ # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and diff --git a/doc/doxygen/ppp.h b/doc/doxygen/ppp.h new file mode 100644 index 00000000..f2624477 --- /dev/null +++ b/doc/doxygen/ppp.h @@ -0,0 +1,4 @@ +/** + * @page ppp PPP + * @verbinclude "ppp.txt" + */ diff --git a/doc/doxygen/rawapi.h b/doc/doxygen/rawapi.h new file mode 100644 index 00000000..f5203e5c --- /dev/null +++ b/doc/doxygen/rawapi.h @@ -0,0 +1,4 @@ +/** + * @page rawapi RAW API + * @verbinclude "rawapi.txt" + */ diff --git a/doc/doxygen/sys_arch.h b/doc/doxygen/sys_arch.h new file mode 100644 index 00000000..213cec90 --- /dev/null +++ b/doc/doxygen/sys_arch.h @@ -0,0 +1,4 @@ +/** + * @page sys Porting (sys abstraction layer) + * @verbinclude "sys_arch.txt" + */ diff --git a/src/include/lwip/raw.h b/src/include/lwip/raw.h index 7b004699..c70a6591 100644 --- a/src/include/lwip/raw.h +++ b/src/include/lwip/raw.h @@ -1,6 +1,7 @@ /** * @file - * raw API (to be used from TCPIP thread) + * raw API (to be used from TCPIP thread)\n + * See also @ref rawapi */ /* diff --git a/src/include/lwip/tcp.h b/src/include/lwip/tcp.h index 29ff0319..b18c6151 100644 --- a/src/include/lwip/tcp.h +++ b/src/include/lwip/tcp.h @@ -1,6 +1,7 @@ /** * @file - * TCP API (to be used from TCPIP thread) + * TCP API (to be used from TCPIP thread)\n + * See also @ref rawapi */ /* diff --git a/src/include/lwip/udp.h b/src/include/lwip/udp.h index 84c69fcb..d6156040 100644 --- a/src/include/lwip/udp.h +++ b/src/include/lwip/udp.h @@ -1,6 +1,7 @@ /** * @file - * UDP API (to be used from TCPIP thread) + * UDP API (to be used from TCPIP thread)\n + * See also @ref rawapi */ /*