summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPerry Ismangil <perry@teluu.com>2011-07-19 21:42:58 +0000
committerPerry Ismangil <perry@teluu.com>2011-07-19 21:42:58 +0000
commit6ad90be1df339da1ae65328c738d60e142b13efe (patch)
treeb14aaf27ad7b0cbc1ced148200b7942d66e371b7
parentbbbd60d82b63c214eb9ac1a4a716393b06cc3217 (diff)
Re #1254 Doxygen configuration and makefile changes to support version specific documentation
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@3669 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat
-rw-r--r--Makefile4
-rw-r--r--pjlib-util/build/Makefile13
-rw-r--r--pjlib-util/docs/doxygen.cfg4
-rw-r--r--pjlib-util/docs/header.html2
-rw-r--r--pjlib/build/Makefile14
-rw-r--r--pjlib/docs/doxygen.cfg4
-rw-r--r--pjlib/docs/header.html2
-rw-r--r--pjmedia/build/Makefile14
-rw-r--r--pjmedia/docs/doxygen.cfg4
-rw-r--r--pjmedia/docs/header.html2
-rw-r--r--pjnath/build/Makefile13
-rw-r--r--pjnath/docs/doxygen.cfg4
-rw-r--r--pjnath/docs/header.html2
-rw-r--r--pjsip/build/Makefile13
-rw-r--r--pjsip/docs/doxygen.cfg4
-rw-r--r--pjsip/docs/header.html2
16 files changed, 62 insertions, 39 deletions
diff --git a/Makefile b/Makefile
index 51459931..dcfe0b1f 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,7 @@
include build.mak
include build/host-$(HOST_NAME).mak
-include user.mak
+include version.mak
DIRS = pjlib/build pjlib-util/build pjnath/build third_party/build pjmedia/build pjsip/build pjsip-apps/build $(EXTRA_DIRS)
@@ -23,7 +24,7 @@ doc:
exit 1; \
fi
for dir in $(DIRS); do \
- if $(MAKE) $(MAKE_FLAGS) -C $$dir/build $@; then \
+ if $(MAKE) $(MAKE_FLAGS) -C $$dir $@; then \
true; \
else \
exit 1; \
@@ -92,7 +93,6 @@ pjsua-test:
cd tests/pjsua && python runall.py
prefix = $(ac_prefix)
-include version.mak
install:
mkdir -p $(DESTDIR)$(prefix)/lib
diff --git a/pjlib-util/build/Makefile b/pjlib-util/build/Makefile
index 69e92b41..fba93bb3 100644
--- a/pjlib-util/build/Makefile
+++ b/pjlib-util/build/Makefile
@@ -3,6 +3,7 @@
export UTIL_TEST_OBJS = main.o
include ../../build.mak
+include ../../version.mak
include $(PJDIR)/build/common.mak
RULES_MAK := $(PJDIR)/build/rules.mak
@@ -55,10 +56,14 @@ TARGETS := pjlib-util pjlib-util-test
all: $(TARGETS)
doc:
- cd .. && rm -rf docs/html docs/latex && doxygen docs/doxygen.cfg
- @if [ -n "$(WWWDIR)" ]; then \
- echo "Copying to $(WWWDIR)/pjlib-util/docs/html.." ; \
- cp -a ../docs/html/* $(WWWDIR)/pjlib-util/docs/html/ ; \
+ cd .. && rm -rf docs/$(PJ_VERSION) && doxygen docs/doxygen.cfg
+ @if [ -n "$(WWWDIR)" ] && ! [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjlib-util/docs/html" ] ; then \
+ echo "Creating docs/$(PJ_VERSION)/pjlib-util/docs/html" ; \
+ mkdir -p $(WWWDIR)/docs/$(PJ_VERSION)/pjlib-util/docs/html ; \
+ fi
+ @if [ -n "$(WWWDIR)" ] && [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjlib-util/docs/html" ] ; then \
+ echo "Copying docs/$(PJ_VERSION) to $(WWWDIR)/docs/$(PJ_VERSION)/pjlib-util/docs/html.." ; \
+ cp -v -a ../docs/$(PJ_VERSION)/html/* $(WWWDIR)/docs/$(PJ_VERSION)/pjlib-util/docs/html/ ; \
fi
dep: depend
diff --git a/pjlib-util/docs/doxygen.cfg b/pjlib-util/docs/doxygen.cfg
index 1c2e15de..402e2dd4 100644
--- a/pjlib-util/docs/doxygen.cfg
+++ b/pjlib-util/docs/doxygen.cfg
@@ -23,14 +23,14 @@ PROJECT_NAME = "PJLIB-UTIL Reference"
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER = $(PJ_VERSION)
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = docs
+OUTPUT_DIRECTORY = docs/$(PJ_VERSION)
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
diff --git a/pjlib-util/docs/header.html b/pjlib-util/docs/header.html
index 111bd62f..12ca4aa5 100644
--- a/pjlib-util/docs/header.html
+++ b/pjlib-util/docs/header.html
@@ -1,6 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>$title</title>
+<title>$title ($projectnumber)</title>
<link href="/style/style.css" rel="stylesheet" type="text/css">
</head><body>
<!--#include virtual="/header.html" -->
diff --git a/pjlib/build/Makefile b/pjlib/build/Makefile
index 6e95003e..91836445 100644
--- a/pjlib/build/Makefile
+++ b/pjlib/build/Makefile
@@ -1,4 +1,5 @@
include ../../build.mak
+include ../../version.mak
include $(PJDIR)/build/common.mak
RULES_MAK := $(PJDIR)/build/rules.mak
@@ -57,12 +58,15 @@ export CC_OUT CC AR RANLIB HOST_MV HOST_RM HOST_RMDIR HOST_MKDIR OBJEXT LD LDOUT
all: $(TARGETS)
doc:
- cd .. && rm -rf docs/html docs/latex && doxygen docs/doxygen.cfg
- @if [ -n "$(WWWDIR)" ]; then \
- echo "Copying to $(WWWDIR)/pjlib/docs/html.." ; \
- cp -a ../docs/html/* $(WWWDIR)/pjlib/docs/html/ ; \
+ cd .. && rm -rf docs/$(PJ_VERSION) && doxygen docs/doxygen.cfg
+ @if [ -n "$(WWWDIR)" ] && ! [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjlib/docs/html" ] ; then \
+ echo "Creating docs/$(PJ_VERSION)/pjlib/docs/html" ; \
+ mkdir -p $(WWWDIR)/docs/$(PJ_VERSION)/pjlib/docs/html ; \
+ fi
+ @if [ -n "$(WWWDIR)" ] && [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjlib/docs/html" ] ; then \
+ echo "Copying docs/$(PJ_VERSION) to $(WWWDIR)/docs/$(PJ_VERSION)/pjlib/docs/html.." ; \
+ cp -v -a ../docs/$(PJ_VERSION)/html/* $(WWWDIR)/docs/$(PJ_VERSION)/pjlib/docs/html/ ; \
fi
-
print:
$(MAKE) -f $(RULES_MAK) APP=PJLIB app=pjlib print_lib
$(MAKE) -f $(RULES_MAK) APP=TEST app=pjlib-test print_bin
diff --git a/pjlib/docs/doxygen.cfg b/pjlib/docs/doxygen.cfg
index 6b6a8d3e..88a032d8 100644
--- a/pjlib/docs/doxygen.cfg
+++ b/pjlib/docs/doxygen.cfg
@@ -23,14 +23,14 @@ PROJECT_NAME = "PJLIB Reference"
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER = $(PJ_VERSION)
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = docs
+OUTPUT_DIRECTORY = docs/$(PJ_VERSION)
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
diff --git a/pjlib/docs/header.html b/pjlib/docs/header.html
index 5517dc34..60db3f71 100644
--- a/pjlib/docs/header.html
+++ b/pjlib/docs/header.html
@@ -1,6 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>$title</title>
+<title>$title ($projectnumber)</title>
<link href="/style/style.css" rel="stylesheet" type="text/css">
</head><body>
<!--#include virtual="/header.html" -->
diff --git a/pjmedia/build/Makefile b/pjmedia/build/Makefile
index 902a9630..afe6546a 100644
--- a/pjmedia/build/Makefile
+++ b/pjmedia/build/Makefile
@@ -1,4 +1,5 @@
include ../../build.mak
+include ../../version.mak
THIRD_PARTY:=$(PJDIR)/third_party
@@ -141,11 +142,14 @@ TARGETS := pjmedia pjmedia-videodev pjmedia-audiodev pjmedia-codec pjsdp pjmedia
all: $(TARGETS)
doc:
- cd .. && rm -rf docs/html docs/latex && doxygen docs/doxygen.cfg
- @if [ -n "$(WWWDIR)" ]; then \
- echo "Copying to $(WWWDIR)/pjmedia/docs/html.." ; \
- rm -rf $(WWWDIR)/pjmedia/docs/html/* ; \
- cp -a ../docs/html/* $(WWWDIR)/pjmedia/docs/html/ ; \
+ cd .. && rm -rf docs/$(PJ_VERSION) && doxygen docs/doxygen.cfg
+ @if [ -n "$(WWWDIR)" ] && ! [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjmedia/docs/html" ] ; then \
+ echo "Creating docs/$(PJ_VERSION)/pjmedia/docs/html" ; \
+ mkdir -p $(WWWDIR)/docs/$(PJ_VERSION)/pjmedia/docs/html ; \
+ fi
+ @if [ -n "$(WWWDIR)" ] && [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjmedia/docs/html" ] ; then \
+ echo "Copying docs/$(PJ_VERSION) to $(WWWDIR)/docs/$(PJ_VERSION)/pjmedia/docs/html.." ; \
+ cp -v -a ../docs/$(PJ_VERSION)/html/* $(WWWDIR)/docs/$(PJ_VERSION)/pjmedia/docs/html/ ; \
fi
dep: depend
diff --git a/pjmedia/docs/doxygen.cfg b/pjmedia/docs/doxygen.cfg
index ecd5f275..643260a0 100644
--- a/pjmedia/docs/doxygen.cfg
+++ b/pjmedia/docs/doxygen.cfg
@@ -23,14 +23,14 @@ PROJECT_NAME = "PJMEDIA Reference"
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER = $(PJ_VERSION)
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = docs
+OUTPUT_DIRECTORY = docs/$(PJ_VERSION)
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
diff --git a/pjmedia/docs/header.html b/pjmedia/docs/header.html
index 61d5c99d..4b78a041 100644
--- a/pjmedia/docs/header.html
+++ b/pjmedia/docs/header.html
@@ -1,6 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>$title</title>
+<title>$title ($projectnumber)</title>
<link href="/style/style.css" rel="stylesheet" type="text/css">
</head><body>
<!--#include virtual="/header.html" -->
diff --git a/pjnath/build/Makefile b/pjnath/build/Makefile
index 46fda2ff..573d9579 100644
--- a/pjnath/build/Makefile
+++ b/pjnath/build/Makefile
@@ -3,6 +3,7 @@
export PJNATH_TEST_OBJS = main.o
include ../../build.mak
+include ../../version.mak
include $(PJDIR)/build/common.mak
RULES_MAK := $(PJDIR)/build/rules.mak
@@ -78,10 +79,14 @@ TARGETS := pjnath pjnath-test pjturn-client pjturn-srv
all: $(TARGETS)
doc:
- cd .. && rm -rf docs/html docs/latex && doxygen docs/doxygen.cfg
- @if [ -n "$(WWWDIR)" ]; then \
- echo "Copying to $(WWWDIR)/pjnath/docs/html.." ; \
- cp -a ../docs/html/* $(WWWDIR)/pjnath/docs/html/ ; \
+ cd .. && rm -rf docs/$(PJ_VERSION) && doxygen docs/doxygen.cfg
+ @if [ -n "$(WWWDIR)" ] && ! [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjnath/docs/html" ] ; then \
+ echo "Creating docs/$(PJ_VERSION)/pjnath/docs/html" ; \
+ mkdir -p $(WWWDIR)/docs/$(PJ_VERSION)/pjnath/docs/html ; \
+ fi
+ @if [ -n "$(WWWDIR)" ] && [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjnath/docs/html" ] ; then \
+ echo "Copying docs/$(PJ_VERSION) to $(WWWDIR)/docs/$(PJ_VERSION)/pjnath/docs/html.." ; \
+ cp -v -a ../docs/$(PJ_VERSION)/html/* $(WWWDIR)/docs/$(PJ_VERSION)/pjnath/docs/html/ ; \
fi
dep: depend
diff --git a/pjnath/docs/doxygen.cfg b/pjnath/docs/doxygen.cfg
index 9a75d091..70bf6f7e 100644
--- a/pjnath/docs/doxygen.cfg
+++ b/pjnath/docs/doxygen.cfg
@@ -23,14 +23,14 @@ PROJECT_NAME = "PJNATH Reference"
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER = $(PJ_VERSION)
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = docs
+OUTPUT_DIRECTORY = docs/$(PJ_VERSION)
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
diff --git a/pjnath/docs/header.html b/pjnath/docs/header.html
index 40d412d4..4d7e2636 100644
--- a/pjnath/docs/header.html
+++ b/pjnath/docs/header.html
@@ -1,6 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>$title</title>
+<title>$title ($projectnumber)</title>
<link href="/style/style.css" rel="stylesheet" type="text/css">
</head><body>
<!--#include virtual="/header.html" -->
diff --git a/pjsip/build/Makefile b/pjsip/build/Makefile
index 247ee7f4..fc96b698 100644
--- a/pjsip/build/Makefile
+++ b/pjsip/build/Makefile
@@ -4,6 +4,7 @@
export TEST_OBJS = main.o
include ../../build.mak
+include ../../version.mak
include $(PJDIR)/build/common.mak
RULES_MAK := $(PJDIR)/build/rules.mak
@@ -110,10 +111,14 @@ TARGETS := pjsip pjsip-ua pjsip-simple pjsua-lib pjsip-test
all: $(TARGETS)
doc:
- cd .. && rm -rf docs/html docs/latex && doxygen docs/doxygen.cfg
- @if [ -n "$(WWWDIR)" ]; then \
- echo "Copying to $(WWWDIR)/pjsip/docs/html.." ; \
- cp -a ../docs/html/* $(WWWDIR)/pjsip/docs/html/ ; \
+ cd .. && rm -rf docs/$(PJ_VERSION) && doxygen docs/doxygen.cfg
+ @if [ -n "$(WWWDIR)" ] && ! [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjsip/docs/html" ] ; then \
+ echo "Creating docs/$(PJ_VERSION)/pjsip/docs/html" ; \
+ mkdir -p $(WWWDIR)/docs/$(PJ_VERSION)/pjsip/docs/html ; \
+ fi
+ @if [ -n "$(WWWDIR)" ] && [ -d "$(WWWDIR)/docs/$(PJ_VERSION)/pjsip/docs/html" ] ; then \
+ echo "Copying docs/$(PJ_VERSION) to $(WWWDIR)/docs/$(PJ_VERSION)/pjsip/docs/html.." ; \
+ cp -v -a ../docs/$(PJ_VERSION)/html/* $(WWWDIR)/docs/$(PJ_VERSION)/pjsip/docs/html/ ; \
fi
dep: depend
diff --git a/pjsip/docs/doxygen.cfg b/pjsip/docs/doxygen.cfg
index d6c23185..cd3f8e4c 100644
--- a/pjsip/docs/doxygen.cfg
+++ b/pjsip/docs/doxygen.cfg
@@ -23,14 +23,14 @@ PROJECT_NAME = "PJSIP Reference"
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER = $(PJ_VERSION)
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = docs
+OUTPUT_DIRECTORY = docs/$(PJ_VERSION)
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
diff --git a/pjsip/docs/header.html b/pjsip/docs/header.html
index 767dbaa4..cb930206 100644
--- a/pjsip/docs/header.html
+++ b/pjsip/docs/header.html
@@ -1,6 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>$title</title>
+<title>$title ($projectnumber)</title>
<link href="/style/style.css" rel="stylesheet" type="text/css">
</head><body>
<!--#include virtual="/header.html" -->
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-16 09:21:39 +0000