Split modules.yml documentation per module

Author: aNNiMON

docs/modules.yml

@@ -0,0 +1,62 @@
+name: android
+scope: "android"
+desc: "Contains common Android functions"
+desc_ru: "Содержит вспомогательные функции для Android"
+constants:
+  - name: "Intent"
+    typeName: map
+    type: 4
+    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}"
+  - name: R
+    type: 4
+    typeName: map
+    value: '{array={}, attr={}, color={}, drawable={}, id={}, integer={}, layout={}, string={}}'
+    desc: "Resource constants from android.R.xxx class"
+    desc_ru: "Константы ресурсов класса android.R.xxx"
+  - name: SDK_INT
+    type: 1
+    typeName: number
+    value: 'Android version SDK'
+    desc: "Android version SDK"
+    desc_ru: "Версия SDK Android"
+  - name: "Span"
+    typeName: map
+    type: 4
+    value: "{COLOR=0, ABSOLUTE_SIZE=1, RELATIVE_SIZE=2, URL=3, STYLE=4, CLICKABLE=5, TYPEFACE=6, HTML=7}"
+functions:
+  - name: "assetBitmap"
+    args: "path"
+    desc: "loads bitmap from the file in apk's assets folder"
+    desc_ru: "загружает изображение из файла в папке assets внутри apk"
+  - name: "assetBytes"
+    args: "path"
+    desc: "reads bytes of the file in apk's assets folder"
+    desc_ru: "читает массив байт из файла в папке assets внутри apk"
+  - name: "assetText"
+    args: "path"
+    desc: "reads text content of the file in apk's assets folder"
+    desc_ru: "читает текст файла в папке assets внутри apk"
+  - name: "chooser"
+    args: ""
+    desc: ""
+    desc_ru: ""
+  - name: "listAssets"
+    args: "path"
+    desc: "returns list of files in apk's assets folder"
+    desc_ru: "возвращает список файлов в папке assets внутри apk"
+  - name: "spannable"
+    args: "type, text, ..."
+    desc: ""
+    desc_ru: ""
+  - name: "startActivity"
+    args: "intent, uri = \"\", bundle = []"
+    desc: "starts an activity"
+    desc_ru: "запускает Activity"
+  - name: "toast"
+    args: "text, duration = 0"
+    desc: "shows toast notification"
+    desc_ru: "показывает всплывающее уведомление (toast)"
+  - name: "uithread"
+    args: "function, ..."
+    desc: "runs function in main UI-thread"
+    desc_ru: "выполняет функцию в главном UI-потоке"

docs/src/modules/android.yml

@@ -0,0 +1,24 @@
+name: base64
+scope: both
+desc: "Contains base64 encoding and decoding functions"
+desc_ru: "Содержит функции кодирования данных в base64 и наоборот"
+constants:
+  - name: BASE64_URL_SAFE
+    type: 1
+    typeName: number
+    value: '8'
+    desc: 'Url safe encoding output'
+    desc_ru: 'Вывод данных в безопасном для ссылок формате'
+functions:
+  - name: base64decode
+    args: 'data, type = 0'
+    desc: 'decodes base64-encoded byte array or string into byte array'
+    desc_ru: 'декодирует массив байт или строку, закодированную в base64, в массив байт'
+  - name: base64encode
+    args: 'data, type = 0'
+    desc: 'encodes byte array or string into base64-encoded byte array'
+    desc_ru: 'кодирует массив байт или строку в закодированный base64 массив байт'
+  - name: base64encodeToString
+    args: 'data, type = 0'
+    desc: 'encodes byte array or string into base64-encoded string'
+    desc_ru: 'кодирует массив байт или строку в закодированную base64 строку'

docs/src/modules/base64.yml

