Browse Source

Create all doxygen docs from root directory to get proper path names

This updated all doxygen runs to use the same style that was used for
wpa_supplicant full documents. The full vs. fast configurations are now
otherwise identical apart from fast not generating dot files or
latex/pdf version of the documentation.
Jouni Malinen 16 years ago
parent
commit
875f6d7b93

+ 3 - 3
hostapd/Makefile

@@ -552,16 +552,16 @@ clean:
 docs-pics: doc/hostapd.png doc/hostapd.eps
 docs-pics: doc/hostapd.png doc/hostapd.eps
 
 
 docs: docs-pics
 docs: docs-pics
-	doxygen doc/doxygen.full
+	(cd ..; doxygen hostapd/doc/doxygen.full; cd hostapd)
 	$(MAKE) -C doc/latex
 	$(MAKE) -C doc/latex
 	cp doc/latex/refman.pdf hostapd-devel.pdf
 	cp doc/latex/refman.pdf hostapd-devel.pdf
 
 
 docs-fast: docs-pics
 docs-fast: docs-pics
-	doxygen doc/doxygen.fast
+	(cd ..; doxygen hostapd/doc/doxygen.fast; cd hostapd)
 
 
 clean-docs:
 clean-docs:
 	rm -rf doc/latex doc/html
 	rm -rf doc/latex doc/html
-	rm -f doc/hosta.d{eps,png} hostapd-devel.pdf
+	rm -f doc/hostapd.{eps,png} hostapd-devel.pdf
 
 
 TEST_SRC_MILENAGE = ../src/hlr_auc_gw/milenage.c ../src/crypto/aes_wrap.c ../src/crypto/aes.c ../src/utils/common.c ../src/utils/wpa_debug.o ../src/utils/os_$(CONFIG_OS).c
 TEST_SRC_MILENAGE = ../src/hlr_auc_gw/milenage.c ../src/crypto/aes_wrap.c ../src/crypto/aes.c ../src/utils/common.c ../src/utils/wpa_debug.o ../src/utils/os_$(CONFIG_OS).c
 test-milenage: $(TEST_SRC_MILENAGE)
 test-milenage: $(TEST_SRC_MILENAGE)

+ 13 - 13
hostapd/doc/doxygen.fast

@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 PROJECT_NAME           = hostapd
 PROJECT_NAME           = hostapd
 PROJECT_NUMBER         = 0.6.x
 PROJECT_NUMBER         = 0.6.x
-OUTPUT_DIRECTORY       = doc
+OUTPUT_DIRECTORY       = hostapd/doc
 CREATE_SUBDIRS         = NO
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
 BRIEF_MEMBER_DESC      = YES
@@ -65,7 +65,7 @@ GENERATE_DEPRECATEDLIST= YES
 ENABLED_SECTIONS       = 
 ENABLED_SECTIONS       = 
 MAX_INITIALIZER_LINES  = 30
 MAX_INITIALIZER_LINES  = 30
 SHOW_USED_FILES        = YES
 SHOW_USED_FILES        = YES
-SHOW_DIRECTORIES       = NO
+SHOW_DIRECTORIES       = YES
 FILE_VERSION_FILTER    = 
 FILE_VERSION_FILTER    = 
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 # configuration options related to warning and progress messages
@@ -80,17 +80,17 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
-INPUT                  = . \
-	../src/common \
-	../src/crypto \
-	../src/eap_common \
-	../src/eap_server \
-	../src/l2_packet \
-	../src/radius \
-	../src/rsn_supp \
-	../src/tls \
-	../src/utils \
-	../src/wps
+INPUT                  = hostapd \
+	src/common \
+	src/crypto \
+	src/eap_common \
+	src/eap_server \
+	src/l2_packet \
+	src/radius \
+	src/rsn_supp \
+	src/tls \
+	src/utils \
+	src/wps
 FILE_PATTERNS          = *.c *.h *.doxygen
 FILE_PATTERNS          = *.c *.h *.doxygen
 RECURSIVE              = YES
 RECURSIVE              = YES
 EXCLUDE                = 
 EXCLUDE                = 

+ 13 - 13
hostapd/doc/doxygen.full

@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 PROJECT_NAME           = hostapd
 PROJECT_NAME           = hostapd
 PROJECT_NUMBER         = 0.6.x
 PROJECT_NUMBER         = 0.6.x
-OUTPUT_DIRECTORY       = doc
+OUTPUT_DIRECTORY       = hostapd/doc
 CREATE_SUBDIRS         = NO
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
 BRIEF_MEMBER_DESC      = YES
@@ -65,7 +65,7 @@ GENERATE_DEPRECATEDLIST= YES
 ENABLED_SECTIONS       = 
 ENABLED_SECTIONS       = 
 MAX_INITIALIZER_LINES  = 30
 MAX_INITIALIZER_LINES  = 30
 SHOW_USED_FILES        = YES
 SHOW_USED_FILES        = YES
