wo werden eigentlich Libraries dokumentiert?

[Neuanfang (Gast)]

Hallo Forum,

ich möchte mich in das Board NodeMCU mit dem ESP8266 unter der Arduino 
IDE einarbeiten. Um den Chip ESP8266 anzusprechen, benötigt man 
verschiedene Aufrufe aus gewissen Libs, ich gebe mal ein Beispiel:


#include <ESP8266WiFi.h>
#include <WiFiClient.h>
#include <ESP8266WebServer.h>


ESP8266WebServer server(80);


......

ich möchte jetzt wissen, was macht "ESP8266WebServer server(80);" und 
welche weiteren Funktionen/ Methoden mit welchen Parametern gibt es 
noch?

Dazu habe ich recherchiert und bin bei Github gelandet. Dort gibt es für 
jede lib mind. ein Unterverzeichnis

./examples
./src

./examples ist nicht sehr hilfreich, weil es konkrete 
Anwendungsbeispiele sind, wie der obige Codeausschnitt

./src ist auch nicht sehr informativ, weil überwiegend und seitenlang 
source code


Frage: Wo kann ich für eine beliebige Lib die Dokumentation finden, wie 
sie benutzt wird.

Eigentlich liegt es doch im Interesse des Erstellers, die Lib gut zu 
dokumentieren. Oder sollte der Sourcecode die Dokumentation sein?


besten Dank für Eure Hilfe
Neuanfang

[Johann L. (gjlayde)]

./doc

[Neuanfang (Gast)]

was ich also gelernt habe:
1) es sollte schon eine Dokumentation/ Reference geben und
2) wenn es nicht dokumentiert ist: schau Dir die examples an und 
versuche zu verstehen, wie sie es benutzen. Jede abweichende Benutzung 
oder nicht exemplarisch dargestellte Nutzung ist also auf eigenes 
Risiko.

hoffe mal bei automotive und Kernkraft werden andere Maßstäbe 
angelegt:-/

Neuanfang

[PittyJ (Gast)]

Nach 2 Minuten Google hatt ich eine Seite mit Beispielcode gefunden.
Also einfach mal Google bemühen.

Die meisten der Libraries werden von engagierten Hobbyisten geschrieben. 
Und dort kommt die Dokumentation erst am Ende, Programmieren macht mehr 
Spass. Dokumentieren ist langweilig und man hat es auch nicht so 
gelernt.

Wenn also jemand in seiner Freizeit Code für die Allgemeinheit erstellt, 
dann sollte man nicht industrielle Maßstäbe daran setzen. Sondern sich 
freuen, dass man überhaupt etwas kostenlos bekommt.

Es steht jedem Andwender frei, wenn er die Bibliothek benutzt und 
versteht, dann auch mit an der Dokumentation zu arbeiten. Wenn es also 
zu wenig Doku ist, dann ergänze doch einfach das fehlende.

[Bastian N. (Firma: Privat) (seal)]

Manchmal gibt es Dokus/API Beschreibungen, manchmal nur Examples - wenns 
gut läuft beides:

Doku:
https://links2004.github.io/Arduino/d3/d58/class_e_s_p8266_web_server.html

Examples:
https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer/examples


Persönlich finde ich mich in den Examples schneller zurecht. Dann noch 
vllt. die Headerdatei anschauen - das ist i.d.R. schon alles was man so 
braucht.

Nur Dokumentation, also gerade einfach was mit z.B mit Doxygen generiert 
wurde - ist ziemlich mühsam, da durchzusteigen. Welche Funktion brauch 
ich jetzt? Wie baue ich das am Besten/Einfachsten auf? Das wird dort 
nicht gezeigt.

MfG
Bastian


PS. Ich finde die NodeMCU mit LUA zum Spielen viel besser. Nur so als 
Randbemerkung.

[Michael B. (laberkopp)]

Neuanfang schrieb:
> Frage: Wo kann ich für eine beliebige Lib die Dokumentation finden, wie
> sie benutzt wird.

Arduino & all der moderne open source Kram ? Nirgends.

> Eigentlich liegt es doch im Interesse des Erstellers, die Lib gut zu
> dokumentieren.

Die werden dafür nicht bezahlt und machen nur das auf das sie Lust 
haben, die Doku gehört i.A. nicht dazu. Fire & forget.

[Jörg W. (dl8dtl) (Moderator)]

Michael B. schrieb:
> all der moderne open source Kram ? Nirgends.

Selbstverständlich gibt es hinreichend viele gut dokumentierte
Opensource-Projekte, durchaus auch solche, die von Leuten in ihrer
Freizeit geschaffen werden.

Dass das vom TE gesuchte Projekt wohl nicht zu dieser Kategorie gehört,
gibt selbst einem „laberkopp“ noch lange nicht das Recht zu unsinnigen
Verallgemeinerungen.

[G. H. (schufti)]

also gerade wifi ist hier
https://github.com/esp8266/Arduino/tree/master/doc/esp8266wifi
recht gut dokumentiert, da dies wohl am meisten vom "Arduino Standard" 
abweicht.

Ansonsten:
für standard Arduino Libs -> 
https://www.arduino.cc/en/Reference/Libraries

hinreichend dokumentiert sind meist auch die libs von adafruit.

für alles andere gilt das bereits von den Vorpostern gesagte: "Learning 
by doing" und Eigeninitiative sind das Mindeste was man investieren 
muss.

Alternativ halt ein System suchen wo dieser Aufwand für bare Münze von 
anderen erledigt wird...