]> git.ipfire.org Git - thirdparty/hostap.git/commitdiff
Update Doxygen documentation for new version
authorJouni Malinen <j@w1.fi>
Tue, 24 Apr 2012 17:37:24 +0000 (20:37 +0300)
committerJouni Malinen <j@w1.fi>
Tue, 24 Apr 2012 17:37:24 +0000 (20:37 +0300)
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>

doc/Makefile
doc/code_structure.doxygen
doc/doxygen.conf
doc/mainpage.doxygen

index 5c1b386e85c95753519a77725c9f520d2db77c7d..08a266f76c42f3bfea27495ca1e4d5e9de800d7b 100644 (file)
@@ -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
index 96f61601e77a4a8a7c9f085cfd04838a4b060b6d..26f5f6d8e047efba49d400207788844be480f3cf 100644 (file)
@@ -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
index 6a1cb3e9325c6a459945665ec86f4e8e68e42cf3..55a9433db3d4a85d2b7f2cb3b12b705a32558ac9 100644 (file)
@@ -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 \
index 09d2550f48442d1ed86644570f87b6e3f61f5b02..26dc92982eaa9ef201b76031ea98410c80f153eb 100644 (file)
@@ -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