lwip/doc/doxygen/main_page.h

/**
 * @defgroup lwip lwIP
 * 
 * @defgroup infrastructure Infrastructure
 *
 * @defgroup callbackstyle_api Callback-style APIs
 * Non thread-safe APIs, callback style for maximum performance and minimum
 * memory footprint.
 * 
 * @defgroup threadsafe_api Thread-safe APIs
 * Thread-safe APIs, blocking functions. More overhead, but can be called
 * from any thread except TCPIP thread.
 * 
 * @defgroup addons Addons
 * 
 * @defgroup apps Applications
 * 
 * @defgroup lwip_opts lwIP Options (lwipopts.h)
 */

/**
 * @mainpage Overview
 * @verbinclude "README"
 */

/**
 * @page upgrading Upgrading
 * @verbinclude "UPGRADING"
 */

/**
 * @page contrib How to contribute to lwIP
 * @verbinclude "contrib.txt"
 */
Restructure documentation. Create two top-level sections for thread-safe and callback-style APIs. 2016-07-26 16:39:53 +00:00			`/**`
Integrate README file into doxygen docs instead of duplicating its content in main_page.h 2016-07-27 17:09:52 +00:00			`* @defgroup lwip lwIP`
			`*`
			`* @defgroup infrastructure Infrastructure`
			`*`
Restructure documentation. Create two top-level sections for thread-safe and callback-style APIs. 2016-07-26 16:39:53 +00:00			`* @defgroup callbackstyle_api Callback-style APIs`
			`* Non thread-safe APIs, callback style for maximum performance and minimum`
			`* memory footprint.`
			`*`
			`* @defgroup threadsafe_api Thread-safe APIs`
			`* Thread-safe APIs, blocking functions. More overhead, but can be called`
			`* from any thread except TCPIP thread.`
Document apps in doxygen module style, create more top-level categories to structure documentation 2016-07-26 17:30:05 +00:00			`*`
			`* @defgroup addons Addons`
			`*`
			`* @defgroup apps Applications`
Document opt.h - due to a bad bug in doxygen, I had to litter the whole file with "\|\| __DOXYGEN__" to make it work :-( Doxygen does not handle #ifndef foo #define foo #endif properly. It does not see the #define foo inside. If someone has objections or a fix for it, please tell me. 2016-07-27 18:12:58 +00:00			`*`
			`* @defgroup lwip_opts lwIP Options (lwipopts.h)`
Restructure documentation. Create two top-level sections for thread-safe and callback-style APIs. 2016-07-26 16:39:53 +00:00			`*/`

Minor main_page.h cosmetics 2016-07-27 18:30:57 +00:00			`/**`
			`* @mainpage Overview`
Integrate README file into doxygen docs instead of duplicating its content in main_page.h 2016-07-27 17:09:52 +00:00			`* @verbinclude "README"`
Move content from contrib.h and upgrading.h to main_page.h 2016-07-27 11:07:29 +00:00			`*/`

Minor main_page.h cosmetics 2016-07-27 18:30:57 +00:00			`/**`
Move content from contrib.h and upgrading.h to main_page.h 2016-07-27 11:07:29 +00:00			`* @page upgrading Upgrading`
			`* @verbinclude "UPGRADING"`
			`*/`
Integrate README file into doxygen docs instead of duplicating its content in main_page.h 2016-07-27 17:09:52 +00:00
			`/**`
			`* @page contrib How to contribute to lwIP`
			`* @verbinclude "contrib.txt"`
Add doxygen config + main-file used by Frédéric to create http://www.nongnu.org/lwip/ for 1.3.0 (see https://lists.gnu.org/archive/html/lwip-users/2013-01/msg00062.html) - just so that it doesn't get lost 2015-08-19 13:43:46 +00:00			`*/`