From be24f42336537e891df2b59e2e64713571a0792a Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 21 Dec 2016 14:07:13 +0100 Subject: Doc: Describe default values for WebEngineView::printToPdf() MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The doc does not mention that two out of three parameters have default values and can be left out. Also fix the method signature to use QML conventions. Change-Id: I4c88653ce1fc5890aadce74be878098d16ae274c Reviewed-by: Michael Brüning --- src/webengine/doc/src/webengineview.qdoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'src/webengine') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 52ca84c6b..2e5bde409 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -1121,11 +1121,14 @@ */ /*! - \qmlmethod void WebEngineView::printToPdf(const QString &filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation) + \qmlmethod void WebEngineView::printToPdf(const string filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation) \since QtWebEngine 1.3 Prints the WebEngineView's current content to a PDF document and stores it under \a filePath. The document's size will be determined by the value of \a pageSizeId and its orientation will be determined using \a orientation. + + If you leave out \a pageSizeID, it defaults to \c A4. If you leave out + \a orientation, it defaults to \c Portrait. */ /*! @@ -1137,6 +1140,9 @@ The \a resultCallback must take a string parameter. This string will contain the document's data upon successful printing and an empty string otherwise. + + If you leave out \a pageSizeID, it defaults to \c A4. If you leave out + \a orientation, it defaults to \c Portrait. */ /*! -- cgit v1.2.3