diff --git a/BlueBerry/Bundles/org.blueberry.compat/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.compat/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..144ea564d0 --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.compat/documentation/doxygen/modules.dox @@ -0,0 +1,18 @@ +/** + \defgroup org_blueberry_compat org.blueberry.compat + \ingroup BlueBerryPlugins + + \brief Track CTK plug-ins and register their extensions and extension-points. + + This plug-in listens to CTK plug-in events and populates the BlueBerry extension + registry with entries from the plug-ins embedded plugin.xml files. +*/ + +/** + \defgroup org_blueberry_compat_internal Internal + \ingroup org_blueberry_compat + + \brief This subcategory includes the internal classes of the org.blueberry.compat plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.core.commands/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.core.commands/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..736f33263a --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.core.commands/documentation/doxygen/modules.dox @@ -0,0 +1,16 @@ +/** + \defgroup org_blueberry_core_commands org.blueberry.core.commands + \ingroup BlueBerryPlugins + + \brief Provides an infrastructure for executing commands in the Workbench. + +*/ + +/** + \defgroup org_blueberry_core_commands_internal Internal + \ingroup org_blueberry_core_commands + + \brief This subcategory includes the internal classes of the org.blueberry.core.commands plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.core.expressions/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.core.expressions/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..000328274f --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.core.expressions/documentation/doxygen/modules.dox @@ -0,0 +1,16 @@ +/** + \defgroup org_blueberry_core_expressions org.blueberry.core.expressions + \ingroup BlueBerryPlugins + + \brief Evaluates complex expressions defined in XML. + +*/ + +/** + \defgroup org_blueberry_core_expressions_internal Internal + \ingroup org_blueberry_core_expressions + + \brief This subcategory includes the internal classes of the org.blueberry.core.expressions plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.core.jobs/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.core.jobs/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..176b176704 --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.core.jobs/documentation/doxygen/modules.dox @@ -0,0 +1,16 @@ +/** + \defgroup org_blueberry_core_jobs org.blueberry.core.jobs + \ingroup BlueBerryPlugins + + \brief A generic jobs API for running background tasks in a BlueBerry application. + +*/ + +/** + \defgroup org_blueberry_core_jobs_internal Internal + \ingroup org_blueberry_core_jobs + + \brief This subcategory includes the internal classes of the org.blueberry.core.jobs plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.core.runtime/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..5508603d74 --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.core.runtime/documentation/doxygen/modules.dox @@ -0,0 +1,16 @@ +/** + \defgroup org_blueberry_core_runtime org.blueberry.core.runtime + \ingroup BlueBerryPlugins + + \brief Provides runtime services like preferences. + +*/ + +/** + \defgroup org_blueberry_core_runtime_internal Internal + \ingroup org_blueberry_core_runtime + + \brief This subcategory includes the internal classes of the org.blueberry.core.runtime plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.osgi/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.osgi/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..da7c1015aa --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.osgi/documentation/doxygen/modules.dox @@ -0,0 +1,18 @@ +/** + \defgroup org_blueberry_osgi org.blueberry.osgi + \ingroup BlueBerryPlugins + + \brief The partial BlueBerry OSGi implementation. + + Most of the functionality of this plug-in has been superseded by the CTK Plugin Framework + and is only kept for backwards compatibility. +*/ + +/** + \defgroup org_blueberry_osgi_internal Internal + \ingroup org_blueberry_osgi + + \brief This subcategory includes the internal classes of the org.blueberry.osgi plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.solstice.common/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.solstice.common/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..913ef08927 --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.solstice.common/documentation/doxygen/modules.dox @@ -0,0 +1,16 @@ +/** + \defgroup org_blueberry_solstice_common org.blueberry.solstice.common + \ingroup BlueBerryPlugins + + \brief Provides common functionality like status handling of method calls. + +*/ + +/** + \defgroup org_blueberry_solstice_common_internal Internal + \ingroup org_blueberry_solstice_common + + \brief This subcategory includes the internal classes of the org.blueberry.solstice.common plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.test/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.test/documentation/doxygen/modules.dox index 15d1afa735..f15b97ba2a 100644 --- a/BlueBerry/Bundles/org.blueberry.test/documentation/doxygen/modules.dox +++ b/BlueBerry/Bundles/org.blueberry.test/documentation/doxygen/modules.dox @@ -1,16 +1,16 @@ /** \defgroup org_blueberry_test org.blueberry.test \ingroup BlueBerryPlugins - \brief Describe your plugin here. + \brief Testing infrastructure for running unit tests defined in BlueBerry plug-ins. */ /** \defgroup org_blueberry_test_internal Internal \ingroup org_blueberry_test \brief This subcategory includes the internal classes of the org.blueberry.test plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it. */ diff --git a/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/blueberrylogview.dox b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/blueberrylogview.dox index dbde26a7f5..92453eb6f4 100644 --- a/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/blueberrylogview.dox +++ b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/blueberrylogview.dox @@ -1,16 +1,16 @@ /** -\page org_blueberry_ui_qt_log The Logging Module +\page org_blueberry_ui_qt_log The Logging Plugin \image html Logging.png "Icon of the Module" -The Plug-In "Logging Module" records all logging output of events and progress as specified in the source code with time of occurence, level of importance (Info, Warning, Error, Fatal, Debug), the message given and where it happens. The logging starts once you activate the Plug-In in your main application. A screenshot of the main view of the Logging Module is shown next. +This plug-in records all logging output of events and progress as specified in the source code with time of occurence, level of importance (Info, Warning, Error, Fatal, Debug), the message given and where it happens. The logging starts once the plug-is started. A screenshot of the provided Logging view is shown next. \image html LogView.png "Screenshot of the Logging Module" There are different features available in the view. The filter text field allows for searching all log events containing a certain substring. Using the button "Copy to clipboard" on the bottom right you can copy the current content of the logging view to your clipboard. This enables you to insert the logging information to any text processing application. You can also show more information on every logging message by activating the two checkboxes. In the simple view, leaving both checkboxes unchecked, you'll see logging messages and logging levels. A brief description of the logging levels can be found in the \ref LoggingPage "logging concept documentation". The checkbox "Category" adds a column for the category. The checkbox "Show Advanced Field" shows method, filename and linenumber where the logging message was emitted as well as the running time of the application. The next figure shows all information which can be shown in the Logging Module. \image html LogViewExplain.png "Details on the Vizualized Logging Information" -*/ \ No newline at end of file +*/ diff --git a/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..6a7ace0f6b --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/doxygen/modules.dox @@ -0,0 +1,16 @@ +/** + \defgroup org_blueberry_ui_qt_log org.blueberry.ui.qt.log + \ingroup BlueBerryPlugins + + \brief Provides a Logging View for BlueBerry applications. + +*/ + +/** + \defgroup org_blueberry_ui_qt_log_internal Internal + \ingroup org_blueberry_ui_qt_log + + \brief This subcategory includes the internal classes of the org.blueberry.ui.qt.log plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.ui.qt.objectinspector/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.ui.qt.objectinspector/documentation/doxygen/modules.dox index 9a37cee3c1..b54679971a 100644 --- a/BlueBerry/Bundles/org.blueberry.ui.qt.objectinspector/documentation/doxygen/modules.dox +++ b/BlueBerry/Bundles/org.blueberry.ui.qt.objectinspector/documentation/doxygen/modules.dox @@ -1,16 +1,17 @@ /** \defgroup org_blueberry_ui_qt_objectinspector org.blueberry.ui.qt.objectinspector \ingroup BlueBerryPlugins - \brief Describe your plugin here. + \brief A debugging plug-in providing a BlueBerry View for inspecting berry::Object + instances and their associated smart-pointers. */ /** \defgroup org_blueberry_ui_qt_objectinspector_internal Internal \ingroup org_blueberry_ui_qt_objectinspector \brief This subcategory includes the internal classes of the org.blueberry.ui.qt.objectinspector plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it. */ diff --git a/BlueBerry/Bundles/org.blueberry.ui.qt/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.ui.qt/documentation/doxygen/modules.dox new file mode 100644 index 0000000000..a45832401a --- /dev/null +++ b/BlueBerry/Bundles/org.blueberry.ui.qt/documentation/doxygen/modules.dox @@ -0,0 +1,17 @@ +/** + \defgroup org_blueberry_ui_qt org.blueberry.ui.qt + \ingroup BlueBerryPlugins + + \brief The Qt dependent user interface plug-in providing support for + creating Qt based workbench applications. + +*/ + +/** + \defgroup org_blueberry_ui_qt_internal Internal + \ingroup org_blueberry_ui_qt + + \brief This subcategory includes the internal classes of the org.blueberry.ui.qt plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/BlueBerry/Bundles/org.blueberry.ui/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.ui/documentation/doxygen/modules.dox index 8c3525ed7b..65d01619f0 100644 --- a/BlueBerry/Bundles/org.blueberry.ui/documentation/doxygen/modules.dox +++ b/BlueBerry/Bundles/org.blueberry.ui/documentation/doxygen/modules.dox @@ -1,17 +1,17 @@ /** \defgroup org_blueberry_ui org.blueberry.ui \ingroup BlueBerryPlugins \brief This is the user interface plugin. It provides a GUI-Toolkit independent framework - to build an BlueBerry workbench. + to build a BlueBerry workbench. */ /** \defgroup org_blueberry_ui_internal Internal \ingroup org_blueberry_ui \brief This subcategory includes the internal classes of the org.blueberry.ui plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it. -*/ \ No newline at end of file +*/ diff --git a/BlueBerry/Bundles/org.blueberry.uitest/documentation/doxygen/modules.dox b/BlueBerry/Bundles/org.blueberry.uitest/documentation/doxygen/modules.dox index 599c765dc4..95c905fe9d 100644 --- a/BlueBerry/Bundles/org.blueberry.uitest/documentation/doxygen/modules.dox +++ b/BlueBerry/Bundles/org.blueberry.uitest/documentation/doxygen/modules.dox @@ -1,16 +1,16 @@ /** \defgroup org_blueberry_uitest org.blueberry.uitest \ingroup BlueBerryPlugins - \brief Describe your plugin here. + \brief Testing infrastructure for executing unit tests which require a running workbench. */ /** \defgroup org_blueberry_uitest_internal Internal \ingroup org_blueberry_uitest \brief This subcategory includes the internal classes of the org.blueberry.uitest plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it. */ diff --git a/Plugins/org.mitk.core.services/documentation/doxygen/modules.dox b/Plugins/org.mitk.core.services/documentation/doxygen/modules.dox index 9ce368e6d1..d02dced52f 100755 --- a/Plugins/org.mitk.core.services/documentation/doxygen/modules.dox +++ b/Plugins/org.mitk.core.services/documentation/doxygen/modules.dox @@ -1,16 +1,25 @@ /** \defgroup org_mitk_core_services org.mitk.core.services \ingroup MITKPlugins \brief Provides basic MITK services. - + + This plug-in provides service interfaces and service objects for accessing a mitk::DataStorage + via the CTK Plugin Framework service registry. + + It also handles the following tasks: + + - Initialize the MITK Logging back-ends. + - Register adaptor services in the CTK Plugin Framework service registry for each MITK Micro Service. + This allows a seamless access of MITK Micro Service objects from the CTK Plugin Context. + */ /** \defgroup org_mitk_core_services_internal Internal \ingroup org_mitk_core_services \brief This subcategory includes the internal classes of the org.mitk.core.services plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it. */ diff --git a/Plugins/org.mitk.gui.qt.application/documentation/doxygen/modules.dox b/Plugins/org.mitk.gui.qt.application/documentation/doxygen/modules.dox index 77592d99d4..c89ec4876f 100755 --- a/Plugins/org.mitk.gui.qt.application/documentation/doxygen/modules.dox +++ b/Plugins/org.mitk.gui.qt.application/documentation/doxygen/modules.dox @@ -1,16 +1,23 @@ /** \defgroup org_mitk_gui_qt_application org.mitk.gui.qt.application \ingroup MITKPlugins \brief Provides utility classes for MITK application developers. - + + This plug-in provides QAction derived classes for common application actions + like opening files and closing the application. It also provides a central + preferences dialog. + + The plug-in is usually used as a dependency for plug-ins contributing a + \ref xp_org_blueberry_osgi_applications extension and providing workbench advisor + classes which customize the main application menu and toolbar. */ /** \defgroup org_mitk_gui_qt_application_internal Internal \ingroup org_mitk_gui_qt_application \brief This subcategory includes the internal classes of the org.mitk.gui.qt.application plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it. */ diff --git a/Plugins/org.mitk.gui.qt.common/documentation/doxygen/modules.dox b/Plugins/org.mitk.gui.qt.common/documentation/doxygen/modules.dox index a9b4ee94e6..f38f873772 100755 --- a/Plugins/org.mitk.gui.qt.common/documentation/doxygen/modules.dox +++ b/Plugins/org.mitk.gui.qt.common/documentation/doxygen/modules.dox @@ -1,16 +1,23 @@ /** \defgroup org_mitk_gui_qt_common org.mitk.gui.qt.common \ingroup MITKPlugins \brief Provides Qt GUI specific utility classes for MITK View and Editor developers. - + + This plug-in provides abstract classes to ease the development of MITK related View and + Editor extensions for a BlueBerry based application. The main classes are: + + - QmitkAbstractView + - QmitkAbstractRenderEditor + + See also the GUI toolkit independent classes and interfaces in \ref org_mitk_gui_common. */ /** \defgroup org_mitk_gui_qt_common_internal Internal \ingroup org_mitk_gui_qt_common \brief This subcategory includes the internal classes of the org.mitk.gui.qt.common plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it. */ diff --git a/Plugins/org.mitk.gui.qt.coreapplication/documentation/doxygen/modules.dox b/Plugins/org.mitk.gui.qt.coreapplication/documentation/doxygen/modules.dox index 3d641f9119..44df878ed5 100755 --- a/Plugins/org.mitk.gui.qt.coreapplication/documentation/doxygen/modules.dox +++ b/Plugins/org.mitk.gui.qt.coreapplication/documentation/doxygen/modules.dox @@ -1,16 +1,17 @@ /** \defgroup org_mitk_gui_qt_coreapplication org.mitk.gui.qt.coreapplication \ingroup MITKPlugins \brief The CoreApp applictaion plug-in. + Creates the menu and toolbar entries for the main application window. */ /** \defgroup org_mitk_gui_qt_coreapplication_internal Internal \ingroup org_mitk_gui_qt_coreapplication \brief This subcategory includes the internal classes of the org.mitk.gui.qt.coreapplication plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it. */