aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJouni Malinen <j@w1.fi>2012-04-24 17:37:24 (GMT)
committerJouni Malinen <j@w1.fi>2012-04-24 17:37:24 (GMT)
commit7c4e92115a795dd2ee2135cf49d7e9e172fb5851 (patch)
treeb541d373a0f41759b8a2f9c513f980b045fa63b4 /doc
parent1ceb0e1778b0306488bf7546c1edb3b67531fee1 (diff)
downloadhostap-7c4e92115a795dd2ee2135cf49d7e9e172fb5851.zip
hostap-7c4e92115a795dd2ee2135cf49d7e9e172fb5851.tar.gz
hostap-7c4e92115a795dd2ee2135cf49d7e9e172fb5851.tar.bz2
Update Doxygen documentation for new version
Add src/p2p directory and work around some issues with newer Doxygen versions disliking the wpa_supplicant prefix in labels. Signed-hostap: Jouni Malinen <j@w1.fi>
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile6
-rw-r--r--doc/code_structure.doxygen4
-rw-r--r--doc/doxygen.conf5
-rw-r--r--doc/mainpage.doxygen8
4 files changed, 14 insertions, 9 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 5c1b386..08a266f 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -7,6 +7,9 @@ all: docs
fig2dev -L png -m 3 $*.fig | pngtopnm | pnmscale 0.4 | pnmtopng \
> $*.png
+_wpa_supplicant.png: wpa_supplicant.png
+ cp $< $@
+
docs-pics: wpa_supplicant.png wpa_supplicant.eps hostapd.png hostapd.eps
docs: docs-pics
@@ -14,12 +17,13 @@ docs: docs-pics
$(MAKE) -C latex
cp latex/refman.pdf wpa_supplicant-devel.pdf
-html: docs-pics
+html: docs-pics _wpa_supplicant.png
(cd ..; doxygen doc/doxygen.conf; cd doc)
clean:
rm -f *~
rm -f wpa_supplicant.eps wpa_supplicant.png
+ rm -f _wpa_supplicant.png
rm -f hostapd.eps hostapd.png
rm -f doxygen.warnings
rm -rf html latex
diff --git a/doc/code_structure.doxygen b/doc/code_structure.doxygen
index 96f6160..26f5f6d 100644
--- a/doc/code_structure.doxygen
+++ b/doc/code_structure.doxygen
@@ -1,7 +1,7 @@
/**
\page code_structure Structure of the source code
-[ \ref wpa_supplicant_core "wpa_supplicant core functionality" |
+[ \ref _wpa_supplicant_core "wpa_supplicant core functionality" |
\ref generic_helper_func "Generic helper functions" |
\ref crypto_func "Cryptographic functions" |
\ref tls_func "TLS library" |
@@ -29,7 +29,7 @@ all hardware/driver dependent functionality is implemented in
driver_*.c.
-\section wpa_supplicant_core wpa_supplicant core functionality
+\section _wpa_supplicant_core wpa_supplicant core functionality
wpa_supplicant.c
Program initialization, main control loop
diff --git a/doc/doxygen.conf b/doc/doxygen.conf
index 6a1cb3e..55a9433 100644
--- a/doc/doxygen.conf
+++ b/doc/doxygen.conf
@@ -25,13 +25,13 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = wpa_supplicant / hostapd
+PROJECT_NAME = "wpa_supplicant / hostapd"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = 0.7.x
+PROJECT_NUMBER = 2.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
@@ -582,6 +582,7 @@ INPUT = \
src/eap_peer \
src/eap_server \
src/l2_packet \
+ src/p2p \
src/radius \
src/rsn_supp \
src/tls \
diff --git a/doc/mainpage.doxygen b/doc/mainpage.doxygen
index 09d2550..26dc929 100644
--- a/doc/mainpage.doxygen
+++ b/doc/mainpage.doxygen
@@ -20,7 +20,7 @@ available as a PDF file from
http://w1.fi/wpa_supplicant/wpa_supplicant-devel.pdf .
-\section wpa_supplicant wpa_supplicant
+\section _wpa_supplicant wpa_supplicant
%wpa_supplicant is a WPA Supplicant for Linux, BSD and Windows with
support for WPA and WPA2 (IEEE 802.11i / RSN). Supplicant is the IEEE
@@ -54,11 +54,11 @@ daemon and to get status information and event notifications. There is
a small C library that provides helper functions to facilitate the use of the
control interface. This library can also be used with C++.
-\image html wpa_supplicant.png "wpa_supplicant modules"
-\image latex wpa_supplicant.eps "wpa_supplicant modules" width=15cm
+\image html _wpa_supplicant.png "wpa_supplicant modules"
+\image latex _wpa_supplicant.eps "wpa_supplicant modules" width=15cm
-\section hostapd hostapd
+\section _hostapd hostapd
hostapd includes IEEE 802.11 access point management (authentication /
association), IEEE 802.1X/WPA/WPA2 Authenticator, EAP server, and