Compare commits

..
3 Commits
Author SHA1 Message Date
Iuri Matias 2b71a674ff test docs 2022-02-10 16:38:33 -05:00
Iuri Matias aa93cf2968 test docs 2022-02-10 16:37:57 -05:00
Alexandra Betouni a8f096faaf feat(StatusQ) Adding qdoc related files
Added qdoc conf & source files for each
StatusQ module. Documented StatusBaseText
from StatusQ.Core as an example

To generate docs, from sandbox/docs run
/path/to/Qt/installation/bin/qdoc statusq.qdocconf

A folder named "html" will be generated under sandbox/doc,
open the statusq-index.html to get to the home page.

Closes #550
2022-02-10 22:39:47 +02:00
13 changed files with 1402 additions and 13 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

@@ -0,0 +1,15 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- StatusBaseText.qml -->
<title>List of All Members for StatusBaseText | StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><li><a href="statusq-index.html">StatusQ</a></li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for StatusBaseText</h1>
<p>This is the complete list of members for <a href="qml-statusq-core-statusbasetext.html">StatusBaseText</a>, including inherited members.</p>
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+41
View File
@@ -0,0 +1,41 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- StatusBaseText.qml -->
<title>StatusBaseText QML Type | StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><li><a href="statusq-index.html">StatusQ</a></li>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">StatusBaseText QML Type</h1>
<span class="subtitle"></span>
<!-- $$$StatusBaseText-brief -->
<p>Displays multiple lines of text. Inherits <a href="https://doc.qt.io/qt-5/qml-qtquick-text.html">Text</a>. <a href="#details">More...</a></p>
<!-- @@@StatusBaseText -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import StatusQ.Core 0.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> StatusQ.Core 0.1</td></tr></table></div><ul>
<li><a href="qml-statusq-core-statusbasetext-members.html">List of all members, including inherited members</a></li>
</ul>
<!-- $$$StatusBaseText-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The <code>StatusBaseText</code> item displays text. For example:</p>
<pre class="qml"><span class="type"><a href="qml-statusq-core-statusbasetext.html">StatusBaseText</a></span> {
<span class="name">width</span>: <span class="number">240</span>
<span class="name">text</span>: <span class="string">&quot;Hello World!&quot;</span>
<span class="name">font</span>.pixelSize: <span class="number">24</span>
<span class="name">color</span>: <span class="name">Theme</span>.<span class="name">pallete</span>.<span class="name">directColor1</span>
}</pre>
<p class="centerAlign"><img src="images/status_base_text.png" alt="" /></p><p>For a list of components available see <a href="statusq-index.html">StatusQ</a>.</p>
<!-- @@@StatusBaseText -->
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+53
View File
@@ -0,0 +1,53 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- statusqcomponents.qdoc -->
<title>StatusQ Components | StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><li><a href="statusq-index.html">StatusQ</a></li>
<li>StatusQ Components</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">StatusQ Components</h1>
<span class="subtitle"></span>
<!-- $$$StatusQ.Components-description -->
<div class="descr"> <a name="details"></a>
<p>This is a listing of all Components components.</p>
<p>This module is part of the <a href="statusq-index.html">StatusQ</a> project.</p>
<ul>
<li>StatusAddress</li>
<li>StatusBadge</li>
<li>StatusChatInfoToolBar</li>
<li>StatusChatList</li>
<li>StatusChatListItem</li>
<li>StatusImageSettings</li>
<li>StatusChatListCategory</li>
<li>StatusChatListCategoryItem</li>
<li>StatusChatListAndCategories</li>
<li>StatusChatToolBar</li>
<li>StatusContactRequestsIndicatorListItem</li>
<li>StatusDescriptionListItem</li>
<li>StatusLetterIdenticon</li>
<li>StatusListItem</li>
<li>StatusListSectionHeadline</li>
<li>StatusLoadingIndicator</li>
<li>StatusMemberListItem</li>
<li>StatusNavigationListItem</li>
<li>StatusNavigationPanelHeadline</li>
<li>StatusRoundIcon</li>
<li>StatusRoundedImage</li>
<li>StatusMacWindowButtons</li>
<li>StatusListItemBadge</li>
<li>StatusExpandableItem</li>
<li>StatusSmartIdenticon</li>
<li>StatusMessage</li>
<li>StatusMessageDetails</li>
<li>StatusTagSelector</li>
<li>StatusToastMessage</li>
</ul>
</div>
<!-- @@@StatusQ.Components -->
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+55
View File
@@ -0,0 +1,55 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- statusqcontrols.qdoc -->
<title>StatusQ Controls | StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><li><a href="statusq-index.html">StatusQ</a></li>
<li>StatusQ Controls</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">StatusQ Controls</h1>
<span class="subtitle"></span>
<!-- $$$StatusQ.Controls-description -->
<div class="descr"> <a name="details"></a>
<p>This is a listing of all Controls components.</p>
<p>This module is part of the <a href="statusq-index.html">StatusQ</a> project.</p>
<ul>
<li>StatusAccountSelector</li>
<li>StatusAssetSelector</li>
<li>StatusBanner</li>
<li>StatusChatCommandButton</li>
<li>StatusChatInfoButton</li>
<li>StatusChatListCategoryItemButton</li>
<li>StatusColorSelector</li>
<li>StatusIconTabButton</li>
<li>StatusNavBarTabButton</li>
<li>StatusTabBarIconButton</li>
<li>StatusToolTip</li>
<li>StatusBaseButton</li>
<li>StatusButton</li>
<li>StatusFlatButton</li>
<li>StatusRoundButton</li>
<li>StatusFlatRoundButton</li>
<li>StatusSwitch</li>
<li>StatusRadioButton</li>
<li>StatusCheckBox</li>
<li>StatusSlider</li>
<li>StatusSelect</li>
<li>StatusBaseInput</li>
<li>StatusInput</li>
<li>StatusPickerButton</li>
<li>StatusProgressBar</li>
<li>StatusPasswordStrengthIndicator</li>
<li>StatusSwitchTabButton</li>
<li>StatusSwitchTabBar</li>
<li>StatusSelectableText</li>
<li>StatusWalletColorButton</li>
<li>StatusWalletColorSelect</li>
</ul>
</div>
<!-- @@@StatusQ.Controls -->
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+35
View File
@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- statusqcore.qdoc -->
<title>StatusQ Core | StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><li><a href="statusq-index.html">StatusQ</a></li>
<li>StatusQ Core</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">StatusQ Core</h1>
<span class="subtitle"></span>
<!-- $$$StatusQ.Core-description -->
<div class="descr"> <a name="details"></a>
<p>This is a listing of all Core components. These files are available for general import and they are based off the <a href="https://doc.qt.io/qt-5/qtquick-qmlmodule.html">Qt Quick Primitives</a> and <a href="https://doc.qt.io/archives/qt-5.11/qtquick-controls2-qmlmodule.html">Qt Quick Controls 2</a>.</p>
<p>This module is part of the <a href="statusq-index.html">StatusQ</a> project.</p>
<ul>
<li>StatusAppNavBarFilterModel</li>
<li><a href="qml-statusq-core-statusbasetext.html">StatusBaseText</a></li>
<li>StatusIcon</li>
<li>StatusIconBackgroundSettings</li>
<li>StatusIconSettings</li>
<li>StatusImageSettings</li>
<li>StatusModalHeaderSettings</li>
<li>StatusTooltipSettings</li>
</ul>
</div>
<!-- @@@StatusQ.Core -->
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-statusq-core-statusbasetext.html">StatusBaseText</a></p></td><td class="tblDescr"><p>Displays multiple lines of text. Inherits Text</p></td></tr>
</table></div>
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+28
View File
@@ -0,0 +1,28 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- statusq-overview.qdoc -->
<title>StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">StatusQ</h1>
<span class="subtitle"></span>
<!-- $$$statusq-index.html-description -->
<div class="descr"> <a name="details"></a>
<p><a href="statusq-index.html">StatusQ</a> provides a collection of components..&#x2e;&#x2e;</p>
<p><a href="statusq-index.html">StatusQ</a> - Components and Interfaces</p>
<ul>
<li><a href="statusq-components-qmlmodule.html">Components</a></li>
<li><a href="statusq-controls-qmlmodule.html">Controls</a></li>
<li><a href="statusq-core-qmlmodule.html">Core</a></li>
<li><a href="statusq-layout-qmlmodule.html">Layout</a></li>
<li><a href="statusq-platform-qmlmodule.html">Platform</a></li>
<li><a href="statusq-popups-qmlmodule.html">Popups</a></li>
</ul>
</div>
<!-- @@@statusq-index.html -->
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+28
View File
@@ -0,0 +1,28 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- statusqlayout.qdoc -->
<title>StatusQ Layout | StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><li><a href="statusq-index.html">StatusQ</a></li>
<li>StatusQ Layout</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">StatusQ Layout</h1>
<span class="subtitle"></span>
<!-- $$$StatusQ.Layout-description -->
<div class="descr"> <a name="details"></a>
<p>This is a listing of all Layout components.</p>
<p>This module is part of the <a href="statusq-index.html">StatusQ</a> project.</p>
<ul>
<li>StatusAppLayout</li>
<li>StatusAppNavBar</li>
<li>StatusAppTwoPanelLayout</li>
<li>StatusAppThreePanelLayout</li>
</ul>
</div>
<!-- @@@StatusQ.Layout -->
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+27
View File
@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- statusqplatform.qdoc -->
<title>StatusQ Platform | StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><li><a href="statusq-index.html">StatusQ</a></li>
<li>StatusQ Platform</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">StatusQ Platform</h1>
<span class="subtitle"></span>
<!-- $$$StatusQ.Platform-description -->
<div class="descr"> <a name="details"></a>
<p>This is a listing of all Platform components.</p>
<p>This module is part of the <a href="statusq-index.html">StatusQ</a> project.</p>
<ul>
<li>StatusMacTrafficLights</li>
<li>StatusMacNotification</li>
<li>StatusWindowsTitleBar</li>
</ul>
</div>
<!-- @@@StatusQ.Platform -->
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+34
View File
@@ -0,0 +1,34 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- statusqpopups.qdoc -->
<title>StatusQ Popups | StatusQ 0.1</title>
<link rel="stylesheet" type="text/css" href="style/style.css"/>
</head>
<body>
<p class="header"><small>StatusQ - A Components selection for Status dekstop client. </p></small></p><hr/><li><a href="statusq-index.html">StatusQ</a></li>
<li>StatusQ Popups</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">StatusQ Popups</h1>
<span class="subtitle"></span>
<!-- $$$StatusQ.Popups-description -->
<div class="descr"> <a name="details"></a>
<p>This is a listing of all Popups components.</p>
<p>This module is part of the <a href="statusq-index.html">StatusQ</a> project.</p>
<ul>
<li>StatusMenuSeparator</li>
<li>StatusPopupMenu</li>
<li>StatusMenuItem</li>
<li>StatusMenuItemDelegate</li>
<li>StatusModal</li>
<li>StatusSearchPopup</li>
<li>StatusModalDivider</li>
<li>StatusSearchPopupMenuItem</li>
<li>StatusSearchLocationMenu</li>
<li>StatusSpellcheckingMenuItems</li>
</ul>
</div>
<!-- @@@StatusQ.Popups -->
<hr/><div class="footer"><p><acronym title="Copyright">&copy;</acronym> 2022 Status. All rights reserved. <a href="https://status.im" target="_blank"><small>status.im</a></small></p></div></body>
</html>
+1036
View File
File diff suppressed because it is too large Load Diff
+41
View File
@@ -0,0 +1,41 @@
body {
font-family: "Verdana";
font-size: 14px;
max-width: 80%;
margin: auto;
}
h1, h2, h3 {
color: #4360DF;
}
div.sidebar {
float: right;
}
pre {
padding: 15px;
}
div.qmlproto {
padding-left: 15px;
padding-right: 15px;
}
pre, div.qmlproto {
font-family: "Courier New";
font-size: 20px;
margin-left: 2em;
background-color: #F0F2F5;
}
hr {
margin-top: 2em;
margin-bottom: 2em;
}
p.header {
margin-bottom: -1em;
}
p.footer {
text-align: right;
margin-top: -1em;
}
+9 -13
View File
@@ -71,27 +71,22 @@ Page {
StatusBaseText {
id: contactsLabel
font.pixelSize: 15
anchors.left: parent.left
anchors.leftMargin: 8
color: Theme.palette.baseColor1
text: qsTr("Contacts")
text: "Contacts"
}
Control {
width: 360
anchors {
top: contactsLabel.bottom
topMargin: 8//Style.current.padding
bottom: !statusPopupMenuBackgroundContent.visible ? parent.bottom : undefined
bottom: parent.bottom
bottomMargin: 20//Style.current.bigPadding
}
height: 16 + (!statusPopupMenuBackgroundContent.visible ? parent.height :
(((userListView.count * 64) > parent.height) ? parent.height : (userListView.count * 64)))
x: (statusPopupMenuBackgroundContent.visible && (tagSelector.namesModel.count > 0) &&
((tagSelector.textEdit.x + 24 + statusPopupMenuBackgroundContent.width) < parent.width))
? (tagSelector.textEdit.x + 24) : 0
background: Rectangle {
id: statusPopupMenuBackgroundContent
anchors.fill: parent
anchors.left: parent.left
anchors.right: parent.right
height: (userListView.height + 8)
visible: (tagSelector.sortedList.count > 0)
color: Theme.palette.statusPopupMenu.backgroundColor
radius: 8
@@ -112,9 +107,9 @@ Page {
}
contentItem: ListView {
id: userListView
anchors.fill: parent
anchors.topMargin: 8
anchors.bottomMargin: 8
anchors.left: parent.left
anchors.right: parent.right
height: (count * 64) > parent.height ? parent.height : (count * 64)
clip: true
model: contactsModel
ScrollBar.vertical: ScrollBar {
@@ -130,6 +125,7 @@ Page {
Rectangle {
id: rectangle
anchors.fill: parent
anchors.topMargin: 8
anchors.rightMargin: 8
anchors.leftMargin: 8
radius: 8