-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ci skip] docs: Add partial documentation
- Loading branch information
1 parent
a1bf0f8
commit d29c06c
Showing
5 changed files
with
123 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
source "https://rubygems.org" | ||
|
||
gem "github-pages", "~> 219", group: :jekyll_plugins | ||
|
||
gem "kramdown-parser-gfm" | ||
gem "jekyll-include-cache" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
remote_theme: mmistakes/minimal-mistakes | ||
title: libcutienetworking | ||
description: A library and a QML module that provides network setting abstraction for Cutie | ||
logo: "https://avatars.githubusercontent.com/u/88682014?s=200&v=4" | ||
plugins: | ||
- jekyll-include-cache | ||
footer: | ||
links: | ||
- label: "GitHub" | ||
icon: "fa fa-fw fa-github" | ||
url: "https://github.com/cutie-shell/qml-module-cutie" | ||
- label: "Telegram" | ||
icon: "fa fa-fw fa-telegram" | ||
url: "https://t.me/CutieShellProject" | ||
- label: "Matrix" | ||
icon: "fa fa-fw fa-matrix-org" | ||
url: "https://matrix.to/#/#cutieshell:matrix.org" | ||
atom_feed: | ||
hide: true | ||
include: ["_pages"] | ||
defaults: | ||
- scope: | ||
path: "" | ||
type: pages | ||
values: | ||
layout: single | ||
author_profile: false | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<meta charset="utf-8"> | ||
|
||
{% include seo.html %} | ||
|
||
{% unless site.atom_feed.hide %} | ||
<link href="{% if site.atom_feed.path %}{{ site.atom_feed.path }}{% else %}{{ '/feed.xml' | relative_url }}{% endif %}" type="application/atom+xml" rel="alternate" title="{{ site.title }} Feed"> | ||
{% endunless %} | ||
|
||
{%- comment %} https://docs.google.com/presentation/d/1rmxwWa9P6_xHqonmh5ONXRS-jPc5XKbnv99Rjkhe04s/present {% endcomment -%} | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
|
||
<script type="text/javascript"> | ||
document.documentElement.className = document.documentElement.className.replace(/\bno-js\b/g, '') + ' js '; | ||
{% if site.enable_copy_code_button -%} | ||
window.enable_copy_code_button = true; | ||
{%- endif %} | ||
</script> | ||
|
||
<!-- For all browsers --> | ||
<link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}"> | ||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-awesome@1.2.0/css/fork-awesome.min.css"> | ||
|
||
{% if site.head_scripts %} | ||
{% for script in site.head_scripts %} | ||
<script src="{{ script | relative_url }}"></script> | ||
{% endfor %} | ||
{% endif %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: libcutienetworking | ||
--- | ||
|
||
libcutienetworking is a library and a QML module that provides networking abstraction for Cutie. | ||
|
||
[Read more about Cutie](https://cutie-shell.org){: .btn} | ||
|
||
## API Reference | ||
|
||
All QML types in this module can be imported with: | ||
|
||
``` | ||
import Cutie.Networking | ||
``` | ||
|
||
#### QML Types | ||
|
||
- [CutieMobileNetwork](#) | ||
- [CutieNetworkConnection](types/networkconnection) | ||
- [CutieWifiAccessPoint](#) | ||
- [CutieWifiSettings](#) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: CutieNetworkConnection QML Type | ||
--- | ||
|
||
CutieNetworkConnection provides an interface to interact with a network connection saved to [NetworkManager](https://networkmanager.dev/). | ||
|
||
Inherits: QObject | ||
|
||
### Properties | ||
|
||
- [data](#data): object | ||
- [path](#path): string | ||
|
||
### Methods | ||
|
||
- [deleteConnection()](#deleteconnection) | ||
|
||
## Detailed Description | ||
|
||
CutieNetworkConnection is a type representing a network connection saved to [NetworkManager](https://networkmanager.dev/). For wireless networks, [CutieWifiSettings.addAndActivateConnection](wifisettings#addandactivateconnection) can be used to store a new connection and activate it immediately. Also, [CutieWifiSettings.activateConnection](wifisettings#activateconnection) can be used to activate an existing saved connection represented by an object of this type. | ||
|
||
## Property Documentation | ||
|
||
#### data | ||
|
||
object, readonly | ||
|
||
Holds a JavaScript object containing the connection properties as given by [NetworkManager](https://networkmanager.dev/) D-Bus service. | ||
|
||
#### path | ||
|
||
string, readonly | ||
|
||
Holds the D-Bus path that is used by [NetworkManager](https://networkmanager.dev/) describe this connection. | ||
|
||
## Method Documentation | ||
|
||
#### deleteConnection() | ||
|
||
Removes this connection from NetworkManager's saved connections. Does not have a return value. |