Commit 2d877cd8 authored by Yuri Chornoivan's avatar Yuri Chornoivan Committed by Ralf Habacker
Browse files

Fix minor Doxygen issues

Fixes for minor issues. The list of issues can be found here:
http://ebn.kde.org/apidocs/apidox-kde-4.x/kdesdk-umbrello.html

Reviewed By: habacker
Differential Revision: https://phabricator.kde.org/D18252
parent 3cc83a5f
......@@ -208,7 +208,7 @@ QString PythonImport::skipBody()
}
/**
* Parse assignments in the form <identifier> '=' <value>
* Parse assignments in the form \<identifier\> '=' \<value\>
* Instance variables are identified by a prefixed 'self.'.
* @return success status of parsing
*/
......
......@@ -242,7 +242,7 @@ QStringList SQLImport::parseFieldType(QString &token)
* Parse default expression.
*
* The expression could be in the form
* (expression)::<type>
* (expression)\::\<type\>
* function(expression)
*
* @param token string with current token
......
......@@ -83,7 +83,7 @@ void CodeImpThread::run()
/**
* Emit a signal to the main gui thread to show a question box.
* @param question the text of the question
* @return the code of the answer button @ref KMessageBox::ButtonCode
* @return the code of the answer button KMessageBox::ButtonCode
*/
int CodeImpThread::emitAskQuestion(const QString& question)
{
......
......@@ -137,11 +137,13 @@ bool parseSequenceLine(const QString &s, QString &sequence, QString &package, QS
/**
* Qtcreator/gdb
* @verbatim
* 6 Driver::ParseHelper::ParseHelper driver.cpp 299 0x634c44
* 31 g_main_context_dispatch /usr/lib64/libglib-2.0.so.0 0x7fffefe16316
* ignoring
* ... <more> 0x7ffff41152d9
* 13 ?? 0x7ffff41152d9
* @endverbatim
*/
else if (cols[cols.size()-1].startsWith(QLatin1String("0x"))) {
if (cols[0] == QLatin1String("...") || cols[1] == QLatin1String("??"))
......
......@@ -89,7 +89,7 @@ protected slots:
* support in an application setting dialog.
*
* To use this support call macro @ref DefineDontAskAgainItem and add a call to method
* @ref DontAskAgainItem::name as parameter @ref dontAskAgainName to related class KMessageBox
* DontAskAgainItem::name as parameter @ref dontAskAgainName to related class KMessageBox
* methods. See the following example:
*
* \code{.cpp}
......
......@@ -19,7 +19,6 @@
* Sets up an Message Widget Properties Dialog.
* @param parent The parent of the dialog
* @param widget The Message Widget to display properties of.
* @param pageNum The page to show first.
*/
MessageWidgetPropertiesDialog::MessageWidgetPropertiesDialog (QWidget *parent, MessageWidget * widget)
: MultiPageDialogBase(parent),
......
......@@ -458,7 +458,7 @@ void MultiPageDialogBase::applyFontPage(Settings::OptionState *state)
/**
* updates the font page data
* @param widget Widget to save the font data into
* @param scene Scene to save the font data into
*/
void MultiPageDialogBase::applyFontPage(UMLScene *scene)
{
......
......@@ -41,7 +41,6 @@
/**
* Sets up the AssociationGeneralPage.
*
* @param d The UMLDoc which controls controls object creation.
* @param parent The parent to the AssociationGeneralPage.
* @param assoc The AssociationWidget to display the properties of.
*/
......
......@@ -36,7 +36,6 @@
/**
* Sets up the AssociationRolePage.
* @param d The UMLDoc which controls controls object creation.
* @param parent The parent to the AssociationRolePage.
* @param assoc The AssociationWidget to display the properties of.
*/
......
......@@ -38,7 +38,6 @@
*
* @param pParent Parent widget
* @param options Settings to read from/save into
* @param isDiagram Flag if object is for display diagram class options
*/
UIOptionsPage::UIOptionsPage(QWidget* pParent, Settings::OptionState *options)
: DialogPageBase(pParent),
......
......@@ -135,7 +135,7 @@ void DefaultValueWidget::setType(UMLObject *type)
* name. If an object was found, the display of the selectable
* options depends on the type.
*
* @param type type as text to set the widget from
* @param _type type as text to set the widget from
*/
void DefaultValueWidget::setType(const QString &_type)
{
......
......@@ -24,9 +24,8 @@ enum class LocalTriggerType { AnchorSelected, AssociationSelected, Collaboration
* Constructs the popup menu for a scene widget.
*
* @param parent The parent to ListPopupMenu.
* @param object The WidgetBase to represent a menu for.
* @param multi True if multiple items are selected.
* @param uniqueType The type of widget shared by all selected widgets
* @param type The type of widget shared by all selected widgets.
* @param widget The AssociationWidget to represent a menu for.
*/
AssociationWidgetPopupMenu::AssociationWidgetPopupMenu(QWidget *parent, Uml::AssociationType::Enum type, AssociationWidget *widget)
: ListPopupMenu(parent)
......
......@@ -661,7 +661,7 @@ QString ListPopupMenu::toString(DataType data)
/**
* dump collected actions
* @param type optional menu type
* @param title optional menu title
*/
void ListPopupMenu::dumpActions(const QString &title)
{
......
......@@ -37,7 +37,7 @@ static const bool CHECKABLE = true;
* Constructs the popup menu for a scene widget.
*
* @param parent The parent to ListPopupMenu.
* @param object The WidgetBase to represent a menu for.
* @param widget The WidgetBase to represent a menu for.
* @param multi True if multiple items are selected.
* @param uniqueType The type of widget shared by all selected widgets
*/
......
......@@ -1839,7 +1839,7 @@ Uml::DiagramType::Enum convert_LVT_DT(UMLListViewItem::ListViewType lvt)
/**
* Converts a list view type enum to the equivalent settings dialog type.
*
* @param lvt The ListViewType to convert.
* @param type The ListViewType to convert.
* @return The converted settings dialog type
*/
MultiPageDialogBase::PageType convert_LVT_PT(UMLListViewItem::ListViewType type)
......
......@@ -192,8 +192,6 @@ void RefactoringAssistant::setVisibilityIcon(QTreeWidgetItem *item, const UMLObj
/**
* Slot for updating the tree item properties according to the given UML object.
* If no parameter is given the sender is used.
* @param obj the UML object
*/
void RefactoringAssistant::objectModified()
{
......
......@@ -69,7 +69,7 @@ bool UMLDatatype::isReference() const
/**
* Loads object from QDomElement.
*
* @param qElement A QDomElement which contains xml info for this object.
* @param element A QDomElement which contains xml info for this object.
*/
bool UMLDatatype::loadFromXMI1(QDomElement & element)
{
......
......@@ -652,7 +652,7 @@ UMLPackage* UMLObject::umlPackage() const
*
* @param parent object to set as parent
*
* @TODO prevent setting parent to myself
* TODO prevent setting parent to myself
*/
void UMLObject::setUMLParent(UMLObject *parent)
{
......@@ -1128,7 +1128,7 @@ QString UMLObject::toString(ObjectType ot)
/**
* Returns the given object type value as localized string.
* @param ot ObjectType of which a string representation is wanted
* @param t ObjectType of which a string representation is wanted
* @return the ObjectType as localized string
*/
QString UMLObject::toI18nString(ObjectType t)
......
......@@ -1962,7 +1962,7 @@ QString UMLDoc::name() const
/**
* Set coordinates resolution for current document.
* @param document resolution in DPI
* @param resolution document resolution in DPI
*/
void UMLDoc::setResolution(qreal resolution)
{
......@@ -2512,7 +2512,7 @@ bool UMLDoc::loadDiagrams1()
/**
* Add a xml node containing a diagram to the list of diagrams to load.
* Helper function for @ref loadDiagrams().
* Helper function for loadDiagrams().
*
* @param folder pointer to UMFolder instance the diagrams belongs to
* @param node xml document node containing the diagram
......
......@@ -465,8 +465,6 @@ bool AssociationWidget::showPropertiesDialog()
/**
* Overrides operation from LinkWidget.
* Required by FloatingTextWidget.
*
* @param op Return this AssociationWidget's operation string.
*/
QString AssociationWidget::lwOperationText()
{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment