mirror of https://github.com/qt/qtdoc.git
Doc: Fix qdoc warnings
Change-Id: I10434c5231794ce91ddb170882ce8e55ca829cd0 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Venugopal Shivashankar
parent
2fe326df30
commit
867604297d
|
|
@ -29,6 +29,9 @@ excludedirs += \
|
|||
../src/cmake \
|
||||
../src/platformintegration
|
||||
|
||||
# include java files in the list of example sources
|
||||
examples.fileextensions =+ *.java
|
||||
|
||||
# Exclude documentation for the broken examples
|
||||
excludefiles += \
|
||||
../../examples/demos/maroon/doc/src/maroon.qdoc \
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@
|
|||
|
||||
For Qt Quick applications, you can use Qt Quick Designer which is integrated
|
||||
within Qt Creator. Qt Quick Designer is available in the edit mode in an
|
||||
open Qt Quick project. The \l{Qt Quick Designer} page has more information.
|
||||
open Qt Quick project.
|
||||
|
||||
|
||||
\section2 Collaboration with Designers
|
||||
|
|
|
|||
|
|
@ -191,7 +191,7 @@
|
|||
\div {class="doc-column"}
|
||||
\b{In-App Purchasing}
|
||||
\list
|
||||
\li \l{Qt Hangman (In-App Purchasing)}
|
||||
\li \l{In-App purchasing demo}{Qt Hangman (In-App Purchasing Demo)}
|
||||
\endlist
|
||||
\enddiv
|
||||
\enddiv
|
||||
|
|
|
|||
|
|
@ -206,7 +206,7 @@ The following is a list of such meta-data defined by Qt:
|
|||
\li android.app.splash_screen_sticky
|
||||
\li Sets whether the splash screen stays visible until explicitly hidden
|
||||
by the app.
|
||||
For more information, see \l {QAndroidApplication::hideSplashScreen()}.
|
||||
For more information, see \l {QNativeInterface::}{QAndroidApplication::hideSplashScreen()}.
|
||||
Default: \c false.
|
||||
\row
|
||||
\target android.app.system_libs_prefix
|
||||
|
|
|
|||
|
|
@ -137,7 +137,7 @@
|
|||
\div {class="doc-column"}
|
||||
\b{In-App Purchasing}
|
||||
\list
|
||||
\li \l{Qt Hangman (In-App Purchasing)}
|
||||
\li \l{In-App purchasing demo}{Qt Hangman (In-App Purchasing)}
|
||||
\endlist
|
||||
\enddiv
|
||||
\enddiv
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@
|
|||
|
||||
\section2 Designing UIs
|
||||
|
||||
\l{Qt Quick Designer} lets you design UIs from within Qt Creator. You can
|
||||
\l{Qt Design Studio} lets you design UIs from within Qt Creator. You can
|
||||
import 2D and 3D assets, animate components, and create layouts. Testing
|
||||
the designs is possible through a live preview on devices are through
|
||||
an online browser.
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@
|
|||
each defined in a separate .qml file:
|
||||
|
||||
\list
|
||||
\li Button.qml
|
||||
\li CalculatorButton.qml
|
||||
\li Display.qml
|
||||
\li NumberPad.qml
|
||||
\endlist
|
||||
|
|
@ -69,11 +69,10 @@
|
|||
\printuntil }
|
||||
\printuntil }
|
||||
|
||||
Further, we use the Button type in the \c NumberPad type to create the
|
||||
calculator buttons. Button.qml specifies the basic properties for a
|
||||
button that we can modify for each button instance in NumberPad.qml. For the
|
||||
digit and separator buttons, we additionally specify the text property using
|
||||
the property alias \c text that we define in Button.qml.
|
||||
Further, we use the CalculatorButton type in the \c NumberPad type to create the
|
||||
calculator buttons. \c CalculatorButton.qml specifies the basic properties for a
|
||||
button that we can modify for each button instance in \c NumberPad.qml. For the
|
||||
digit and separator buttons, we additionally specify the \c text property.
|
||||
|
||||
For the operator buttons, we also specify another color (green) using the
|
||||
property alias \c color and set the operator property to \c true. We use
|
||||
|
|
@ -131,14 +130,13 @@
|
|||
We use the easing curve of the type \c Easing.InOutQuad to accelerate the
|
||||
motion until halfway and then decelerate it.
|
||||
|
||||
In Button.qml, the text colors of the number pad buttons are also animated.
|
||||
In \c CalculatorButton.qml, the text colors of the number pad buttons are also animated.
|
||||
|
||||
\quotefromfile demos/calqlatr/content/Button.qml
|
||||
\quotefromfile demos/calqlatr/content/CalculatorButton.qml
|
||||
\skipto Text
|
||||
\printuntil id:
|
||||
\dots 8
|
||||
\skipto color:
|
||||
\printuntil ]
|
||||
\printuntil }
|
||||
\printuntil }
|
||||
|
||||
We use \l {QtQml::Qt::darker()}{Qt.darker()} to darken the color when the
|
||||
|
|
@ -152,11 +150,12 @@
|
|||
|
||||
In order to dynamically change the \c dimmed property of all the buttons
|
||||
of the \c NumberPad, we connect its \c buttonPressed signal to the
|
||||
\c Button's \c updateDimmed() function in Button.qml:
|
||||
\c NumberPad's \c updateDimmed() function.
|
||||
|
||||
\quotefromfile demos/calqlatr/content/Button.qml
|
||||
\skipto function updateDimmed() {
|
||||
\printuntil buttonPressed.connect
|
||||
\quotefromfile demos/calqlatr/content/NumberPad.qml
|
||||
\skipto function updateDimmed()
|
||||
\printuntil operatorPressed
|
||||
\printuntil }
|
||||
\printuntil }
|
||||
|
||||
This way, when a button is pressed, all buttons on the \c NumPad
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@
|
|||
\li \l AndroidInAppPurchaseBackend
|
||||
\li Comminucates with external store.
|
||||
\row
|
||||
\li \l androidjni.cpp and InAppPurchase.java
|
||||
\li \c{androidjni.cpp} and \c{InAppPurchase.java}
|
||||
\li Communication between Google Play's billing system and C++.
|
||||
\endtable
|
||||
|
||||
|
|
@ -92,9 +92,10 @@
|
|||
|
||||
\section1 InAppPurchase.java and androidjni.cpp
|
||||
|
||||
AndroidInAppPurchaseBackend makes calls directly to InAppPurchase.java and
|
||||
AndroidInAppPurchaseBackend makes calls directly to \c InAppPurchase.java and
|
||||
receives Java calls from androidjni. The demo application communicates
|
||||
with Java function using \l QJniObjects.
|
||||
with Java function using \l QJniObject.
|
||||
|
||||
\sa \l {https://developer.android.com/google/play/billing/integrate#java}{Integrate the Google Play Billing Library}, \l QJniObjects and \l QJniEnvironment.
|
||||
\sa {https://developer.android.com/google/play/billing/integrate#java}{Integrate the Google Play Billing Library},
|
||||
QJniObject, and QJniEnvironment.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -73,12 +73,12 @@
|
|||
};
|
||||
\endcode
|
||||
|
||||
Check out the derived classes \l AndroidInAppProduct for Android and \l IosInAppProduct for iOS.
|
||||
Check out the derived classes \c AndroidInAppProduct for Android and \c IosInAppProduct for iOS.
|
||||
|
||||
\section1 InAppStore
|
||||
|
||||
The main entry point for managing in-app purchases. It is the base class for AndroidInAppProduct and
|
||||
IosInAppProduct.
|
||||
The main entry point for managing in-app purchases. It is the base class for \c AndroidInAppProduct and
|
||||
\c IosInAppProduct.
|
||||
|
||||
InAppStore is used for managing in-app purchases in the application in a cross-platform way.
|
||||
Depending on the compiler, InAppStore checks what platform is available using \c Macros.
|
||||
|
|
@ -120,13 +120,13 @@
|
|||
|
||||
Once the items have been successfully registered in the store, The user can purchase them by
|
||||
pressing on of the products on the apps store page. QML will call product.purchase()
|
||||
function in AndroidInAppProduct or IosInAppProduct which will open the external store's
|
||||
function in AndroidInAppProduct or \c IosInAppProduct which will open the external store's
|
||||
purchasing flow.
|
||||
|
||||
When a purchase has been completed regardless of success, the transactionRedy signal will be
|
||||
sent to \c InAppProductQmlType, to notify QML to start finalize the transaction.
|
||||
|
||||
section2 Restoring purchases
|
||||
\section2 Restoring purchases
|
||||
|
||||
In the demo unlockable purchases will be saved on the apps storage. By clearing the storage
|
||||
the user will lose the unlockable purchase and it cannot be purchased again, as according to
|
||||
|
|
@ -151,10 +151,10 @@
|
|||
been performed, finalize() should be called. The finalize() function should be called regardless
|
||||
of the status of the transaction.
|
||||
|
||||
Check out the derived classes \l {AndroidInAppTransaction}{AndroidInAppTransaction} for android and \l {IosInAppTransaction}{IosInAppTransaction} for iOS.
|
||||
Check out the derived classes \c{AndroidInAppTransaction} for android and \c{IosInAppTransaction} for iOS.
|
||||
|
||||
\section1 InAppPurchaseBackend
|
||||
|
||||
InAppPurchaseBackend is used to create derived classs for
|
||||
AndroidInAppPurchaseBackend and IosInAppPurchaseBackend
|
||||
\c InAppPurchaseBackend is used to create derived classs for
|
||||
\c AndroidInAppPurchaseBackend and \c IosInAppPurchaseBackend.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@
|
|||
\section1 Registering products
|
||||
|
||||
Before you can operate on the products in your code, they must be
|
||||
registered in the QML graph. You start by making a \l{Store} item,
|
||||
registered in the QML graph. You start by making a Store item,
|
||||
and then create each product as a child of this.
|
||||
|
||||
\qml
|
||||
|
|
@ -86,10 +86,12 @@
|
|||
\section1 The product declaration
|
||||
|
||||
For each product you must fill out the \c identifier, before the product can
|
||||
be queried from the external store. You should also always add a \l{QtPurchasing::Product::onPurchaseSucceeded}{onPurchaseSucceeded}
|
||||
and a \l{QtPurchasing::Product::onPurchaseFailed}{onPurchaseFailed} handler if you intend to provide the option to purchase
|
||||
the products. If you are also using the restore functionality, you should add a
|
||||
\l{QtPurchasing::Product::onPurchaseRestored}{onPurchaseRestored} handler to your unlockable products.
|
||||
be queried from the external store. You should also always add a \c{QtPurchasing::Product::onPurchaseSucceeded}
|
||||
and a \c{QtPurchasing::Product::onPurchaseFailed} handler if you intend to
|
||||
provide the option to purchase the products. If you are also using the
|
||||
restore functionality, you should add a
|
||||
\c{QtPurchasing::Product::onPurchaseRestored} handler to your unlockable
|
||||
products.
|
||||
|
||||
The signal handlers should handle the incoming transaction. Once the transaction
|
||||
has been handled appropriately, it should be finalized. For instance, when a purchase
|
||||
|
|
@ -172,8 +174,8 @@
|
|||
\endqml
|
||||
|
||||
When the button is clicked, the purchase process is started. At some point in the future, either the
|
||||
\l{QtPurchasing::Product::onPurchaseFailed}{onPurchaseFailed} handler will be called (for example if the user cancels the transaction), or the
|
||||
\l{QtPurchasing::Product::onPurchaseSucceeded}{onPurchaseSucceeded} handler will be called.
|
||||
\c{QtPurchasing::Product::onPurchaseFailed} handler will be called (for example if the user cancels the transaction), or the
|
||||
\c{QtPurchasing::Product::onPurchaseSucceeded} handler will be called.
|
||||
|
||||
\note The button is only enabled if the product's status is set to Registered. The registration process
|
||||
for a product is asynchronous, so purchases attempted on a product before it has been successfully registered
|
||||
|
|
@ -186,7 +188,7 @@
|
|||
in the external market place.
|
||||
|
||||
To start the process of restoring purchases, you should call the restorePurchases() method in the
|
||||
\l Store object. This will cause the onPurchaseRestored handler to be called in each of the application's
|
||||
\c Store object. This will cause the onPurchaseRestored handler to be called in each of the application's
|
||||
unlockable products that has previously been purchased by the current user.
|
||||
|
||||
Continuing on the example from before, which could be some sort of role-playing computer game, lets imagine
|
||||
|
|
|
|||
Loading…
Reference in New Issue