summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--Makefile.am6
-rw-r--r--doxygen.cfg.in36
-rw-r--r--doxygen_global.cfg4
-rw-r--r--epan/Makefile.am1
-rw-r--r--epan/doxygen.cfg.in35
-rwxr-xr-xtools/svnadd2
-rw-r--r--ui/Makefile.am1
-rw-r--r--ui/doxygen.cfg.in39
-rw-r--r--wireshark.dox7
9 files changed, 90 insertions, 41 deletions
diff --git a/Makefile.am b/Makefile.am
index d41a542d08..5b16135d82 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -570,6 +570,7 @@ services:
CLEANFILES = \
*~ \
+ doxygen-core.tag \
vgcore.*
#
@@ -1151,11 +1152,12 @@ checkapi: checkapi_local
cd plugins && $(MAKE) checkapi
cd wsutil && $(MAKE) checkapi
-wsar_html: doxygen.cfg doxygen_global.cfg
+wsar_html: doxygen.cfg doxygen_global.cfg FORCE
if HAVE_DOXYGEN
- (umask 022 ; $(DOXYGEN) doxygen.cfg)
+ rm -rf wsar_html
cd epan && $(MAKE) $@
cd ui && $(MAKE) $@
+ (umask 022 ; $(DOXYGEN) doxygen.cfg)
endif
wsar-zip: wsar_html
diff --git a/doxygen.cfg.in b/doxygen.cfg.in
index b453233e90..cc43eea109 100644
--- a/doxygen.cfg.in
+++ b/doxygen.cfg.in
@@ -19,13 +19,13 @@ PROJECT_NUMBER = @VERSION@
# 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 = wsar_html
+OUTPUT_DIRECTORY = .
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
-HTML_OUTPUT = core
+HTML_OUTPUT = wsar_html
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
@@ -34,14 +34,30 @@ HTML_OUTPUT = core
INPUT = .
-# If the value of the INPUT tag contains directories, you can use the
-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank the following patterns are tested:
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
-# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
-
-FILE_PATTERNS =
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES = epan/doxygen-epan.tag=epan \
+ ui/doxygen-ui.tag=ui
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE = doxygen-core.tag
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
diff --git a/doxygen_global.cfg b/doxygen_global.cfg
index 849c2eb655..d916490040 100644
--- a/doxygen_global.cfg
+++ b/doxygen_global.cfg
@@ -598,7 +598,7 @@ INPUT_ENCODING = UTF-8
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
-FILE_PATTERNS =
+FILE_PATTERNS = *.dox *.h
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@@ -1412,7 +1412,7 @@ TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
-GENERATE_TAGFILE =
+GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
diff --git a/epan/Makefile.am b/epan/Makefile.am
index 91c7688373..e7758e4c42 100644
--- a/epan/Makefile.am
+++ b/epan/Makefile.am
@@ -113,6 +113,7 @@ EXTRA_DIST = \
CMakeLists.txt
CLEANFILES = \
+ doxygen-epan.tag \
libwireshark.a \
libwireshark.la \
libwireshark_generated.a \
diff --git a/epan/doxygen.cfg.in b/epan/doxygen.cfg.in
index 8dc08d769a..cb34de888c 100644
--- a/epan/doxygen.cfg.in
+++ b/epan/doxygen.cfg.in
@@ -32,16 +32,31 @@ HTML_OUTPUT = epan
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT =
-
-# If the value of the INPUT tag contains directories, you can use the
-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank the following patterns are tested:
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
-# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
-
-FILE_PATTERNS = *.h
+INPUT = .
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES = ../doxygen-core.tag=..
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE = doxygen-epan.tag
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
diff --git a/tools/svnadd b/tools/svnadd
index 911a97cf97..badf6dfb92 100755
--- a/tools/svnadd
+++ b/tools/svnadd
@@ -40,7 +40,7 @@ do
svn add $file
case "$file" in
- *.asciidoc)
+ *.asciidoc|*.dox|*.txt)
svn ps svn:keywords Id $file
svn ps svn:eol-style native $file
svn ps svn:mime-type text/plain $file
diff --git a/ui/Makefile.am b/ui/Makefile.am
index e382ea83e4..a1f14cd73e 100644
--- a/ui/Makefile.am
+++ b/ui/Makefile.am
@@ -32,6 +32,7 @@ endif
noinst_LIBRARIES = libui.a libui_dirty.a
CLEANFILES = \
+ doxygen-ui.tag \
libui.a \
libui_dirty.a \
*~
diff --git a/ui/doxygen.cfg.in b/ui/doxygen.cfg.in
index 1f8d325a72..3fe5d5f6d8 100644
--- a/ui/doxygen.cfg.in
+++ b/ui/doxygen.cfg.in
@@ -27,22 +27,29 @@ OUTPUT_DIRECTORY = ../wsar_html
HTML_OUTPUT = ui
-# The INPUT tag can be used to specify the files and/or directories that contain
-# documented source files. You may enter file names like "myfile.cpp" or
-# directories like "/usr/src/myproject". Separate the files or directories
-# with spaces.
-
-INPUT = . alert_box.h last_open_dir.h main_statusbar.h progress_dlg.h recent.h recent_utils.h simple_dialog.h ui_util.h util.h
-
-
-# If the value of the INPUT tag contains directories, you can use the
-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank the following patterns are tested:
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
-# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
-
-FILE_PATTERNS = *.h
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES = ../doxygen-core.tag=..
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE = doxygen-ui.tag
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
diff --git a/wireshark.dox b/wireshark.dox
new file mode 100644
index 0000000000..432e0bb6dc
--- /dev/null
+++ b/wireshark.dox
@@ -0,0 +1,7 @@
+/**
+
+@mainpage
+
+This is the Wireshark documentation.
+
+*/
generated by cgit v1.2.1 (git 2.18.0) at 2024-05-30 17:18:44 +0000