Skip to content

Commit c76ef4a

Browse files
aNNiMONaNNiMON
committed
Split modules.yml documentation per module
1 parent 2a45a30 commit c76ef4a

28 files changed

+6336
-6742
lines changed

‎docs/modules.yml

Lines changed: 0 additions & 6742 deletions
This file was deleted.

‎docs/src/modules/android.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: android
2+
scope: "android"
3+
desc: "Contains common Android functions"
4+
desc_ru: "Содержит вспомогательные функции для Android"
5+
constants:
6+
- name: "Intent"
7+
typeName: map
8+
type: 4
9+
value: "{ACTION_BOOT_COMPLETED=android.intent.action.BOOT_COMPLETED, ACTION_DEFAULT=android.intent.action.VIEW, ACTION_DELETE=android.intent.action.DELETE, ACTION_EDIT=android.intent.action.EDIT, ACTION_INSTALL_PACKAGE=android.intent.action.INSTALL_PACKAGE, ACTION_LOCATION_SOURCE_SETTINGS=android.settings.LOCATION_SOURCE_SETTINGS, ACTION_MAIN=android.intent.action.MAIN, ACTION_MEDIA_MOUNTED=android.intent.action.MEDIA_MOUNTED, ACTION_REBOOT=android.intent.action.REBOOT, ACTION_RUN=android.intent.action.RUN, ACTION_SEARCH=android.intent.action.SEARCH, ACTION_SEND=android.intent.action.SEND, ACTION_VIEW=android.intent.action.VIEW, ACTION_WEB_SEARCH=android.intent.action.WEB_SEARCH}"
10+
- name: R
11+
type: 4
12+
typeName: map
13+
value: '{array={}, attr={}, color={}, drawable={}, id={}, integer={}, layout={}, string={}}'
14+
desc: "Resource constants from android.R.xxx class"
15+
desc_ru: "Константы ресурсов класса android.R.xxx"
16+
- name: SDK_INT
17+
type: 1
18+
typeName: number
19+
value: 'Android version SDK'
20+
desc: "Android version SDK"
21+
desc_ru: "Версия SDK Android"
22+
- name: "Span"
23+
typeName: map
24+
type: 4
25+
value: "{COLOR=0, ABSOLUTE_SIZE=1, RELATIVE_SIZE=2, URL=3, STYLE=4, CLICKABLE=5, TYPEFACE=6, HTML=7}"
26+
functions:
27+
- name: "assetBitmap"
28+
args: "path"
29+
desc: "loads bitmap from the file in apk's assets folder"
30+
desc_ru: "загружает изображение из файла в папке assets внутри apk"
31+
- name: "assetBytes"
32+
args: "path"
33+
desc: "reads bytes of the file in apk's assets folder"
34+
desc_ru: "читает массив байт из файла в папке assets внутри apk"
35+
- name: "assetText"
36+
args: "path"
37+
desc: "reads text content of the file in apk's assets folder"
38+
desc_ru: "читает текст файла в папке assets внутри apk"
39+
- name: "chooser"
40+
args: ""
41+
desc: ""
42+
desc_ru: ""
43+
- name: "listAssets"
44+
args: "path"
45+
desc: "returns list of files in apk's assets folder"
46+
desc_ru: "возвращает список файлов в папке assets внутри apk"
47+
- name: "spannable"
48+
args: "type, text, ..."
49+
desc: ""
50+
desc_ru: ""
51+
- name: "startActivity"
52+
args: "intent, uri = \"\", bundle = []"
53+
desc: "starts an activity"
54+
desc_ru: "запускает Activity"
55+
- name: "toast"
56+
args: "text, duration = 0"
57+
desc: "shows toast notification"
58+
desc_ru: "показывает всплывающее уведомление (toast)"
59+
- name: "uithread"
60+
args: "function, ..."
61+
desc: "runs function in main UI-thread"
62+
desc_ru: "выполняет функцию в главном UI-потоке"

‎docs/src/modules/base64.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: base64
2+
scope: both
3+
desc: "Contains base64 encoding and decoding functions"
4+
desc_ru: "Содержит функции кодирования данных в base64 и наоборот"
5+
constants:
6+
- name: BASE64_URL_SAFE
7+
type: 1
8+
typeName: number
9+
value: '8'
10+
desc: 'Url safe encoding output'
11+
desc_ru: 'Вывод данных в безопасном для ссылок формате'
12+
functions:
13+
- name: base64decode
14+
args: 'data, type = 0'
15+
desc: 'decodes base64-encoded byte array or string into byte array'
16+
desc_ru: 'декодирует массив байт или строку, закодированную в base64, в массив байт'
17+
- name: base64encode
18+
args: 'data, type = 0'
19+
desc: 'encodes byte array or string into base64-encoded byte array'
20+
desc_ru: 'кодирует массив байт или строку в закодированный base64 массив байт'
21+
- name: base64encodeToString
22+
args: 'data, type = 0'
23+
desc: 'encodes byte array or string into base64-encoded string'
24+
desc_ru: 'кодирует массив байт или строку в закодированную base64 строку'

