From ad84eec866713b2f75e9b11a30468b81be7d3d5e Mon Sep 17 00:00:00 2001 From: Gerald Combs Date: Mon, 16 Apr 2018 14:49:55 -0700 Subject: Switch the Doxygen API reference build to CMake. Switch to a single Doyxgen configuration which was generated using a recent version of Doxygen and customized to suit our needs. Add wsar_html and wsar_html_zip targets to CMake. Update some Doxygen markup and documentation as needed. Change-Id: Ic8a424b292c35a26f74ae0b53322265683e56e69 Reviewed-on: https://code.wireshark.org/review/26976 Reviewed-by: Gerald Combs Petri-Dish: Gerald Combs Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman --- ui/doxygen.cfg.in | 81 ---------------------------------------------------- ui/gtk/main.h | 26 ----------------- ui/qt/doxygen.cfg.in | 67 ------------------------------------------- ui/qt/main_window.h | 26 +++++++++++++++++ 4 files changed, 26 insertions(+), 174 deletions(-) delete mode 100644 ui/doxygen.cfg.in delete mode 100644 ui/qt/doxygen.cfg.in (limited to 'ui') diff --git a/ui/doxygen.cfg.in b/ui/doxygen.cfg.in deleted file mode 100644 index c0f8e81a42..0000000000 --- a/ui/doxygen.cfg.in +++ /dev/null @@ -1,81 +0,0 @@ -# @configure_input@ - -@INCLUDE = ../doxygen_global.cfg - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = "Wireshark Common UI" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = @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 = ../wsar_html - -# 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 = ui - -# 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. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories -# that are symbolic links (a Unix filesystem feature) are excluded from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. - -EXCLUDE_PATTERNS = - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = wireshark-ui.chm diff --git a/ui/gtk/main.h b/ui/gtk/main.h index 6444dfad6b..2467a193fc 100644 --- a/ui/gtk/main.h +++ b/ui/gtk/main.h @@ -26,32 +26,6 @@ #include "cfile.h" #include "capture_opts.h" -/** @defgroup main_window_group Main window - * The main window has the following submodules: - @dot - digraph main_dependencies { - node [shape=record, fontname=Helvetica, fontsize=10]; - main [ label="main window" URL="\ref main.h"]; - menu [ label="menubar" URL="\ref menus.h"]; - toolbar [ label="toolbar" URL="\ref main_toolbar.h"]; - packet_list [ label="packet list pane" URL="\ref packet_list.h"]; - proto_draw [ label="packet details & bytes panes" URL="\ref main_proto_draw.h"]; - recent [ label="recent user settings" URL="\ref recent.h"]; - main -> menu [ arrowhead="open", style="solid" ]; - main -> toolbar [ arrowhead="open", style="solid" ]; - main -> packet_list [ arrowhead="open", style="solid" ]; - main -> proto_draw [ arrowhead="open", style="solid" ]; - main -> recent [ arrowhead="open", style="solid" ]; - } - @enddot - */ - -/** @file - * The main window, filter toolbar, program start/stop and a lot of other things - * @ingroup main_window_group - * @ingroup windows_group - */ - /** Global compile time version string */ extern void get_wireshark_gtk_compiled_info(GString *str); extern void get_gui_compiled_info(GString *str); diff --git a/ui/qt/doxygen.cfg.in b/ui/qt/doxygen.cfg.in deleted file mode 100644 index d4e63ab8a8..0000000000 --- a/ui/qt/doxygen.cfg.in +++ /dev/null @@ -1,67 +0,0 @@ -# @configure_input@ - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = Wireshark-QT - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = @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 = - -# 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 = . ../progress_dlg.h ../simple_dialog.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 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. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories -# that are symbolic links (a Unix filesystem feature) are excluded from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. - -EXCLUDE_PATTERNS = - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = wireshark-qt.chm - -@INCLUDE = ../../doxygen_global.cfg diff --git a/ui/qt/main_window.h b/ui/qt/main_window.h index 9d1e056d99..daa0bdb137 100644 --- a/ui/qt/main_window.h +++ b/ui/qt/main_window.h @@ -10,6 +10,32 @@ #ifndef MAINWINDOW_H #define MAINWINDOW_H +/** @defgroup main_window_group Main window + * The main window has the following submodules: + @dot + digraph main_dependencies { + node [shape=record, fontname=Helvetica, fontsize=10]; + main [ label="main window" URL="\ref main.h"]; + menu [ label="menubar" URL="\ref menus.h"]; + toolbar [ label="toolbar" URL="\ref main_toolbar.h"]; + packet_list [ label="packet list pane" URL="\ref packet_list.h"]; + proto_draw [ label="packet details & bytes panes" URL="\ref main_proto_draw.h"]; + recent [ label="recent user settings" URL="\ref recent.h"]; + main -> menu [ arrowhead="open", style="solid" ]; + main -> toolbar [ arrowhead="open", style="solid" ]; + main -> packet_list [ arrowhead="open", style="solid" ]; + main -> proto_draw [ arrowhead="open", style="solid" ]; + main -> recent [ arrowhead="open", style="solid" ]; + } + @enddot + */ + +/** @file + * The main window + * @ingroup main_window_group + * @ingroup windows_group + */ + #include #include -- cgit v1.2.3