QTextEdit docs: fix qdoc warnings
authorJ-P Nurmi <j-p.nurmi@nokia.com>
Fri, 17 Aug 2012 08:54:42 +0000 (10:54 +0200)
committerQt by Nokia <qt-info@nokia.com>
Mon, 20 Aug 2012 19:10:54 +0000 (21:10 +0200)
qdoc insists picking Q_PROPERTY(T document) instead of the individually
documented getter and setter

Change-Id: I6f4981db205c5726d70cef4d85b7dfffe2b1fe31
Reviewed-by: Gabriel de Dietrich <gabriel.dietrich-de@nokia.com>
src/widgets/widgets/qtextedit.cpp

index c9de35a..0ab76db 100644 (file)
@@ -730,15 +730,13 @@ Qt::Alignment QTextEdit::alignment() const
 }
 
 /*!
-    Makes \a document the new document of the text editor.
+    \property QTextEdit::document
+    \brief the underlying document of the text editor.
 
     \note The editor \e{does not take ownership of the document} unless it
     is the document's parent object. The parent object of the provided document
-    remains the owner of the object.
-
-    The editor does not delete the current document, even if it is a child of the editor.
-
-    \sa document()
+    remains the owner of the object. The editor does not delete any previously
+    assigned document, even if it is a child of the editor.
 */
 void QTextEdit::setDocument(QTextDocument *document)
 {
@@ -748,11 +746,6 @@ void QTextEdit::setDocument(QTextDocument *document)
     d->relayoutDocument();
 }
 
-/*!
-    Returns a pointer to the underlying document.
-
-    \sa setDocument()
-*/
 QTextDocument *QTextEdit::document() const
 {
     Q_D(const QTextEdit);