switch doxygen generation in sofia-sip around to use configure generated files. This should avoid some problems with warnings and errors when builing the manpages. You will probably need to autoreconf and configure sofia-sip for this

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@4979 d0543943-73ff-0310-b7d9-9358b9ac24b2
2026-11-11 20:17:05 +00:00 · 2007-04-19 22:28:01 +00:00
1 parent a3529672d7
commit d70893d808
@@ -59,7 +59,6 @@ include $(top_srcdir)/rules/recursive.am

 doxygen: built-sources
 	@echo Generating empty doxytags
-	cd ${srcdir}; \
 	mkdir -p docs/html ; \
 	for d in $(DIST_SUBDIRS); do \
 	  test -r $$d/Doxyfile || continue ; \
@@ -71,20 +70,18 @@ doxygen: built-sources
 	    mv -f docs/$$d.doxytags.tmp docs/$$d.doxytags ; \
          fi ; \
 	done
-	@cd ${srcdir} ;\
 	for d in $(DIST_SUBDIRS); do \
 	  test -r $$d/Doxyfile \
 	  && pushd $$d > /dev/null \
 	  && echo running ${DOXYGEN} first time in $$d \
          && ${DOXYGEN} 2>&1 \
-	  | egrep -v -i -e 'Warning: (unsupported (xml/)?html tag|unable to resolve reference|could not be resolved)' \
+	  | egrep -v -i -e 'Warning: (unsupported (xml/)?html tag|unable to resolve reference|explicit link.*could not be resolved)' \
          ; popd > /dev/null ; \
 	  test -r docs/$$d.doxytags && \
 	  sed '2,10s!<name>index</name>!<name>'$$d'_index</name>!' \
 	    docs/$$d.doxytags > docs/$$d.doxytags.tmp && \
 	  mv -f docs/$$d.doxytags.tmp docs/$$d.doxytags ; \
 	done 
-	@cd ${srcdir} ;\
 	for d in $(DIST_SUBDIRS); do \
 	  test -r $$d/Doxyfile \
 	  && pushd $$d > /dev/null \
@@ -97,6 +94,6 @@ doxygen: built-sources
 	    docs/$$d.doxytags > docs/$$d.doxytags.tmp && \
 	  mv -f docs/$$d.doxytags.tmp docs/$$d.doxytags ; \
 	done 
-	cd ${srcdir}/docs/html && ../hide_emails.sh
+	${srcdir}/docs/hide_emails.sh docs/html

 .PHONY: built-sources built-sources-am empty-doxytags doxygen 
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "bnf"
 OUTPUT_DIRECTORY     = ../docs/html/bnf

-INPUT 		     = bnf.docs sofia-sip . 
+INPUT 		     = @srcdir@/bnf.docs @srcdir@/sofia-sip @srcdir@ .

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES            += ../docs/su.doxytags=../su
@@ -33,7 +33,7 @@ torture_bnf_LDFLAGS = 	-static
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile bnf.docs
+EXTRA_DIST =		bnf.docs

 # ----------------------------------------------------------------------
 # Tests
@@ -62,5 +62,3 @@ FILE_PATTERNS        = *.h *.c
 EXCLUDE_PATTERNS     = acconfig.h config.h confdefs.h \
 			test*.h test*.c torture*.c *test.c *torture.c \
 			*_tag_dll.c *_tag_ref.c
-
-IMAGE_PATH           = ../../libsofia-sip-ua/docs/pictures
@@ -1,10 +1,11 @@
 PROJECT_NAME         = "libsofia-sip-ua"
 OUTPUT_DIRECTORY     = ../docs/html

-INPUT 		     = mainpage.docs docguide.docs conformance.docs
+INPUT 		     = @srcdir@/mainpage.docs @srcdir@/docguide.docs @srcdir@/conformance.docs

 #			release.docs

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 GENERATE_TAGFILE    = docs.doxytags
@@ -27,4 +28,4 @@ TAGFILES            += nea.doxytags=nea
 TAGFILES            += nua.doxytags=nua
 TAGFILES            += features.doxytags=features

