feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Fix qdoc warnings

Browse Source 
- Mark undocumented but existing functions with \c (instead of \l or \sa)
- Remove reference to functions I could no longer find
- Fix other broken links
- Fix reference to an image whose file format changed to WEBP
- Use {} instead of "" to mark alt text for images
- Add missing \a commands
- Add class name to a function name so that it can be found

Change-Id: I10655bb0356c7417ab0e14a3ce620930f4ee8349
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2023-05-26 17:00:14 +02:00
parent 4ecb016196
commit c04a4a1ae0
7 changed files with 23 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/qtcreatordev/src/common-extension-tasks.qdoc
View File

@@ -52,7 +52,7 @@
\li Add support for a new version control system.
\li Version control systems integrated in \QC are Bazaar, CVS, Git,
Mecurial, Perforce, and Subversion.
\li \l{Core::IVersionControl}
\li \c{Core::IVersionControl}
\row
\li Add a view to the navigation sidebar.
@@ -94,7 +94,7 @@
\li For a text typed in by the user you provide a list of things to
show in the popup. When the user selects an entry you are
requested to do whatever you want.
\li \l{Core::ILocatorFilter}, \l{Core::BaseFileFilter}
\li \l{Core::ILocatorFilter}
\row
\li Show a progress indicator for a concurrently running task.

3
doc/qtcreatordev/src/plugin-lifecycle.qdoc
View File

@@ -28,8 +28,7 @@
tracks the state of the plugin.
You can get the \l{ExtensionSystem::PluginSpec} instances via the
plugin manager's \l{ExtensionSystem::PluginManager::plugins()}{plugins()}
function, or, after a plugin is loaded, through the plugin's
\l{ExtensionSystem::IPlugin::pluginSpec()}{pluginSpec()} function.
function.
\li Sets the plugins to \c Read state.

4
doc/qtcreatordev/src/plugin-tests.qdoc
View File

@@ -41,8 +41,8 @@
failure.
To add plugin tests, add a QObject based class with private slots for your
tests, and register it with \l{ExtensionSystem::IPlugin::addTest()} in your
plugin's \l{ExtensionSystem::IPlugin::initialized()} method. Guard all test
tests, and register it with \c{ExtensionSystem::IPlugin::addTest()} in your
plugin's \l{ExtensionSystem::IPlugin::initialize()} method. Guard all test
related code with a check for \c{WITH_TESTS}, to avoid shipping a binary
release of your plugin with test functions.

2
doc/qtcreatordev/src/qtcreator-dev.qdoc
View File

