forked from qt-creator/qt-creator
Doc: use standard wording in \brief commands
QDoc does some magic with the \class and \namespaces and \brief commands, so the following wording must be used: "The xxx class yyy ..." Change-Id: Id231f30e8464898b776888d5423523de404aae34 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
@@ -41,7 +41,7 @@ namespace Internal {
|
||||
|
||||
/*!
|
||||
\class Debugger::Internal::MemoryView
|
||||
\brief Base class for memory view tool windows
|
||||
\brief The MemoryView class is a base class for memory view tool windows.
|
||||
|
||||
Small tool-window that stays on top and displays a chunk of memory
|
||||
based on the widget provided by the Bin editor plugin.
|
||||
@@ -121,7 +121,8 @@ void MemoryView::setMarkup(const QList<MemoryMarkup> &m)
|
||||
|
||||
/*!
|
||||
\class Debugger::Internal::RegisterMemoryView
|
||||
\brief Memory view that shows the memory around the contents of a register
|
||||
\brief The RegisterMemoryView class provides a memory view that shows the
|
||||
memory around the contents of a register
|
||||
(such as stack pointer, program counter),
|
||||
tracking changes of the register value.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user