-EXAMPLE_PATH = ../sip
+EXAMPLE_PATH = @srcdir@/../sip
@@ -1 +1,3 @@
 PROJECT_NUMBER = @VERSION@
+
+IMAGE_PATH = @top_srcdir@/libsofia-sip-ua/docs/pictures
@@ -1,9 +1,7 @@
-EXTRA_DIST = 	Doxyfile Doxyfile.aliases Doxyfile.conf \
+EXTRA_DIST = 	Doxyfile.aliases Doxyfile.conf \
 		docguide.docs \
 		mainpage.docs \
 		conformance.docs \
-		Doxyfile.version.in \
-		sofia-footer.html.in \
 		hide_emails.sh \
 		ChangeLog \
 	pictures/SIP_basic_incoming_operation.eps \
@@ -29,9 +29,9 @@
 #
 # --------------------------------------------------------------------

-find . -name '*.html' -print | while read i ; do 
-  (
-    echo "Hiding email addresses in ${i}."
-    sed -r -i 's/([:>;][a-z][-a-z.]*)(@[a-z][a-z]*)\.[a-z][a-z]*(["<\&])/\1\2-email.address.hidden\3/gi' $i
- )
-done
+echo "Hiding email addresses in ${1:-.}"
+
+find ${1:-.} -name '*.html' -print0 | 
+xargs -0 \
+sed -r -i 's/([:>;][a-z][-a-z.]*)(@[a-z][a-z]*)\.[a-z][a-z]*(["<\&])/\1\2-email.address.hidden\3/gi'
+
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "features"
 OUTPUT_DIRECTORY     = ../docs/html/features

-INPUT 		     = features.docs sofia-sip .
+INPUT 		     = @srcdir@/features.docs @srcdir@/sofia-sip sofia-sip @srcdir@ .

+@INCLUDE_PATH = . @srcdir@
@INCLUDE             = ../docs/Doxyfile.conf

 TAGFILES            += ../docs/docs.doxytags=..
@@ -26,7 +26,7 @@ libfeatures_la_SOURCES = features.c
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile features.docs
+EXTRA_DIST =		features.docs

 # ----------------------------------------------------------------------
 # Sofia specific rules
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "http"
 OUTPUT_DIRECTORY     = ../docs/html/http

-INPUT 		     = http.docs sofia-sip . 
+INPUT 		     = @srcdir@/http.docs @srcdir@/sofia-sip sofia-sip @srcdir@ . 

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES            += \
@@ -56,7 +56,7 @@ test_http_LDFLAGS = 	-static
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile http.docs \
+EXTRA_DIST =		http.docs \
 			sofia-sip/http_protos.h.in \
 			sofia-sip/http_tag.h.in \
 			http_parser_table.c.in \
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "ipt"
 OUTPUT_DIRECTORY     = ../docs/html/ips

-INPUT 		     = ipt.docs sofia-sip . 
+INPUT 		     = @srcdir@/ipt.docs @srcdir@/sofia-sip @srcdir@ . 

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES            += ../docs/su.doxytags=../su
@@ -46,7 +46,7 @@ torture_base64_LDFLAGS = -static
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST +=		Doxyfile ipt.docs
+EXTRA_DIST +=		ipt.docs

 # ----------------------------------------------------------------------
 # Sofia specific rules
@@ -1,9 +1,11 @@
 PROJECT_NAME         = "iptsec"
 OUTPUT_DIRECTORY     = ../docs/html/iptsec

-INPUT 		     = iptsec.docs sofia-sip . 
+INPUT 		     = @srcdir@/iptsec.docs @srcdir@/sofia-sip @srcdir@ . 

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf
+@INCLUDE = ../sip/sip.doxyaliases

 TAGFILES           += ../docs/su.doxytags=../su
 TAGFILES           += ../docs/ipt.doxytags=../ipt
@@ -78,7 +78,7 @@ EXTRA_libiptsec_la_SOURCES = \
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST = 		Doxyfile iptsec.docs testpasswd $(BUILT_SOURCES)
+EXTRA_DIST = 		iptsec.docs testpasswd $(BUILT_SOURCES)

 # ----------------------------------------------------------------------
 # Sofia specific rules
