Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

Commit a9d1015f authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor Doxygen issues

parent 8e90302e
......@@ -135,7 +135,7 @@ public Q_SLOTS:
*
* Need to rebuild all the XHTML content.
*
* @param chatWindowStyle ChatWindowStyle object.
* @param style ChatWindowStyle object.
*/
void setStyle(ChatWindowStyle *style);
......
......@@ -109,7 +109,7 @@ public:
/**
* Returns the message currently in the edit area
* @return The @ref Kopete::Message object for the message
* @return The Kopete::Message object for the message
*/
Kopete::Message contents();
......
......@@ -128,7 +128,7 @@ public:
/**
* Sets the current message in the chat window
* @param parent The new chat window
* @param newMessage The new message window
*
* Reimplemented from KopeteView
*/
......@@ -247,7 +247,7 @@ public Q_SLOTS:
Q_SIGNALS:
/**
* Emitted when a message is sent
* @param message The message sent
* Parameter is the message sent
*/
void messageSent(Kopete::Message &);
......
......@@ -68,7 +68,7 @@ public:
/**
* Find the appropriate window for a ChatView of the given protocol to
* dock into. If no such window exists, create one.
* @param protocol The protocol we are creating a view for
* @param manager The manager we are creating a view for
* @return A KopeteChatWindow suitable for docking a ChatView into. Guaranteed
* to be a valid pointer.
*/
......
......@@ -76,8 +76,8 @@ public:
* @endcode
*
* @param parent the parent widget to be used by the dialog
* @param account the @ref Kopete::Account that needs to change the identity
* @param hidden_ident the @ref Kopete::Identity that should be hidden in the
* @param account the Kopete::Account that needs to change the identity
* @param hidden_ident the Kopete::Identity that should be hidden in the
* dialog (in case it is being removed we don't want any
* account to be assigned to it). The default behavior is
* to show all identities
......@@ -86,11 +86,11 @@ public:
static bool changeAccountIdentity(QWidget *parent, Kopete::Account *account, Kopete::Identity *hidden_ident = 0, const QString &message = QString());
/**
* This behaves essentially like the above function, but can be used to change
* the identity of more than one @ref Kopete::Account at a time
* the identity of more than one Kopete::Account at a time
*
* @param parent the parent widget to be used by the dialog
* @param accountList a list of accounts to change the identity of
* @param hidden_ident the @ref Kopete::Identity that should be hidden in the
* @param hidden_ident the Kopete::Identity that should be hidden in the
* dialog (in case it is being removed we don't want any
* account to be assigned to it). The default behavior is
* to show all identities
......
......@@ -75,7 +75,7 @@ k_dcop:
/**
* Obtain the IM app's idea of the contact's display name
* Useful if KABC lookups may be too slow
* @param KABC uid.
* @param uid KABC uid.
* @return The corresponding display name.
*/
virtual QString displayName(const QString &uid) = 0;
......
......@@ -57,10 +57,10 @@ class PropertyContainer;
*
* The accountId is an @em constant unique id, which represents the login.
* The @ref myself() contact is one of the most important contacts, which represents
* the user tied to this account. You must create this contact in the contructor of your
* the user tied to this account. You must create this contact in the constructor of your
* account and pass it to @ref setMyself().
*
* All account data is saved to @ref KConfig. This includes the accountId, the autoconnect flag and
* All account data is saved to KConfig. This includes the accountId, the autoconnect flag and
* the color. You can save more data using @ref configGroup()
*
* When you create a new account, you have to register it with the account manager by calling
......@@ -127,7 +127,6 @@ public:
* @param parent the protocol for this account. The account is a child object of the
* protocol, so it will be automatically deleted when the protocol is.
* @param accountID the unique ID of this account.
* @param name the name of this QObject.
*/
Account(Protocol *parent, const QString &accountID);
......@@ -382,7 +381,7 @@ public:
bool isBusy() const;
/**
* Return the @ref KConfigGroup used to write and read special properties
* Return the KConfigGroup used to write and read special properties
*
* "Protocol", "AccountId" , "Color", "AutoConnect", "Priority", "Enabled" , "Icon" are reserved keyword
* already in use in that group.
......
......@@ -191,7 +191,7 @@ public Q_SLOTS:
/**
* @brief Check if an avatar exists
* @param entryToCheck Avatar entry to check
* @param avatarToCheck Avatar entry to check
*/
bool exists(Kopete::AvatarManager::AvatarEntry avatarToCheck);
......
......@@ -52,7 +52,6 @@ public:
* @param protocolId is the ID of the protocol owning accountId
* @param accountId is the ID of the owning Account.
* @param parent The QObject parent for this class.
* @param name The QObject name for this class.
*/
BlackLister(const QString &protocolId, const QString &accountId, QObject *parent = nullptr);
~BlackLister();
......
......@@ -61,7 +61,7 @@ public:
/**
* @brief Duplicates an existing identity
*
* This will create a new identity name @param id, that clones all properties
* This will create a new identity name that clones all properties
* @return duplicate Identity
*/
Identity *clone() const;
......@@ -79,7 +79,7 @@ public:
/**
* Sets the label
* @param newLabel a new label for the identity
* @param label a new label for the identity
*/
void setLabel(const QString &label);
......@@ -123,7 +123,7 @@ public:
void addAccount(Kopete::Account *account);
/**
* Returns the @ref KConfigGroup that should be used to read/write settings
* Returns the KConfigGroup that should be used to read/write settings
* of this identity
*/
KConfigGroup *configGroup() const;
......
......@@ -92,8 +92,9 @@ public:
QMap<uint, QString> actions() const;
/**
* Set the list of actions link.
* @param actions the list of actions
* Set the action link.
* @param actionId the identifier of action
* @param actionText the action text
*/
void addAction(uint actionId, const QString &actionText);
......
......@@ -233,7 +233,7 @@ public:
* This is used mostly by Jabber plugin to select between
* the email window or the chat window depending of the
* type of message.
* @param requesedPlugin View plugin name
* @param requestedPlugin View plugin name
*/
void setRequestedPlugin(const QString &requestedPlugin);
......@@ -314,8 +314,9 @@ public:
/**
* @brief Set the importance.
* @see importance and @see MessageImportance
* @param importance The message importance to set
* @see importance
* @see MessageImportance
* @param i The message importance to set
*/
void setImportance(MessageImportance importance);
......@@ -503,7 +504,7 @@ public:
/**
* @brief Add a class
* @see classes
* @param class class to add
* @param classe class to add
*/
void addClass(const QString &classe);
......
......@@ -347,7 +347,6 @@ public:
* A cache is employed to reduce CPU and memory usage.
* @param account is the account the icon should apply to.
* The account's color causes tinting, if it's plain QColor(), no tinting takes place.
* @param size is the size we the icon should be scaled to - 16 is default and so costs nothing
*/
QIcon iconFor(const Account *account) const;
......
......@@ -55,7 +55,6 @@ public:
*
* @param configGroup The configuration group to save passwords in.
* @param allowBlankPassword If this password is allowed to be blank
* @param name The name for this object
*/
explicit Password(const QString &configGroup, bool allowBlankPassword = false);
......
......@@ -40,10 +40,7 @@ public:
* KopetePasswordedAccount constructor
* @param parent The protocol this account connects via
* @param acctId The ID of this account - should be unique within this protocol
* @param maxPasswordLength The maximum length for passwords for this account, or 0 for no limit
* @param allowBlankPassword If this protocol allows blank passwords. Note that this will mean that
*
* @param name The name for this QObject
*/
PasswordedAccount(Protocol *parent, const QString &acctId, bool allowBlankPassword = false);
......
......@@ -52,9 +52,9 @@ public:
/**
* @brief Serialize the persistent properties for storage in the contact list.
*
* Does the same as @ref serialize() does but for KopeteContactProperties
* Does the same as serialize() does but for KopeteContactProperties
* set in this contact with their persistency flag turned on.
* In contrary to @ref serialize() this does not need to be reimplemented.
* In contrary to serialize() this does not need to be reimplemented.
*
*/
void serializeProperties(QMap<QString, QString> &serializedData) const;
......
......@@ -163,16 +163,15 @@ protected:
/**
* @brief Constructor for Protocol
*
* @param instance The protocol's instance, every plugin needs to have a KAboutData of its own
* @param parent The protocol's parent object
* @param name The protocol's name
* @param canAddMyself Whether it is possible to add user himself
*/
Protocol(QObject *parent, bool canAddMyself = false);
/**
* @brief Sets the capabilities of this protcol.
* @brief Sets the capabilities of this protocol.
*
* The subclass contructor is a good place for calling it.
* The subclass constructor is a good place for calling it.
* @sa @ref capabilities()
*/
void setCapabilities(Capabilities);
......
......@@ -40,7 +40,6 @@ public:
* @brief ManagedConnectionAccount constructor.
* @param parent The protocol this account connects via
* @param acctId The ID of this account - should be unique within this protocol
* @param maxPasswordLength The maximum length for passwords for this account, or 0 for no limit
*/
ManagedConnectionAccount(Protocol *parent, const QString &acctId);
public Q_SLOTS:
......
......@@ -69,7 +69,7 @@ protected Q_SLOTS:
/**
* @internal
* A button has been clicked. Reimplemented from @ref QDialog::slotButtonClicked()
* A button has been clicked. Reimplemented from QDialog::slotButtonClicked()
*/
virtual void slotButtonClicked(int button);
......
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