@@ -0,0 +1,98 @@
+name: canvas
+scope: "desktop"
+desc: "Contains functions for working with graphics"
+desc_ru: "Содержит функции для работы с графикой"
+constants:
+  - name: "VK_DOWN"
+    typeName: number
+    type: 1
+    value: "40"
+    desc: "arrow down key code"
+    desc_ru: "код клавиши стрелка вниз"
+  - name: "VK_ESCAPE"
+    typeName: number
+    type: 1
+    value: "27"
+    desc: "Esc key code"
+    desc_ru: "код клавиши Esc"
+  - name: "VK_FIRE"
+    typeName: number
+    type: 1
+    value: "10"
+    desc: "Enter key code"
+    desc_ru: "код клавиши Enter"
+  - name: "VK_LEFT"
+    typeName: number
+    type: 1
+    value: "37"
+    desc: "arrow left key code"
+    desc_ru: "код клавиши стрелка влево"
+  - name: "VK_RIGHT"
+    typeName: number
+    type: 1
+    value: "39"
+    desc: "arrow left key code"
+    desc_ru: "код клавиши стрелка вправо"
+  - name: "VK_UP"
+    typeName: number
+    type: 1
+    value: "38"
+    desc: "arrow up key code"
+    desc_ru: "код клавиши стрелка вверх"
+functions:
+  - name: "clip"
+    args: "x, y, w, h"
+    desc: "sets the current clip to the rectangle specified by the given coordinates"
+    desc_ru: "устанавливает текущий клип в прямоугольник, заданный данными координатами"
+  - name: "color"
+    args: "rgb"
+    desc: "sets color drawing. `rgb` - color with the specified combined RGB value"
+    desc_ru: "устанвливает цвет рисования. `rgb` - целое, комбинация цветов RGB, например `#FFGGFF`"
+  - name: "color"
+    args: "red, green, blue"
+    desc: "sets color with the specified red, green, and blue values in the range (0 - 255)"
+    desc_ru: "устанвливает цвет рисования c отдельными уровнями красного, зеленого и синего в диапазоне (0 - 255)"
+  - name: "drawstring"
+    args: "text, x, y"
+    desc: "draws string `text` at position `x`, `y`"
+    desc_ru: "рисует строку `text` с координатами `x`, `y`"
+  - name: "foval"
+    args: "x, y, w, h"
+    desc: "draws a filled oval at position `x`,` y`, size `w`,` h`"
+    desc_ru: "рисует закрашенный овал на позиции `x`, `y`, размером `w`, `h`"
+  - name: "frect"
+    args: "x, y, w, h"
+    desc: "draws a filled rectangle at position `x`,` y`, size `w`,` h`"
+    desc_ru: "рисует закрашенный прямоугольник на позиции `x`, `y`, размером `w`, `h`"
+  - name: "keypressed"
+    args: ""
+    desc: "returns the code of the pressed key (see the constant section)"
+    desc_ru: "возрвращает код нажатой клавиши (см. раздел константы)"
+  - name: "line"
+    args: "x1, y1, x2, y2"
+    desc: "draws line from point (`x1`;y1`) to (`x2`;y2`)"
+    desc_ru: "рисует линию от позиции (`x1`;y1`) до (`x2`;y2`)"
+  - name: "mousehover"
+    args: ""
+    desc: "returns array with current mouse pointer coordinates"
+    desc_ru: "возвращает массив с текущими координатами указателя мыши"
+  - name: "oval"
+    args: "x, y, w, h"
+    desc: "draws a oval at position `x`,` y`, size `w`,` h`"
+    desc_ru: "рисует овал на позиции `x`, `y`, размером `w`, `h`"
+  - name: "prompt"
+    args: "message"
+    desc: "displays a dialog box that prompts the visitor for input"
+    desc_ru: "показывает диалог для ввода значения от пользователя"
+  - name: "rect"
+    args: "x, y, w, h"
+    desc: "draws a rectangle at position `x`,` y`, size `w`,` h`"
+    desc_ru: "рисует прямоугольник на позиции `x`, `y`, размером `w`, `h`"
+  - name: "repaint"
+    args: ""
+    desc: "draws elements from graphics buffer on canvas"
+    desc_ru: "прорисовывает элементы из буфера на холсте"
+  - name: "window"
+    args: "name, width, hight"
+    desc: "creates a new window with the specified `name` and size `width`x`height`"
+    desc_ru: "создает новое окно с именем `name` и размером `width`x`height`"