Skip to content

Commit

Permalink
Update document of Middleware / MiddlewareList and Hydrate
Browse files Browse the repository at this point in the history
  • Loading branch information
benlau committed Apr 16, 2017
1 parent 3d2ad72 commit f83cf88
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
9 changes: 8 additions & 1 deletion qfhydrate.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,11 @@ static QVariantMap dehydrator(QObject* source) {
\qmltype Hydrate
\inqmlmodule QuickFlux
Rehydration and dehydration are just another words for deserialize and serialize. It could be used to convert Store into JSON object, and vice versa.
\code
import QuickFlux 1.1
\endcode
Hydrate provides an interface to rehydrate / hydrate a Store component. Rehydration and dehydration are just another words for deserialize and serialize. It could be used to convert Store into JSON object, and vice versa.
Remarks: Hydrate supports any QObject based type as the target of deserialize and serialize.
Expand All @@ -74,6 +78,9 @@ Hydrate.rehydrate(store, {
var data = Hydrate.dehydrate(MainStore);
console.log(JSON.stringify(data));
\endcode
It is added since Quick Flux 1.1
*/

QFHydrate::QFHydrate(QObject *parent) : QObject(parent)
Expand Down
2 changes: 1 addition & 1 deletion qfmiddleware.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ User may modify/insert/delay or remove the action.
\code
// Confirmation Dialog
\endcodeimport QuickFlux 1.1
import QuickFlux 1.1
import QtQuick.Dialogs 1.2
Middleware {
Expand Down
6 changes: 6 additions & 0 deletions qfmiddlewarelist.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
\qmltype MiddlewareList
\inqmlmodule QuickFlux
\code
import QuickFlux 1.1
\endcode
MiddlewareList groups a list of Middleware and install to target Dispatcher / ActionCreator
Example Code
Expand Down Expand Up @@ -38,6 +42,8 @@ Item {
\endcode
It is added since QuickFlux 1.1
*/

/*! \qmlproperty var MiddlewareList::applyTarget
Expand Down

0 comments on commit f83cf88

Please sign in to comment.