Odpaliłem doxygena dla supla-device i wynik można przeglądać na https://supla.github.io/supla-device/
Dokumentacja doxygen robi się "sama" na podsatwie źródeł i generuje przy każdym pushu do brancha main na supla-device.
Obecnie jest tam prawie pusto, ale są różne dependencje i grafiki pokazujące jak są klasy zbudowane, co po czym dziedziczy itp.
Jeśli ktoś ma trochę wolnego czasu i chciałby dorzucić swoje 2 grosze, to zapraszam to współtworzenia dokumentacji.
Wymagania są takie:
1. Piszemy po angielsku
2. Trzeba znać trochę doxygena https://www.doxygen.nl/
3. Trzeba znać trochę supla-device lub jej fragment
Jeśli ktoś chce to u siebie lokalnie przetestować, to wyrczy:
1. Pobrać repo supla-device z https://github.com/SUPLA/supla-device
2. Zainstalować doxygena (wg dowolnej instrukcji z sieci ;P )
3. Z poziomu głównego katalogu supla-device odpalić:
Code: Select all
doxygen
Zachęcam do współtworzenia - nawet małych rzeczy. Wystarczy, że zrobicie sobie clone repozytorium, dodacie zmiany, sprawdzicie lokalnie czy wygląda ok i wrzucicie pull request do głównego repozytorium. Ja to przejrzę, skomentuję, poproszę o poprawki, zaakceptuję i zmerguję :)
Wrzucam dwie grafiki wygenerowane przez doxygena