Hi Simon,
If it can help you, find attached files I used to produce 1.3.0
documentation.
I have download the last win32 doxygen, and the wizard can open and
process it (just one path the change in the "lwip.Doxyfile" text file).
Regards
Le 17/01/2013 17:08, Simon Goldschmidt a écrit :
chrysn <[email protected]> wrote:
* could we have the Doxyfile that created [1] checked into the source
repository?
We could, if we had it... I think Frederic did the documentation part some
years ago, maybe he can help out (if he's still monitoring this list?).
Maybe it's in the lwiphtml CVS? I'll post the URL to that one if I find it
(it's a module of the old CVS on savannah, which should still exist).
As to the rest: any input on improved documentation is welcome!
if there is support from the web master who'd manage the website itself,
i can offer to do some polishing on the markdown side of things.
The website is managed by us (somehow...). As a project leader, I should know
how to do that - I'll try to find out. Anyway, I'll be able to upload changes
and the current state of documenting 1.3.0 is not ideal.
Simon
_______________________________________________
lwip-users mailing list
[email protected]
https://lists.nongnu.org/mailman/listinfo/lwip-users
/*! \mainpage lwIP Documentation
*
* \section intro_sec Introduction
*
* lwIP is a small independent implementation of the TCP/IP protocol suite that
has been developed by Adam Dunkels at the Computer and Networks Architectures
(CNA) lab at the Swedish Institute of Computer Science (SICS).
*
* The focus of the lwIP TCP/IP implementation is to reduce resource usage
while still having a full scale TCP. This making lwIP suitable for use in
embedded systems with tens of kilobytes of free RAM and room for around 40
kilobytes of code ROM.
*
* \section lwip_features_sec lwIP features:
*
* \li \c IP (Internet Protocol) including packet forwarding over multiple
network interfaces\n
* \li \c ICMP (Internet Control Message Protocol) for network maintenance and
debugging\n
* \li \c IGMP (Internet Group Management Protocol) for multicast traffic
management\n
* \li \c UDP (User Datagram Protocol) including experimental UDP-lite
extensions\n
* \li \c TCP (Transmission Control Protocol) with congestion control, RTT
estimation and fast recovery/fast retransmit\n
* \li \c raw/native API for enhanced performance\n
* \li \c Optional Berkeley-like socket API\n
* \li \c DNS (Domain names resolver)\n
* \li \c SNMP (Simple Network Management Protocol)\n
* \li \c DHCP (Dynamic Host Configuration Protocol)\n
* \li \c AUTOIP (for IPv4, conform with RFC 3927)\n
* \li \c PPP (Point-to-Point Protocol)\n
* \li \c ARP (Address Resolution Protocol) for Ethernet\n
*
* \section install_sec Documentation
*
* Development of lwIP is hosted on Savannah, a central point for software
development, maintenance and distribution. Everyone can help improve lwIP by
use of Savannah's interface, CVS and the mailing list. A core team of
developers will commit changes to the CVS source tree.\n
* http://savannah.nongnu.org/projects/lwip/\n
* \n
* The original out-dated homepage of lwIP and Adam Dunkels' papers on lwIP are
at the official lwIP home page:\n
* http://www.sics.se/~adam/lwip/\n
* \n
* Self documentation of the source code is regularly extracted from the
current CVS sources and is available from this web page:\n
* http://www.nongnu.org/lwip/\n
* \n
* There is now a constantly growin wiki about lwIP at\n
* http://lwip.wikia.com/\n
* \n
* Also, there are mailing lists you can subscribe at\n
* http://savannah.nongnu.org/mail/?group=lwip\n
* plus searchable archives:\n
* http://lists.nongnu.org/archive/html/lwip-users/\n
* http://lists.nongnu.org/archive/html/lwip-devel/\n
* \n
* Reading Adam's papers, the files in docs/, browsing the source code
documentation and browsing the mailing list archives is a good way to become
familiar with the design of lwIP.\n
*
*/
# Doxyfile 1.5.4
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "lwIP 1.3.0"
PROJECT_NUMBER = "lwIP 1.3.0"
OUTPUT_DIRECTORY = C:/OPENSOURCE/LwIP/doxygen
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class " \
"The $name widget " \
"The $name file " \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = C:\OPENSOURCE\lwip
STRIP_FROM_INC_PATH = C:\OPENSOURCE\lwip
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
TYPEDEF_HIDES_STRUCT = NO
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = YES
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text "
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = C:\OPENSOURCE\lwip\lwip
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.m \
*.mm \
*.dox
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
REFERENCES_LINK_SOURCE = YES
USE_HTAGS = NO
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = C:/OPENSOURCE/lwIP/doxygen/output/html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
HTML_DYNAMIC_SECTIONS = NO
CHM_FILE = lwip.chm
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = YES
RTF_OUTPUT = C:/OPENSOURCE/lwIP/doxygen/output/rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = NO
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH = C:\OPENSOURCE\lwip\lwip
INCLUDE_FILE_PATTERNS =
PREDEFINED = NO_SYS=0 \
SYS_LIGHTWEIGHT_PROT=1 \
LWIP_ICMP=1 \
LWIP_RAW=1 \
LWIP_DHCP=1 \
LWIP_UDPLITE=1 \
LWIP_UDP=1 \
LWIP_IGMP=1 \
LWIP_TCP=1 \
LWIP_SNMP=1 \
MEMP_OVERFLOW_CHECK=1 \
MEMP_SANITY_CHECK=1 \
LWIP_ARP=1 \
LWIP_NETIF_HOSTNAME=1 \
LWIP_NETIF_API=1 \
LWIP_NETIF_CALLBACK=1 \
LWIP_NETIF_LINK_CALLBACK=1 \
LWIP_AUTOIP=1 \
ARP_QUEUEING=1 \
LWIP_STATS=1 \
MEM_USE_POOLS=0 \
LWIP_DNS=1 \
LWIP_SOCKETS=1 \
LWIP_NETCONN=1 \
"LWIP_DNS && LWIP_SOCKET " \
"(LWIP_DNS && LWIP_SOCKET)=1 "
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = NO
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
_______________________________________________
lwip-users mailing list
[email protected]
https://lists.nongnu.org/mailman/listinfo/lwip-users
