DGNum/hostapd
6
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Update Doxygen documentation for new version

Browse source 
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>
This commit is contained in:
Jouni Malinen 2012-04-24 20:37:24 +03:00
parent 1ceb0e1778
commit 7c4e92115a
4 changed files with 14 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/Makefile
View file

@ -7,6 +7,9 @@ all: docs
fig2dev -L png -m 3 $*.fig | pngtopnm | pnmscale 0.4 | pnmtopng \ fig2dev -L png -m 3 $*.fig | pngtopnm | pnmscale 0.4 | pnmtopng \
> $*.png > $*.png
_wpa_supplicant.png: wpa_supplicant.png
cp $< $@
docs-pics: wpa_supplicant.png wpa_supplicant.eps hostapd.png hostapd.eps docs-pics: wpa_supplicant.png wpa_supplicant.eps hostapd.png hostapd.eps
docs: docs-pics docs: docs-pics
@ -14,12 +17,13 @@ docs: docs-pics
$(MAKE) -C latex $(MAKE) -C latex
cp latex/refman.pdf wpa_supplicant-devel.pdf cp latex/refman.pdf wpa_supplicant-devel.pdf
html: docs-pics html: docs-pics _wpa_supplicant.png
(cd ..; doxygen doc/doxygen.conf; cd doc) (cd ..; doxygen doc/doxygen.conf; cd doc)
clean: clean:
rm -f *~ rm -f *~
rm -f wpa_supplicant.eps wpa_supplicant.png rm -f wpa_supplicant.eps wpa_supplicant.png
rm -f _wpa_supplicant.png
rm -f hostapd.eps hostapd.png rm -f hostapd.eps hostapd.png
rm -f doxygen.warnings rm -f doxygen.warnings
rm -rf html latex rm -rf html latex

4
doc/code_structure.doxygen
View file

@ -1,7 +1,7 @@
/** /**
\page code_structure Structure of the source code \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 generic_helper_func "Generic helper functions" |
\ref crypto_func "Cryptographic functions" | \ref crypto_func "Cryptographic functions" |
\ref tls_func "TLS library" | \ref tls_func "TLS library" |
@ -29,7 +29,7 @@ all hardware/driver dependent functionality is implemented in
driver_*.c. driver_*.c.
\section wpa_supplicant_core wpa_supplicant core functionality \section _wpa_supplicant_core wpa_supplicant core functionality
wpa_supplicant.c wpa_supplicant.c
Program initialization, main control loop Program initialization, main control loop

5
doc/doxygen.conf
View file

@ -25,13 +25,13 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project. # 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. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
# if some version control system is used. # 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) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put. # base path where the generated documentation will be put.
@ -582,6 +582,7 @@ INPUT = \
src/eap_peer \ src/eap_peer \
src/eap_server \ src/eap_server \
src/l2_packet \ src/l2_packet \
src/p2p \
src/radius \ src/radius \
src/rsn_supp \ src/rsn_supp \
src/tls \ src/tls \

8
doc/mainpage.doxygen
View file

@ -20,7 +20,7 @@ available as a PDF file from
http://w1.fi/wpa_supplicant/wpa_supplicant-devel.pdf . 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 %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 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 a small C library that provides helper functions to facilitate the use of the
control interface. This library can also be used with C++. control interface. This library can also be used with C++.
\image html wpa_supplicant.png "wpa_supplicant modules" \image html _wpa_supplicant.png "wpa_supplicant modules"
\image latex wpa_supplicant.eps "wpa_supplicant modules" width=15cm \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 / hostapd includes IEEE 802.11 access point management (authentication /
association), IEEE 802.1X/WPA/WPA2 Authenticator, EAP server, and association), IEEE 802.1X/WPA/WPA2 Authenticator, EAP server, and