Add some of the .txt files in /doc subdir to doxygen documentation

This commit is contained in:
Dirk Ziegelmeier 2016-07-25 08:16:39 +02:00
parent 28dd0813ab
commit d75ece2505
8 changed files with 24 additions and 5 deletions

4
doc/doxygen/contrib.h Normal file
View File

@ -0,0 +1,4 @@
/**
* @page contrib How to contribute to lwIP
* @verbinclude "contrib.txt"
*/

View File

@ -781,7 +781,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # 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 # 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 # 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 # that contain example code fragments that are included (see the \include
# command). # command).
EXAMPLE_PATH = EXAMPLE_PATH = ../
# If the value of the EXAMPLE_PATH tag contains directories, you can use the # 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 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and

4
doc/doxygen/ppp.h Normal file
View File

@ -0,0 +1,4 @@
/**
* @page ppp PPP
* @verbinclude "ppp.txt"
*/

4
doc/doxygen/rawapi.h Normal file
View File

@ -0,0 +1,4 @@
/**
* @page rawapi RAW API
* @verbinclude "rawapi.txt"
*/

4
doc/doxygen/sys_arch.h Normal file
View File

@ -0,0 +1,4 @@
/**
* @page sys Porting (sys abstraction layer)
* @verbinclude "sys_arch.txt"
*/

View File

@ -1,6 +1,7 @@
/** /**
* @file * @file
* raw API (to be used from TCPIP thread) * raw API (to be used from TCPIP thread)\n
* See also @ref rawapi
*/ */
/* /*

View File

@ -1,6 +1,7 @@
/** /**
* @file * @file
* TCP API (to be used from TCPIP thread) * TCP API (to be used from TCPIP thread)\n
* See also @ref rawapi
*/ */
/* /*

View File

@ -1,6 +1,7 @@
/** /**
* @file * @file
* UDP API (to be used from TCPIP thread) * UDP API (to be used from TCPIP thread)\n
* See also @ref rawapi
*/ */
/* /*