Entwicklerdoku (de / en) gesucht

[mcm1957]

Hi

Ich bin auf der Suche nach einer Entwickler-Doku (deutsch od englisch wär egal). Bisher hab ich zwar jede Menge Infos zu speziellen Problemen gefunden, aber z.B. keine wirkliche Beschreibugn der adapter funtkionern (und ein ko kretes Beispiel zu nennen).

Hier

https://github.com/ioBroker/ioBroker/wiki/Adapter-Development-Documentation#functions

sind zwar viele Funktionen gelistet - aber keine Beschreibung was die tun bzw welche Bedeutung die Parameter haben. Nun ja, die Namen sind meist selbsterklärend - aber ich bin nicht sicher ob es wirklich sinnvoll ist mit Try and Error zu starten

Ergo
Gibts wo eine Doku für die ioBroker Entwicklung - oder ist die normale Vorgangsweise andere Adapter zu lesen und zu experimentieren?

Bin für jeden Hinweis / Link dankbar.

McM

[paul53]

@mcm57 sagte: keine Beschreibung was die tun bzw welche Bedeutung die Parameter haben.

Schau in die Quelle adapter.js. Dort sind die meisten Funktionen vor ihrer Deklaration beschrieben.

[AlCalzone]

Oder erstelle einen Adapter mit https://github.com/ioBroker/create-adapter, nutze einen Editor mit Syntaxhilfe wie VSCode, dann bekommst du durch die Typdefinitionen inline Hilfe zu den Funktionen, z.B.:

Bei einigen Funktionen gibts da auch die Hilfe zu jedem Parameter:

--

Eine vernünftige Dokumentation für Entwickler ist derzeit im Aufbau, steht allerdings noch nicht allzu viel drin...

[mcm1957]

Danke euch,

Dann werd ich das mal so machen wie vorgeschlagen und nicht mehr Zeit mit einer Sucher vergeuden.

McM

[mcm1957]

Ich wollt nur kurz feedback geben.
Ja die Dokumentaion in adaper.js (u.a.) ist ausreichend gut.

Was mir aufgefallen ist, ist dass die Routinen Dokumentation eigentlich bereits struktutriert ist. Ich vermute mal, dass diese z.B. mittels des Tolls DOXYGEN in eine html Dokumentation umwandelbar sein sollte. (Ich vermute es deshalb, da ich beruflich die idente Dukumentaionsstruktur was Beschreibung, Paramater etc betrifft in .c Code verwende und wir dort aus dem Inhalt der.h Files mittels DOXYGEN eine html basierende Doku erstellen).

Hat das schon mal wer versucht und verworfen?

Ansonsten könnt ich es ja mal testen (alelrdings auf low prio - zuerst kümmer ich mich um den smtp adapter damit er mit offline Geräten besser zurecht kommt)

McM

Ps: Link zu doxygen: https://www.doxygen.nl/index.html

[AlCalzone]

@mcm57 Vermutlich wird es auf https://typedoc.org/ hinauslaufen, bis dahin müssen die bestehenden Typdefinitionen aus dem Paket @types/iobroker ausreichen.