path: root/doxygen.cfg.in
diff options
authorGerald Combs <gerald@wireshark.org>2013-04-30 00:27:02 +0000
committerGerald Combs <gerald@wireshark.org>2013-04-30 00:27:02 +0000
commit9120bf883e8c093f1298c20d65fc1560d9162ce3 (patch)
tree7668a21e92d486de3bee790a591e497a4946a123 /doxygen.cfg.in
parent160af640582cb895f1ad581e7d3f38c8225b15d0 (diff)
Move the contents of wsar_html/core to wsar_html. Create tag files for
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. svn path=/trunk/; revision=49091
Diffstat (limited to 'doxygen.cfg.in')
1 files changed, 26 insertions, 10 deletions
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.
# 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 = 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
-# 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
+# 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.