Commit b84018e1 authored by Michal Policht's avatar Michal Policht

Add README.md and enable documentation.

parent e59964c8
......@@ -25,6 +25,7 @@ Project {
license: "Mozilla Public License, v. 2.0"
files: [
"README.md",
"include/cutehmi/bitcoincash/Address.hpp",
"include/cutehmi/bitcoincash/internal/common.hpp",
"include/cutehmi/bitcoincash/internal/platform.hpp",
......@@ -41,6 +42,11 @@ Project {
Depends { name: "CuteHMI.2" }
Depends { name: "cutehmi.doxygen" }
cutehmi.doxygen.warnIfUndocumented: false
cutehmi.doxygen.useDoxyqml: true
cutehmi.doxygen.exclude: ['tests']
Export {
Depends { name: "CuteHMI.2" }
}
......
# CuteHMI - Bitcoin Cash
This extension provides Bitcoin Cash operations through Bitcoin.com REST API.
Currently only monitoring of Bitcoin Cash addresses is supported. To monitor an address one can use Address class.
......@@ -12,6 +12,9 @@ class QNetworkReply;
namespace cutehmi {
namespace bitcoincash {
/**
* Bitcoin cash address.
*/
class CUTEHMI_BITCOINCASH_API Address:
public QObject
{
......
......@@ -8,6 +8,11 @@ namespace cutehmi {
namespace bitcoincash {
namespace internal {
/**
* @class CuteHMI::BitcoinCash::Address
* Exposes cutehmi::bitcoincash::Address to QML.
*/
void QMLPlugin::registerTypes(const char * uri)
{
Q_ASSERT(uri == QLatin1String("CuteHMI.BitcoinCash"));
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment