Move the contents of wsar_html/core to wsar_html. Create tag files for
authorgerald <gerald@f5534014-38df-0310-8fa8-9805f1628bb7>
Tue, 30 Apr 2013 00:27:02 +0000 (00:27 +0000)
committergerald <gerald@f5534014-38df-0310-8fa8-9805f1628bb7>
Tue, 30 Apr 2013 00:27:02 +0000 (00:27 +0000)
core, epan, and ui, and link them to each other to varying degrees. This
seems to be the best way to organize our documentation. The alternative
is to switch to a single doxygen.cfg and manually add files to different
groups or sections.

Add a wireshark.dox file which contains markup for the main page. Add
.dox and .txt to svnadd. Clean up our tag files. Force wsar_html to
rebuild each time.

git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@49091 f5534014-38df-0310-8fa8-9805f1628bb7

Makefile.am
doxygen.cfg.in
doxygen_global.cfg
epan/Makefile.am
epan/doxygen.cfg.in
tools/svnadd
ui/Makefile.am
ui/doxygen.cfg.in
wireshark.dox [new file with mode: 0644]

index d41a542d08a0f55059f2426bcae07b643e6c1710..5b16135d8210af11111d4f787200cd74d7b8b075 100644 (file)
@@ -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
index b453233e90dadf5b9d8e63d924f090b6bd6fbc09..cc43eea109a38b801e348943ef0029f539d3176d 100644 (file)
@@ -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. 
index 849c2eb6557517895b518fe3adc29f6070b0d0e1..d9164900408a61a2401e6e78bba33c46b10cbfb5 100644 (file)
@@ -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
index 91c7688373a5e3ea25ef896a8cc2a78bc12ccd8f..e7758e4c4285d13ed2fdc951d3e6370c0ee18c58 100644 (file)
@@ -113,6 +113,7 @@ EXTRA_DIST = \
        CMakeLists.txt
 
 CLEANFILES = \
+       doxygen-epan.tag                \
        libwireshark.a                  \
        libwireshark.la                 \
        libwireshark_generated.a        \
index 8dc08d769ac4b23a2d7c44d58faa9da8c1c39ebe..cb34de888ccfc88aa9342f90791fe23f5fe18223 100644 (file)
@@ -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. 
index 911a97cf975f1cb76daade9d56e22e1bdf33f46a..badf6dfb924ace225b22febeb3757f2d6eb98131 100755 (executable)
@@ -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
index e382ea83e4a5588035fe641a590013fa4a6c87e6..a1f14cd73e5cbe966916b0a7f897e2e3146feed3 100644 (file)
@@ -32,6 +32,7 @@ endif
 noinst_LIBRARIES = libui.a libui_dirty.a
 
 CLEANFILES = \
+       doxygen-ui.tag  \
        libui.a         \
        libui_dirty.a   \
        *~
index 1f8d325a721b3320abdf9fcb31694b6b2538f831..3fe5d5f6d874ffc5ec0e2996a215f9bab57b1e1b 100644 (file)
@@ -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 (file)
index 0000000..432e0bb
--- /dev/null
@@ -0,0 +1,7 @@
+/**
+
+@mainpage
+
+This is the Wireshark documentation.
+
+*/