@@ -202,7 +202,7 @@
One way to handle that would be to let the tool create an output file, which
is then opened within \QC. You provide an editor (probably read-only) for
handling this file. For lists of issues, consider creating task list files
which are shown in \l Issues.
which are shown in \uicontrol Issues.
\list
\li \l{https://doc.qt.io/qtcreator/creator-task-lists.html}

24
doc/qtcreatordev/src/qtcreator-ui-text.qdoc
View File

@@ -91,14 +91,14 @@
case, use book style capitalization and do not add a period after the tool
tip.
\image qtcreator-tooltip.png "Tooltip"
\image qtcreator-tooltip.png {Tooltip}
Tooltips can also contain full sentences. Try to make them as short and
concise as possible, while still making them grammatically correct. Use
sentence style capitalization and punctuation as you would for any
sentence.
\image qtcreator-tooltip-long.png "Sentence as a tooltip"
\image qtcreator-tooltip-long.png {Sentence as a tooltip}
\section3 Writing Tooltips in Design Mode
@@ -333,7 +333,7 @@
\li Opens when users right-click on the screen. Contents depend on
the context.
\image qtcreator-context-menu.png "Context menu"
\image qtcreator-context-menu.png {Context menu}
\li You can add menu items that are relevant in a particular
context. Follow the conventions for naming menu items.
@@ -343,7 +343,7 @@
\li User interface element that usually contains a number of
choices or allows the user to give input to the application.
Opens when users select a menu item or button.
\image qtcreator-dialog.png "Dialog"
\image qtcreator-dialog.png {Dialog}
\li Use the menu item or button name as the dialog name. You can
also combine the menu item or button name and the name of the
object that is managed in the dialog. For example, the \uicontrol Add
@@ -354,7 +354,7 @@
\li Allows you to browse not only files, but any items defined by
locator filters.
\image qtcreator-locator.png "Locator"
\image qtcreator-locator.webp {Locator}
\li You can add locator filters. Check that the filter is not
already in use and give the filter a descriptive name.
@@ -365,7 +365,7 @@
\li Contains menu items that represent commands or options and that
are logically grouped and displayed. A menu can also contain
submenus.
\image qtcreator-menu.png "Menu"
\image qtcreator-menu.png {Menu}
\li You can create new menus. Use short, but descriptive names that
are consistent with existing menu names. Use unambigious names.
@@ -373,7 +373,7 @@
\row
\li Menu item
\li Represents a command or an option for users to choose.
\image qtcreator-menu-item.png "Menu item"
\image qtcreator-menu-item.png {Menu item}
\li You can add new items to menus. Use short, but descriptive
names that are consistent with existing menu names. Use
unambigious names.
@@ -381,7 +381,7 @@
\li Message box
\li Dialog that provides feedback to users, in the form of status
information, a warning, or an error message.
\image qtcreator-error-message.png "Message box"
\image qtcreator-error-message.png {Message box}
Output from Qt Creator should be displayed in output views,
instead.
\li Use the event as the title and provide a solution in the
@@ -390,21 +390,21 @@
\li Mode
\li Modes correspond to complete screens of controls, specialized
for a task.
\image qtcreator-mode-selector.png "Mode selector"
\image qtcreator-mode-selector.png {Mode selector}
\li You can add a mode for a new type of editor, for example.
Use descriptive, but short mode names. They have to fit in the
\uicontrol {Mode selector}.
\row
\li Output
\li Views to display output from Qt Creator.
\image qtcreator-output-pane.png "Output"
\image qtcreator-output-pane.png {Output}
\li Use descriptive names for output views.
\row
\li Sidebar
\li A view available in the \uicontrol Edit and \uicontrol Debug modes that
you can use to browse projects, files, and bookmarks, and to
view the class hierarchy.
\image qtcreator-sidebar-menu.png "Sidebar"
\image qtcreator-sidebar-menu.png {Sidebar}
\li You can add views to the sidebar menu. Use descriptive names
for them.
\row
@@ -413,7 +413,7 @@
provides them with functions for managing the information.
Available in \uicontrol Debug mode, for interaction with the program
that is running under the control of the debugger.
\image qtcreator-debugger-views.webp "Views"
\image qtcreator-debugger-views.webp {Views}
\li Use descriptive names for views.
\endtable

7
src/libs/extensionsystem/iplugin.cpp
View File

@@ -248,7 +248,8 @@ void IPlugin::tryCreateObjects()
}
/*!
Registers a function object that creates a test object.
Registers a function object that creates a test object with the owner
\a creator.
The created objects are meant to be passed on to \l QTest::qExec().
@@ -264,9 +265,7 @@ void IPlugin::addTestCreator(const TestCreator &creator)
}
/*!
\deprecated [10.0] Use addTest() instead
\sa addTest()
\deprecated [10.0] Use \c addTest() instead.
*/
QVector<QObject *> IPlugin::createTestObjects() const
{

4
src/libs/utils/progressindicator.cpp
View File

@@ -200,7 +200,7 @@ ProgressIndicator::ProgressIndicator(ProgressIndicatorSize size, QWidget *parent
/*!
Changes the size of the progress indicator to \a size.
\sa indicatorSize
\sa ProgressIndicatorPainter::indicatorSize()
*/
void ProgressIndicator::setIndicatorSize(ProgressIndicatorSize size)
{
@@ -211,7 +211,7 @@ void ProgressIndicator::setIndicatorSize(ProgressIndicatorSize size)
/*!
Returns the size of the indicator in device independent pixels.
\sa indicatorSize
\sa ProgressIndicatorPainter::indicatorSize()
*/
QSize ProgressIndicator::sizeHint() const
{