-SHOW_DIRECTORIES       = NO
+SHOW_DIRECTORIES       = YES
 FILE_VERSION_FILTER    = 
 FILE_VERSION_FILTER    = 
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 # configuration options related to warning and progress messages
@@ -80,17 +80,17 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
-INPUT                  = . \
-	../src/common \
-	../src/crypto \
-	../src/eap_common \
-	../src/eap_server \
-	../src/l2_packet \
-	../src/radius \
-	../src/rsn_supp \
-	../src/tls \
-	../src/utils \
-	../src/wps
+INPUT                  = hostapd \
+	src/common \
+	src/crypto \
+	src/eap_common \
+	src/eap_server \
+	src/l2_packet \
+	src/radius \
+	src/rsn_supp \
+	src/tls \
+	src/utils \
+	src/wps
 FILE_PATTERNS          = *.c *.h *.doxygen
 FILE_PATTERNS          = *.c *.h *.doxygen
 RECURSIVE              = YES
 RECURSIVE              = YES
 EXCLUDE                = 
 EXCLUDE                = 

+ 1 - 1
wpa_supplicant/Makefile

@@ -1224,7 +1224,7 @@ docs: docs-pics
 	cp doc/latex/refman.pdf wpa_supplicant-devel.pdf
 	cp doc/latex/refman.pdf wpa_supplicant-devel.pdf
 
 
 docs-fast: docs-pics
 docs-fast: docs-pics
-	doxygen doc/doxygen.fast
+	(cd ..; doxygen wpa_supplicant/doc/doxygen.fast; cd wpa_supplicant)
 
 
 clean-docs:
 clean-docs:
 	rm -rf doc/latex doc/html
 	rm -rf doc/latex doc/html

+ 15 - 16
wpa_supplicant/doc/doxygen.fast

@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 PROJECT_NAME           = wpa_supplicant
 PROJECT_NAME           = wpa_supplicant
 PROJECT_NUMBER         = 0.6.x
 PROJECT_NUMBER         = 0.6.x
-OUTPUT_DIRECTORY       = doc
+OUTPUT_DIRECTORY       = wpa_supplicant/doc
 CREATE_SUBDIRS         = NO
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
 BRIEF_MEMBER_DESC      = YES
@@ -65,7 +65,7 @@ GENERATE_DEPRECATEDLIST= YES
 ENABLED_SECTIONS       = 
 ENABLED_SECTIONS       = 
 MAX_INITIALIZER_LINES  = 30
 MAX_INITIALIZER_LINES  = 30
 SHOW_USED_FILES        = YES
 SHOW_USED_FILES        = YES
-SHOW_DIRECTORIES       = NO
+SHOW_DIRECTORIES       = YES
 FILE_VERSION_FILTER    = 
 FILE_VERSION_FILTER    = 
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 # configuration options related to warning and progress messages
@@ -80,20 +80,19 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
-INPUT                  = . \
-	../src/common \
-	../src/crypto \
-	../src/drivers/driver.h \
-	../src/drivers/drivers.c \
-	../src/eap_common \
-	../src/eapol_supp \
-	../src/eap_peer \
-	../src/l2_packet \
-	../src/rsn_supp \
-	../src/tls \
-	../src/utils \
-	../src/wps
-FILE_PATTERNS          = *.c *.h *.doxygen
+INPUT                  = wpa_supplicant \
+	src/common \
+	src/crypto \
+	src/drivers \
+	src/eap_common \
+	src/eapol_supp \
+	src/eap_peer \
+	src/l2_packet \
+	src/rsn_supp \
+	src/tls \
+	src/utils \
+	src/wps
+FILE_PATTERNS          = *.c *.h *.cpp *.m *.doxygen
 RECURSIVE              = YES
 RECURSIVE              = YES
 EXCLUDE                = 
 EXCLUDE                = 
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_SYMLINKS       = NO

+ 1 - 1
wpa_supplicant/doc/doxygen.full

@@ -23,7 +23,7 @@ ABBREVIATE_BRIEF       = "The $name class" \
                          the
                          the
 ALWAYS_DETAILED_SEC    = NO
 ALWAYS_DETAILED_SEC    = NO
 INLINE_INHERITED_MEMB  = NO
 INLINE_INHERITED_MEMB  = NO
-FULL_PATH_NAMES        = NO
+FULL_PATH_NAMES        = YES
 STRIP_FROM_PATH        =
 STRIP_FROM_PATH        =
 STRIP_FROM_INC_PATH    = 
 STRIP_FROM_INC_PATH    = 
 SHORT_NAMES            = NO
 SHORT_NAMES            = NO