Document WebSocket::sendTextMessage(string message)

[contrib/qtwebsockets.git] / src / imports / qmlwebsockets / qqmlwebsocket.cpp

diff --git a/src/imports/qmlwebsockets/qqmlwebsocket.cpp b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
index f58c8d0..d165260 100644 (file)
--- a/src/imports/qmlwebsockets/qqmlwebsocket.cpp
+++ b/src/imports/qmlwebsockets/qqmlwebsocket.cpp
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Kurt Pattyn <pattyn.kurt@gmail.com>.
 ** Contact: http://www.qt-project.org/legal
 **
 ** This file is part of the QtWebSockets module of the Qt Toolkit.
@@ -99,6 +99,11 @@
   \sa WebSocket::status
   */
 
+/*!
+  \qmlmethod void WebSocket::sendTextMessage(string message)
+  Sends \c message to the server.
+  */
+
 #include "qqmlwebsocket.h"
 #include <QtWebSockets/QWebSocket>
 
@@ -122,7 +127,7 @@ QQmlWebSocket::~QQmlWebSocket()
 qint64 QQmlWebSocket::sendTextMessage(const QString &message)
 {
     if (m_status != Open) {
-        setErrorString(tr("Messages can only be sent when the socket has Open status."));
+        setErrorString(tr("Messages can only be sent when the socket is open."));
         setStatus(Error);
         return 0;
     }