doc: add lilka::begin section

doc: cleanup index doc: update PDFs
and3rson · Feb 24, 2024 · dcf51b9 · dcf51b9
1 parent 93c59b8
commit dcf51b9
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 4 deletions.
diff --git a/docs/_gen/v2_pcb.pdf b/docs/_gen/v2_pcb.pdf
diff --git a/docs/_gen/v2_schematic.pdf b/docs/_gen/v2_schematic.pdf
diff --git a/docs/library/battery.rst b/docs/library/battery.rst
@@ -1,11 +1,11 @@
 ``Battery``: Батарея
 ====================
 
+.. doxygenvariable:: lilka::battery
+
 .. doxygendefine:: LILKA_DEFAULT_EMPTY_VOLTAGE
 .. doxygendefine:: LILKA_DEFAULT_FULL_VOLTAGE
 
-.. doxygenvariable:: lilka::battery
-
 .. doxygenclass:: lilka::Battery
    :members:
    :undoc-members:
diff --git a/docs/library/index.rst b/docs/library/index.rst
@@ -14,6 +14,10 @@
 
 Також ``lilka`` спрощує ініціалізацію дисплею, кнопок, батареї, звуку, SD-карти та інших компонентів, що входять до складу Лілки. Для цього потрібно викликати лише одну функцію - ``lilka::begin()``.
 
+Тому, незалежно від рівня вашої кваліфікації, ми радимо використовувати бібліолеку ``lilka`` для роботи з Лілкою.
+
+.. doxygenfunction:: lilka::begin
+
 .. code-block:: cpp
     :linenos:
     :emphasize-lines: 1,4
@@ -47,8 +51,6 @@
         }
     }
 
-Тому, незалежно від рівня вашої кваліфікації, ми радимо використовувати бібліолеку ``lilka`` для роботи з Лілкою.
-
 .. note::
 
     Порада для початківців: ви могли помітити, що всі функції та об'єкти бібліотеки ``lilka`` викликаються через ``::``. Це означає, що вони належать до `простору назв <https://uk.wikipedia.org/wiki/%D0%9F%D1%80%D0%BE%D1%81%D1%82%D1%96%D1%80_%D0%BD%D0%B0%D0%B7%D0%B2>`_ ``lilka``.

diff --git a/docs/library/loader.rst b/docs/library/loader.rst
@@ -1,6 +1,8 @@
 ``Loader``: Завантажувач прошивок
 =================================
 
+.. doxygenvariable:: lilka::loader
+
 .. doxygenclass:: lilka::Loader
     :members:
     :undoc-members:

diff --git a/sdk/lib/lilka/src/lilka.h b/sdk/lib/lilka/src/lilka.h
@@ -17,6 +17,11 @@
 #include "mjs/mjsrunner.h"
 
 namespace lilka {
+/// Ініціалізація Лілки
+///
+/// Ініціалізує всі підсистеми Лілки - дисплей, кнопки, файлову систему, SD-карту, батарею, п'єзо-динамік і т.д.
+///
+/// Рекомендується викликати цю функцію один раз на початку програми в вашій функції ``setup()``.
 void begin();
 }