Fix "Header" documentation in Core plugin

Change-Id: If3cbe51b47a3acba32429894dfb5154cd573967d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>

src/plugins/coreplugin/actionmanager/actioncontainer.cpp

@@ -45,6 +45,7 @@ namespace Core {
 
 /*!
     \class Core::ActionContainer
+    \inheaderfile coreplugin/actionmanager/actioncontainer.h
     \ingroup mainclasses
     \inmodule QtCreator
 

src/plugins/coreplugin/actionmanager/actionmanager.cpp

@@ -54,6 +54,7 @@ using namespace Core::Internal;
 
 /*!
     \class Core::ActionManager
+    \inheaderfile coreplugin/actionmanager/actionmanager.h
     \ingroup mainclasses
     \inmodule QtCreator
 

src/plugins/coreplugin/actionmanager/command.cpp

@@ -37,9 +37,9 @@
 #include <QToolButton>
 #include <QTextStream>
 
-
 /*!
     \class Core::Command
+    \inheaderfile coreplugin/actionmanager/command.h
     \inmodule QtCreator
     \ingroup mainclasses
 

src/plugins/coreplugin/actionmanager/commandbutton.cpp

@@ -34,6 +34,7 @@ using namespace Core;
 
 /*!
     \class Core::CommandButton
+    \inheaderfile coreplugin/actionmanager/commandbutton.h
     \inmodule QtCreator
 
     \brief The CommandButton class is a tool button associated with one of

src/plugins/coreplugin/basefilewizardfactory.cpp

@@ -58,7 +58,9 @@ static int indexOfFile(const GeneratedFiles &f, const QString &path)
 
 /*!
     \class Core::BaseFileWizard
+    \inheaderfile coreplugin/basefilewizardfactory.h
     \inmodule QtCreator
+
     \brief The BaseFileWizard class implements a is a convenience class for
     creating files.
 
@@ -90,7 +92,9 @@ Utils::Wizard *BaseFileWizardFactory::runWizardImpl(const QString &path, QWidget
 
 /*!
     \class Core::BaseFileWizardFactory
+    \inheaderfile coreplugin/basefilewizardfactory.h
     \inmodule QtCreator
+
     \brief The BaseFileWizardFactory class implements a generic wizard for
     creating files.
 
@@ -317,7 +321,9 @@ QString BaseFileWizardFactory::preferredSuffix(const QString &mimeType)
 
 /*!
     \class Core::WizardDialogParameters
+    \inheaderfile coreplugin/basefilewizardfactory.h
     \inmodule QtCreator
+
     \brief The WizardDialogParameters class holds parameters for the new file
     wizard dialog.
 

src/plugins/coreplugin/dialogs/ioptionspage.cpp

@@ -53,8 +53,10 @@ using namespace Utils;
 
 /*!
     \class Core::IOptionsPage
+    \inheaderfile coreplugin/dialogs/ioptionspage.h
     \ingroup mainclasses
     \inmodule QtCreator
+
     \brief The IOptionsPage class is an interface for providing pages for the
     \uicontrol Options dialog (called \uicontrol Preferences on \macos).
 

src/plugins/coreplugin/documentmanager.cpp

@@ -74,9 +74,10 @@ static Q_LOGGING_CATEGORY(log, "qtc.core.documentmanager", QtWarningMsg)
 
 /*!
   \class Core::DocumentManager
+  \inheaderfile coreplugin/documentmanager.h
   \ingroup mainclasses
   \inmodule QtCreator
-  \inheaderfile documentmanager.h
+
   \brief The DocumentManager class manages a set of documents.
 
   The DocumentManager service monitors a set of IDocument objects.
@@ -1539,7 +1540,9 @@ void DocumentManager::registerSaveAllAction()
 
 /*!
     \class Core::FileChangeBlocker
+    \inheaderfile coreplugin/documentmanager.h
     \inmodule QtCreator
+
     \brief The FileChangeBlocker class blocks all change notifications to all
     IDocument objects that match the given filename.
 

src/plugins/coreplugin/editormanager/editormanager.cpp

@@ -173,7 +173,9 @@ void EditorManagerPlaceHolder::showEvent(QShowEvent *)
 
 /*!
     \class Core::EditorManager
+    \inheaderfile coreplugin/editormanager/editormanager.h
     \inmodule QtCreator
+
     \brief The EditorManager class manages the editors created for files
     according to their MIME type.
 

src/plugins/coreplugin/editormanager/ieditor.cpp

@@ -27,7 +27,9 @@
 
 /*!
   \class Core::IEditor
+  \inheaderfile coreplugin/editormanager/ieditor.h
   \inmodule QtCreator
+
   \brief The IEditor class is an interface for providing suitable editors for
   documents according to their MIME type.
 

src/plugins/coreplugin/editormanager/ieditorfactory.cpp

@@ -36,7 +36,9 @@ namespace Core {
 
 /*!
     \class Core::IEditorFactory
+    \inheaderfile coreplugin/editormanager/ieditorfactory.h
     \inmodule QtCreator
+
     \brief The IEditorFactory class creates suitable editors for documents
     according to their MIME type.
 

src/plugins/coreplugin/editormanager/iexternaleditor.cpp

@@ -31,6 +31,7 @@ namespace Core {
 
 /*!
     \class Core::IExternalEditor
+    \inheaderfile coreplugin/editormanager/iexternaleditor.h
     \inmodule QtCreator
     \ingroup mainclasses
 

src/plugins/coreplugin/featureprovider.cpp

@@ -27,6 +27,7 @@
 
 /*!
     \class Core::IFeatureProvider
+    \inheaderfile coreplugin/featureprovider.h
     \inmodule QtCreator
     \ingroup mainclasses
 

src/plugins/coreplugin/find/basetextfind.cpp

@@ -83,6 +83,7 @@ BaseTextFindPrivate::BaseTextFindPrivate(QPlainTextEdit *editor)
 
 /*!
     \class Core::BaseTextFind
+    \inheaderfile coreplugin/find/basetextfind.h
     \inmodule QtCreator
 
     \brief The BaseTextFind class implements a find filter for QPlainTextEdit

src/plugins/coreplugin/find/ifindfilter.cpp

@@ -34,7 +34,9 @@
 
 /*!
     \class Core::IFindFilter
+    \inheaderfile coreplugin/find/ifindfilter.h
     \inmodule QtCreator
+
     \brief The IFindFilter class is the base class for find implementations
     that are invoked by selecting \uicontrol Edit > \uicontrol {Find/Replace} >
     \uicontrol {Advanced Find}.
@@ -97,7 +99,6 @@
     to the shared \uicontrol{Search Results} window.
 */
 
-
 /*!
     \fn QString Core::IFindFilter::id() const
     Returns the unique string identifier for this find filter.

src/plugins/coreplugin/find/ifindsupport.cpp

@@ -32,7 +32,9 @@ using namespace Core;
 
 /*!
     \class Core::IFindSupport
+    \inheaderfile coreplugin/find/ifindsupport.h
     \inmodule QtCreator
+
     \brief The IFindSupport class provides functions for searching in a document
      or widget.
 

src/plugins/coreplugin/find/searchresultwindow.cpp

@@ -260,7 +260,9 @@ using namespace Core::Internal;
 
 /*!
     \class Core::SearchResult
+    \inheaderfile coreplugin/find/searchresultwindow.h
     \inmodule QtCreator
+
     \brief The SearchResult class reports user interaction, such as the
     activation of a search result item.
 
@@ -340,7 +342,9 @@ using namespace Core::Internal;
 
 /*!
     \class Core::SearchResultWindow
+    \inheaderfile coreplugin/find/searchresultwindow.h
     \inmodule QtCreator
+
     \brief The SearchResultWindow class is the implementation of a commonly
     shared \uicontrol{Search Results} output pane.
 

src/plugins/coreplugin/generatedfile.cpp

@@ -38,7 +38,9 @@ namespace Core {
 
 /*!
     \class Core::GeneratedFile
+    \inheaderfile coreplugin/generatedfile.h
     \inmodule QtCreator
+
     \brief The GeneratedFile class represents a file generated by a wizard.
 
     The BaseFileWizard class checks whether each file already exists and
@@ -47,8 +49,6 @@ namespace Core {
     \sa Core::WizardDialogParameters, Core::BaseFileWizard,
  */
 
-
-
 class GeneratedFilePrivate : public QSharedData
 {
 public:

src/plugins/coreplugin/icontext.cpp

@@ -47,8 +47,10 @@ QDebug operator<<(QDebug debug, const Core::Context &context)
 
 /*!
     \class Core::Context
+    \inheaderfile coreplugin/icontext.h
     \inmodule QtCreator
     \ingroup mainclasses
+
     \brief The Context class implements a list of context IDs.
 
     Contexts are used for registering actions with Core::ActionManager, and
@@ -169,6 +171,7 @@ QDebug operator<<(QDebug debug, const Core::Context &context)
 
 /*!
     \class Core::IContext
+    \inheaderfile coreplugin/icontext.h
     \inmodule QtCreator
     \ingroup mainclasses
 

src/plugins/coreplugin/icore.cpp

@@ -88,8 +88,10 @@
 
 /*!
     \class Core::ICore
+    \inheaderfile coreplugin/icore.h
     \inmodule QtCreator
     \ingroup mainclasses
+
     \brief The ICore class allows access to the different parts that make up
     the basic functionality of \QC.
 

src/plugins/coreplugin/id.cpp

@@ -40,6 +40,7 @@ namespace Core {
 
 /*!
     \class Core::Id
+    \inheaderfile coreplugin/id.h
     \inmodule QtCreator
 
     \brief The Id class encapsulates an identifier that is unique

src/plugins/coreplugin/idocument.cpp

@@ -35,6 +35,7 @@
 
 /*!
     \class Core::IDocument
+    \inheaderfile coreplugin/idocument.h
     \inmodule QtCreator
 
     \brief The IDocument class describes a document that can be saved and reloaded.

src/plugins/coreplugin/imode.cpp

@@ -31,9 +31,9 @@ namespace Core {
 
 /*!
     \class Core::IMode
+    \inheaderfile coreplugin/imode.h
     \ingroup mainclasses
     \inmodule QtCreator
-    \inheaderfile coreplugin/imode.h
 
     \brief The IMode class represents a mode in \QC.
 

src/plugins/coreplugin/inavigationwidgetfactory.cpp

@@ -32,8 +32,10 @@
 
 /*!
     \class Core::INavigationWidgetFactory
+    \inheaderfile coreplugin/inavigationwidgetfactory.h
     \ingroup mainclasses
     \inmodule QtCreator
+
     \brief The INavigationWidgetFactory class provides new instances of navigation widgets.
 
     A navigation widget factory is necessary because there can be more than one navigation widget of
@@ -43,6 +45,7 @@
 
 /*!
     \class Core::NavigationView
+    \inheaderfile coreplugin/inavigationwidgetfactory.h
     \inmodule Qt Creator
     \brief The NavigationView class is a C struct for wrapping a widget and a list of tool buttons.
     Wrapping the widget that is shown in the content area of the navigation widget and a list of

src/plugins/coreplugin/ioutputpane.cpp

@@ -31,6 +31,7 @@ namespace Core {
 
 /*!
     \class Core::IOutputPane
+    \inheaderfile coreplugin/ioutputpane.h
     \brief The IOutputPane class is an interface for providing \uicontrol Output panes.
 
     \ingroup mainclasses

src/plugins/coreplugin/iversioncontrol.cpp

@@ -37,7 +37,9 @@
 
 /*!
     \class Core::IVersionControl::TopicCache
+    \inheaderfile coreplugin/iversioncontrol.h
     \inmodule QtCreator
+
     \brief The TopicCache class stores a cache which maps a directory to a topic.
 
     A VCS topic is typically the current active branch name, but it can also have other

src/plugins/coreplugin/iwizardfactory.cpp

@@ -41,6 +41,7 @@
 
 /*!
     \class Core::IWizardFactory
+    \inheaderfile coreplugin/iwizardfactory.h
     \inmodule QtCreator
     \ingroup mainclasses
 

src/plugins/coreplugin/locator/basefilefilter.cpp

@@ -66,6 +66,7 @@ public:
 
 /*!
     \class Core::BaseFileFilter
+    \inheaderfile coreplugin/locator/basefilefilter.h
     \inmodule QtCreator
 
     \brief The BaseFileFilter class is a base class for locator filter classes.

src/plugins/coreplugin/locator/ilocatorfilter.cpp

@@ -41,6 +41,7 @@ using namespace Core;
 
 /*!
     \class Core::ILocatorFilter
+    \inheaderfile coreplugin/locator/ilocatorfilter.h
     \inmodule QtCreator
 
     \brief The ILocatorFilter class adds a locator filter.

src/plugins/coreplugin/minisplitter.cpp

@@ -80,6 +80,7 @@ void MiniSplitterHandle::paintEvent(QPaintEvent *event)
 
 /*!
     \class Core::MiniSplitter
+    \inheaderfile coreplugin/minisplitter.h
     \inmodule QtCreator
 
     \brief The MiniSplitter class is a simple helper-class to obtain
@@ -119,6 +120,7 @@ MiniSplitter::MiniSplitter(Qt::Orientation orientation, QWidget *parent, Splitte
 
 /*!
     \class Core::NonResizingSplitter
+    \inheaderfile coreplugin/minisplitter.h
     \inmodule QtCreator
 
     \brief The NonResizingSplitter class is a MiniSplitter that keeps its

src/plugins/coreplugin/modemanager.cpp

@@ -50,6 +50,7 @@ namespace Core {
 
 /*!
     \class Core::ModeManager
+    \inheaderfile coreplugin/modemanager.h
     \inmodule QtCreator
 
     \brief The ModeManager class implements a mode manager.

src/plugins/coreplugin/progressmanager/futureprogress.cpp

@@ -84,8 +84,10 @@ FutureProgressPrivate::FutureProgressPrivate(FutureProgress *q) :
 
 /*!
     \ingroup mainclasses
+    \inheaderfile coreplugin/progressmanager/futureprogress.h
     \class Core::FutureProgress
     \inmodule QtCreator
+
     \brief The FutureProgress class is used to adapt the appearance of
     progress indicators that were created through the ProgressManager class.
 

src/plugins/coreplugin/progressmanager/progressmanager.cpp

@@ -63,9 +63,11 @@ using namespace Core::Internal;
 using namespace Utils;
 
 /*!
-    \ingroup mainclasses
-    \inmodule QtCreator
     \class Core::ProgressManager
+    \inheaderfile coreplugin/progressmanager/progressmanager.h
+    \inmodule QtCreator
+    \ingroup mainclasses
+
     \brief The ProgressManager class is used to show a user interface
     for running tasks in Qt Creator.
 

src/plugins/coreplugin/settingsdatabase.cpp

@@ -38,7 +38,9 @@
 
 /*!
     \class Core::SettingsDatabase
+    \inheaderfile coreplugin/settingsdatabase.h
     \inmodule QtCreator
+
     \brief The SettingsDatabase class offers an alternative to the
     application-wide QSettings that is more
     suitable for storing large amounts of data.

src/plugins/coreplugin/textdocument.cpp

@@ -31,7 +31,9 @@
 
 /*!
     \class Core::BaseTextDocument
+    \inheaderfile coreplugin/textdocument.h
     \inmodule QtCreator
+
     \brief The BaseTextDocument class is a very general base class for
     documents that work with text.
 

src/plugins/coreplugin/variablechooser.cpp

@@ -338,37 +338,39 @@ void VariableGroupItem::populateGroup(MacroExpander *expander)
 using namespace Internal;
 
 /*!
- * \class Core::VariableChooser
+    \class Core::VariableChooser
- * \inmodule QtCreator
+    \inheaderfile coreplugin/variablechooser.h
- * \brief The VariableChooser class is used to add a tool window for selecting \QC variables
+    \inmodule QtCreator
- * to line edits, text edits or plain text edits.
+
- *
+    \brief The VariableChooser class is used to add a tool window for selecting \QC variables
- * If you allow users to add \QC variables to strings that are specified in your UI, for example
+    to line edits, text edits or plain text edits.
- * when users can provide a string through a text control, you should add a variable chooser to it.
+
- * The variable chooser allows users to open a tool window that contains the list of
+    If you allow users to add \QC variables to strings that are specified in your UI, for example
- * all available variables together with a description. Double-clicking a variable inserts the
+    when users can provide a string through a text control, you should add a variable chooser to it.
- * corresponding string into the corresponding text control like a line edit.
+    The variable chooser allows users to open a tool window that contains the list of
- *
+    all available variables together with a description. Double-clicking a variable inserts the
- * \image variablechooser.png "External Tools Preferences with Variable Chooser"
+    corresponding string into the corresponding text control like a line edit.
- *
+
- * The variable chooser monitors focus changes of all children of its parent widget.
+    \image variablechooser.png "External Tools Preferences with Variable Chooser"
- * When a text control gets focus, the variable chooser checks if it has variable support set.
+
- * If the control supports variables,
+    The variable chooser monitors focus changes of all children of its parent widget.
- * a tool button which opens the variable chooser is shown in it while it has focus.
+    When a text control gets focus, the variable chooser checks if it has variable support set.
- *
+    If the control supports variables,
- * Supported text controls are QLineEdit, QTextEdit and QPlainTextEdit.
+    a tool button which opens the variable chooser is shown in it while it has focus.
- *
+
- * The variable chooser is deleted when its parent widget is deleted.
+    Supported text controls are QLineEdit, QTextEdit and QPlainTextEdit.
- *
+
- * Example:
+    The variable chooser is deleted when its parent widget is deleted.
- * \code
+
- * QWidget *myOptionsContainerWidget = new QWidget;
+    Example:
- * new Core::VariableChooser(myOptionsContainerWidget)
+    \code
- * QLineEdit *myLineEditOption = new QLineEdit(myOptionsContainerWidget);
+    QWidget *myOptionsContainerWidget = new QWidget;
- * myOptionsContainerWidget->layout()->addWidget(myLineEditOption);
+    new Core::VariableChooser(myOptionsContainerWidget)
- * Core::VariableChooser::addVariableSupport(myLineEditOption);
+    QLineEdit *myLineEditOption = new QLineEdit(myOptionsContainerWidget);
- * \endcode
+    myOptionsContainerWidget->layout()->addWidget(myLineEditOption);
- */
+    Core::VariableChooser::addVariableSupport(myLineEditOption);
+    \endcode
+*/
 
 /*!
  * \internal