@@ -30,7 +30,8 @@
 * @brief Client-side plugin interface for authentication
 * 
 * @note For extensions in 1.12.6 or later, 
- * you have to #define SOFIA_EXTEND_AUTH_CLIENT to 1.
+ * you have to define SOFIA_EXTEND_AUTH_CLIENT to 1
+ * before including this file.
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * 
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "msg"
 OUTPUT_DIRECTORY     = ../docs/html/msg

-INPUT 		     = msg.docs . sofia-sip
+INPUT 		     = @srcdir@/msg.docs @srcdir@/sofia-sip sofia-sip @srcdir@ .

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf
@INCLUDE = ../sip/sip.doxyaliases

@@ -14,4 +15,4 @@ TAGFILES             += ../docs/ipt.doxytags=../ipt  \

 GENERATE_TAGFILE     = ../docs/msg.doxytags

-IMAGE_PATH           += ../sip/images
+IMAGE_PATH           += @srcdir@/../sip/images
@@ -66,7 +66,7 @@ msg_name_hash_LDFLAGS =	-static

 dist_pkgdata_SCRIPTS = 	msg_parser.awk

-EXTRA_DIST =		Doxyfile msg.docs \
+EXTRA_DIST =		msg.docs \
 			sofia-sip/msg_mime_protos.h.in \
 			sofia-sip/msg_protos.h.in \
 			msg_mime_table.c.in \
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "nea"
 OUTPUT_DIRECTORY     = ../docs/html/nea

-INPUT 		     = nea.docs sofia-sip . 
+INPUT 		     = @srcdir@/nea.docs @srcdir@/sofia-sip @srcdir@ . 

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 EXCLUDE_PATTERNS     = test*.c torture*.c
@@ -54,7 +54,7 @@ LDADD = 		libnea.la \
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile nea.docs $(BUILT_SOURCES)
+EXTRA_DIST =		nea.docs $(BUILT_SOURCES)

 # ----------------------------------------------------------------------
 # Sofia specific rules
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "nta"
 OUTPUT_DIRECTORY     = ../docs/html/nta

-INPUT 		     = nta.docs sofia-sip . 
+INPUT 		     = @srcdir@/nta.docs @srcdir@/sofia-sip @srcdir@ . 

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES           += ../docs/su.doxytags=../su
@@ -20,4 +21,5 @@ EXCLUDE_PATTERNS   += sl_*.h sl_*.c nta_compat.*

 ALIASES            +=

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../sip/sip.doxyaliases
@@ -66,7 +66,7 @@ MOSTLYCLEANFILES +=	.test[0-9]*
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile nta.docs sl_utils.docs \
+EXTRA_DIST =		nta.docs sl_utils.docs \
 			agent.pem cafile.pem \
 			invite.msc $(BUILT_SOURCES) 

@@ -1,8 +1,9 @@
 PROJECT_NAME         = "nth"
 OUTPUT_DIRECTORY     = ../docs/html/nth

-INPUT 		     = nth.docs sofia-sip . 
+INPUT 		     = @srcdir@/nth.docs @srcdir@/sofia-sip @srcdir@ . 

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES            += \
@@ -57,7 +57,7 @@ test_nth_LDFLAGS = 	-static
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile nth.docs $(BUILT_SOURCES) \
+EXTRA_DIST =		nth.docs $(BUILT_SOURCES) \
 			agent.pem cafile.pem

 # ----------------------------------------------------------------------
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "nua"
 OUTPUT_DIRECTORY     = ../docs/html/nua

-INPUT 		     = nua.docs . sofia-sip
+INPUT 		     = @srcdir@/nua.docs @srcdir@/sofia-sip @srcdir@ .

+@INCLUDE_PATH 	     = . @srcdir@
@INCLUDE             = ../docs/Doxyfile.conf

 TAGFILES            += ../docs/docs.doxytags=../docs
@@ -92,7 +92,7 @@ test_nua_SOURCES = 	test_nua.c test_nua.h test_ops.c \
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile nua.docs $(BUILT_SOURCES)
+EXTRA_DIST =		nua.docs $(BUILT_SOURCES)

 # ----------------------------------------------------------------------
 # Sofia specific rules
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "sdp"
 OUTPUT_DIRECTORY     = ../docs/html/sdp

