From kde-commits  Fri Aug 19 07:28:53 2016
From: David Faure <faure () kde ! org>
Date: Fri, 19 Aug 2016 07:28:53 +0000
To: kde-commits
Subject: [kbookmarks] src: improve API documentation for KBookmarkDialog
Message-Id: <E1baeEX-0006H1-81 () code ! kde ! org>
X-MARC-Message: https://marc.info/?l=kde-commits&m=147159174320925

Git commit 2a7424e07e49a645a472927d5b12558c56c05041 by David Faure.
Committed on 19/08/2016 at 07:28.
Pushed by dfaure into branch 'master'.

improve API documentation for KBookmarkDialog

M  +9    -10   src/kbookmarkdialog.h

http://commits.kde.org/kbookmarks/2a7424e07e49a645a472927d5b12558c56c05041

diff --git a/src/kbookmarkdialog.h b/src/kbookmarkdialog.h
index ecd7d19..62a8f54 100644
--- a/src/kbookmarkdialog.h
+++ b/src/kbookmarkdialog.h
@@ -1,4 +1,3 @@
-//  -*- c-basic-offset:4; indent-tabs-mode:nil -*-
 /* This file is part of the KDE libraries
    Copyright 2007 Daniel Teske <teske@squorn.de>
 =

@@ -41,30 +40,30 @@ class KBOOKMARKS_EXPORT KBookmarkDialog : public QDialog
 =

 public:
     /**
-     * Creates a new KBookmarkDialog
+     * Creates a KBookmarkDialog instance
      */
-    KBookmarkDialog(KBookmarkManager *, QWidget * =3D 0);
+    KBookmarkDialog(KBookmarkManager *manager, QWidget *parent =3D Q_NULLP=
TR);
     /**
-     * shows a propeties dialog
-     * Note: That this  updates the bookmark and calls KBookmarkManager::e=
mitChanged
+     * Shows a properties dialog
+     * Note: this updates the bookmark and calls KBookmarkManager::emitCha=
nged
      */
     KBookmark editBookmark(const KBookmark &bm);
     /**
-     * shows a add Bookmark dialog
-     * Note: That this  updates the bookmark and calls KBookmarkManager::e=
mitChanged
+     * Shows a "Add Bookmark" dialog
+     * Note: this updates the bookmark and calls KBookmarkManager::emitCha=
nged
      */
     KBookmark addBookmark(const QString &title, const QUrl &url, const QSt=
ring &icon, KBookmark parent =3D KBookmark());
     /**
      * Creates a folder from a list of bookmarks
-     * Note: That this  updates the bookmark and calls KBookmarkManager::e=
mitChanged
+     * Note: this updates the bookmark and calls KBookmarkManager::emitCha=
nged
      */
     KBookmarkGroup addBookmarks(const QList<KBookmarkOwner::FutureBookmark=
> &list, const QString &name =3D QString(), KBookmarkGroup parent =3D KBook=
markGroup());
     /**
-     * A dialog to create a new folder.
+     * Shows a dialog to create a new folder.
      */
     KBookmarkGroup createNewFolder(const QString &name, KBookmark parent =
=3D KBookmark());
     /**
-     * A dialog to select a folder.
+     * Shows a dialog to select a folder.
      */
     KBookmarkGroup selectFolder(KBookmark start =3D KBookmark());
=20