‎docs/src/modules/canvas.yml

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: canvas
2+
scope: "desktop"
3+
desc: "Contains functions for working with graphics"
4+
desc_ru: "Содержит функции для работы с графикой"
5+
constants:
6+
- name: "VK_DOWN"
7+
typeName: number
8+
type: 1
9+
value: "40"
10+
desc: "arrow down key code"
11+
desc_ru: "код клавиши стрелка вниз"
12+
- name: "VK_ESCAPE"
13+
typeName: number
14+
type: 1
15+
value: "27"
16+
desc: "Esc key code"
17+
desc_ru: "код клавиши Esc"
18+
- name: "VK_FIRE"
19+
typeName: number
20+
type: 1
21+
value: "10"
22+
desc: "Enter key code"
23+
desc_ru: "код клавиши Enter"
24+
- name: "VK_LEFT"
25+
typeName: number
26+
type: 1
27+
value: "37"
28+
desc: "arrow left key code"
29+
desc_ru: "код клавиши стрелка влево"
30+
- name: "VK_RIGHT"
31+
typeName: number
32+
type: 1
33+
value: "39"
34+
desc: "arrow left key code"
35+
desc_ru: "код клавиши стрелка вправо"
36+
- name: "VK_UP"
37+
typeName: number
38+
type: 1
39+
value: "38"
40+
desc: "arrow up key code"
41+
desc_ru: "код клавиши стрелка вверх"
42+
functions:
43+
- name: "clip"
44+
args: "x, y, w, h"
45+
desc: "sets the current clip to the rectangle specified by the given coordinates"
46+
desc_ru: "устанавливает текущий клип в прямоугольник, заданный данными координатами"
47+
- name: "color"
48+
args: "rgb"
49+
desc: "sets color drawing. `rgb` - color with the specified combined RGB value"
50+
desc_ru: "устанвливает цвет рисования. `rgb` - целое, комбинация цветов RGB, например `#FFGGFF`"
51+
- name: "color"
52+
args: "red, green, blue"
53+
desc: "sets color with the specified red, green, and blue values in the range (0 - 255)"
54+
desc_ru: "устанвливает цвет рисования c отдельными уровнями красного, зеленого и синего в диапазоне (0 - 255)"
55+
- name: "drawstring"
56+
args: "text, x, y"
57+
desc: "draws string `text` at position `x`, `y`"
58+
desc_ru: "рисует строку `text` с координатами `x`, `y`"
59+
- name: "foval"
60+
args: "x, y, w, h"
61+
desc: "draws a filled oval at position `x`,` y`, size `w`,` h`"
62+
desc_ru: "рисует закрашенный овал на позиции `x`, `y`, размером `w`, `h`"
63+
- name: "frect"
64+
args: "x, y, w, h"
65+
desc: "draws a filled rectangle at position `x`,` y`, size `w`,` h`"
66+
desc_ru: "рисует закрашенный прямоугольник на позиции `x`, `y`, размером `w`, `h`"
67+
- name: "keypressed"
68+
args: ""
69+
desc: "returns the code of the pressed key (see the constant section)"
70+
desc_ru: "возрвращает код нажатой клавиши (см. раздел константы)"
71+
- name: "line"
72+
args: "x1, y1, x2, y2"
73+
desc: "draws line from point (`x1`;y1`) to (`x2`;y2`)"
74+
desc_ru: "рисует линию от позиции (`x1`;y1`) до (`x2`;y2`)"
75+
- name: "mousehover"
76+
args: ""
77+
desc: "returns array with current mouse pointer coordinates"
78+
desc_ru: "возвращает массив с текущими координатами указателя мыши"
79+
- name: "oval"
80+
args: "x, y, w, h"
81+
desc: "draws a oval at position `x`,` y`, size `w`,` h`"
82+
desc_ru: "рисует овал на позиции `x`, `y`, размером `w`, `h`"
83+
- name: "prompt"
84+
args: "message"
85+
desc: "displays a dialog box that prompts the visitor for input"
86+
desc_ru: "показывает диалог для ввода значения от пользователя"
87+
- name: "rect"
88+
args: "x, y, w, h"
89+
desc: "draws a rectangle at position `x`,` y`, size `w`,` h`"
90+
desc_ru: "рисует прямоугольник на позиции `x`, `y`, размером `w`, `h`"
91+
- name: "repaint"
92+
args: ""
93+
desc: "draws elements from graphics buffer on canvas"
94+
desc_ru: "прорисовывает элементы из буфера на холсте"
95+
- name: "window"
96+
args: "name, width, hight"
97+
desc: "creates a new window with the specified `name` and size `width`x`height`"
98+
desc_ru: "создает новое окно с именем `name` и размером `width`x`height`"

0 commit comments

Comments
 (0)