-INPUT 		     = sdp.docs .  sofia-sip
+INPUT 		     = @srcdir@/sdp.docs @srcdir@/sofia-sip @srcdir@ .

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES             += ../docs/su.doxytags=../su
@@ -43,7 +43,7 @@ torture_sdp_LDFLAGS = 	-static
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile sdp.docs $(BUILT_SOURCES) \
+EXTRA_DIST =		sdp.docs $(BUILT_SOURCES) \
 			tests/message-1.sdp \
 			tests/message-2.sdp \
 			tests/message-3.sdp \
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "sip"
 OUTPUT_DIRECTORY     = ../docs/html/sip

-INPUT 		     = sofia-sip sip.docs sip_parser.docs .
+INPUT 		     = @srcdir@/sofia-sip sofia-sip @srcdir@/sip.docs @srcdir@/sip_parser.docs @srcdir@ . 

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES            += \
@@ -27,4 +28,4 @@ ALIASES += \

 PREDEFINED += SU_HAVE_EXPERIMENTAL=1

-IMAGE_PATH           += images
+IMAGE_PATH           += @srcdir@/images
@@ -69,7 +69,7 @@ test_date_LDFLAGS = 	-static
 # note: srcdir needs to be specified, otherwise
 #       breaks make distcheck target

-EXTRA_DIST =		Doxyfile sip.docs sip_parser.docs sip.doxyaliases \
+EXTRA_DIST =		sip.docs sip_parser.docs sip.doxyaliases \
 			ADD-A-HEADER GRAMMAR sip_bad_mask \
 			sip_parser_table.c.in sip_tag.c.in \
 			sip_extra_headers.txt \
@@ -1,9 +1,11 @@
 PROJECT_NAME         = "soa"
 OUTPUT_DIRECTORY     = ../docs/html/soa

-INPUT 		     = soa.docs sofia-sip/soa.h sofia-sip/soa_add.h soa.c
-INPUT		    += sofia-sip/soa_tag.h soa_tag.c
+INPUT 		     = @srcdir@/soa.docs @srcdir@/sofia-sip/soa.h 
+INPUT               += @srcdir@/sofia-sip/soa_add.h @srcdir@/soa.c
+INPUT		    += @srcdir@/sofia-sip/soa_tag.h @srcdir@/soa_tag.c

+@INCLUDE_PATH	     = . @srcdir@
@INCLUDE             = ../docs/Doxyfile.conf

 TAGFILES            += ../docs/docs.doxytags=../docs
@@ -53,7 +53,7 @@ test_soa_LDFLAGS = 	-static
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile soa.docs $(BUILT_SOURCES)
+EXTRA_DIST =		soa.docs $(BUILT_SOURCES)

 # ----------------------------------------------------------------------
 # Sofia specific rules
@@ -1,10 +1,11 @@
 PROJECT_NAME         = "sresolv"
 OUTPUT_DIRECTORY     = ../docs/html/sresolv

-INPUT 		     =  sofia-sip sofia-resolv sresolv.docs .
+INPUT 		     =  @srcdir@/sofia-sip @srcdir@/sofia-resolv @srcdir@/sresolv.docs @srcdir@

 EXCLUDE		     = resolve_sip.c

+@INCLUDE_PATH 	     = . @srcdir@
@INCLUDE 	     = ../docs/Doxyfile.conf

 ALIASES             += CFILE="@internal @file" IFILE="@internal @file"
@@ -51,7 +51,7 @@ COVERAGE_INPUT = 	$(libsresolv_la_SOURCES) $(include_sofia_HEADERS)
 # ----------------------------------------------------------------------
 # Distribution

-EXTRA_DIST =		Doxyfile sresolv.docs
+EXTRA_DIST =		sresolv.docs

 dist_noinst_DATA = run_test_sresolv \
 	root.zone rndc.conf \
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "stun"
 OUTPUT_DIRECTORY     = ../docs/html/stun

-INPUT 		     = stun.docs sofia-sip .
+INPUT 		     = @srcdir@/stun.docs @srcdir@/sofia-sip @srcdir@ .

+@INCLUDE_PATH        = . @srcdir@
@INCLUDE 	     = ../docs/Doxyfile.conf

 TAGFILES            += ../docs/su.doxytags=../su
@@ -46,7 +46,7 @@ LDADD = 		libstun.la ../sresolv/libsresolv.la ../su/libsu.la
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile stun.docs cert.pem key.pem
+EXTRA_DIST =		stun.docs cert.pem key.pem

 # ----------------------------------------------------------------------
 # Sofia specific rules
@@ -98,7 +98,7 @@
 * @endcode
 *
 * @section stunc_environment Environment
- * STUN_DEBUG
+ * #STUN_DEBUG
 * 
 * @section stunc_bugs Reporting Bugs
 * Report bugs to <sofia-sip-devel@lists.sourceforge.net>.
@@ -1,9 +1,10 @@
 PROJECT_NAME         = "su"
 OUTPUT_DIRECTORY     = ../docs/html/su

-INPUT 		     = su.docs sofia-sip . 
+INPUT 		     = @srcdir@/su.docs @srcdir@/sofia-sip sofia-sip @srcdir@ .

-@INCLUDE = ../docs/Doxyfile.conf
+@INCLUDE_PATH        = . @srcdir@
+@INCLUDE 	     = ../docs/Doxyfile.conf

 TAGFILES           += ../docs/msg.doxytags=../msg
 TAGFILES           += ../docs/sip.doxytags=../sip
@@ -105,7 +105,7 @@ LDADD = 		libsu.la
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST = 		Doxyfile su.docs \
+EXTRA_DIST = 		su.docs \
 			run_addrinfo run_localinfo run_test_su

 dist_pkgdata_SCRIPTS = 	tag_dll.awk
@@ -63,7 +63,7 @@
 * messages based on message priority.
 *
 * @sa @ref debug_logs, <sofia-sip/su_log.h>, 
- * su_llog(), su_vllog(), #su_log_t, #SU_LOG,
+ * su_llog(), su_vllog(), #su_log_t, #SU_DEBUG,
 * SU_DEBUG_0(), SU_DEBUG_1(), SU_DEBUG_2(), SU_DEBUG_3(), SU_DEBUG_5(), 
 * SU_DEBUG_7(), SU_DEBUG_9()
 */
@@ -157,7 +157,7 @@ struct su_timer_s {
  unsigned char   sut_set;	/**< Timer is set (inserted in tree) */
 };

-/** @internal Timer running status */ 
+/** Timer running status */ 
 enum sut_running {
  reset = 0,		/**< Timer is not running */
  run_at_intervals = 1, /**< Compensate missed wakeup calls */
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "tport"
 OUTPUT_DIRECTORY     = ../docs/html/tport

-INPUT 		     = tport.docs sofia-sip .
+INPUT 		     = @srcdir@/tport.docs @srcdir@/sofia-sip @srcdir@ .

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES            += \
@@ -80,7 +80,7 @@ test_tport_LDFLAGS = 	-static
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile tport.docs \
+EXTRA_DIST =		tport.docs \
 			certificates.html agent.pem cafile.pem

 # ----------------------------------------------------------------------
@@ -1,8 +1,9 @@
 PROJECT_NAME         = "url"
 OUTPUT_DIRECTORY     = ../docs/html/url

-INPUT 		     = url.docs sofia-sip . 
+INPUT 		     = @srcdir@/url.docs @srcdir@/sofia-sip @srcdir@ . 

+@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf

 TAGFILES             += ../docs/su.doxytags=../su
@@ -43,7 +43,7 @@ test_urlmap_CFLAGS =	$(CFLAGS) -DTEST_URLMAP=1
 # ----------------------------------------------------------------------
 # Install and distribution rules

-EXTRA_DIST =		Doxyfile url.docs $(BUILT_SOURCES)
+EXTRA_DIST =		url.docs $(BUILT_SOURCES)

 # ----------------------------------------------------------------------
 # Tests