PB4B Bugs in deutscher Hilfe

[Sven]

Hallo Andre! Wo möchtest Du den eventuelle Fehler in der deutschen Hilfe hinhaben? Ich würde vorschlagen, kleine Sachen hier zu posten, dann sehen andere gleich, dass es bekannt ist und Dein Postfach wird geschont.

Ich fang gleich mal an:

Falsche Formatierung bei MenuItem()

"&Datei" ergibt in Wirklichkeit: <u>D</u>atei

Falscher Befehl bei SetMenuItemTitle()

in der Hilfe: SetMenuItemTitle(#Menue, Titel, Text$)
funktioniert (mit 4B7 / 4B8): SetMenuTitleText(#Menue, Titel, Text$)

Ist in der englischen Hilfe auch falsch, glaube ich.

Vielleicht magst Du den Thread anheften?

Sven

[Toshy]

Syntax

Client = GetClientIP(Client)

sollte wohl eher lauten:
IP.l = GetClientIP(Client)

Syntax

Client = GetClientPort(Client)

sollte wohl eher lauten:
Syntax

Port.l = GetClientPort(Client)

CreateNetworkServer(#Server, Port [, Modus])

läuft auch mit #pb_any, das wird im Text aber noch nicht angegeben.

Ach ja, vielleicht wäre es möglich nach und nach in der Hilfe bei den Rückgabewerten mit anzugeben was für ein Variablentyp zurückgegeben wird. Von mir auch in der Art von "alle Rückgabewerte sind LONGs, abweichendes ist angegeben". Da würde einem einiges etwas einfacher machen und man könnte seinen Code besser optimieren.
Gruß
Toshy

[Sven]

OpenHelp(Dateiname$, Thema$)

jaPBe zeigt für OpenHelp() zusätzlich Flags an, die aber nicht dokumentiert sind. => OpenHelp (Filename$, Topic$ [, Flags]) - Opens a new Help window.

Stimmt das, muss das in der Hilfe (auch in der englischen) ergänzt werden?

MDIGadget()

Bei MDIGadget() - SetGadgetState() sollte stehen, dass hier die WindowID übergeben werden muss, im Gegensatz zur Item-Nummer bei den anderen Gadgets.

Kann man zwar erraten, weil das bei AddgadgetItem() auch so ist, aber vielleicht ist ein Hinweis möglich (auch englische Hilfe).

MDIGadget()

GetGadgetAttribute(): Mit den folgenden Attributen: #PB_MDI_Image... soll bestimmt SetGadgetAttribute() sein (auch in der englischen Hilfe)

WaitWindowEvent

Es wäre schön, wenn hier die "Möglichen Ereignisse" mit aufgeführt werden, wie bei WindowEvent().

Es fehlt eine Angabe, welche Rückgabe bei einem "Timeout" zu erwarten ist (klar: Null, aber ist das für den Anfänger wirklich klar), und vielleicht kann das Beispiel dazu ergänzt werden. Am konsequentesten wäre eine Konstante #PB_Event_TimeOut.

Code: Alles auswählen

StartTime = ElapsedMilliseconds()

Repeat
  Event = WaitWindowEvent()
     
  Select Event
    Case #PB_Event_TimeOut
      Debug "TimeOut " + Str(ElapsedMilliseconds() - StartTime)
    Case #PB_Event_Gadget
      ...

Sven

[spacewalker]

Nabend!
Ein kleiner Fehler in der Hilfe zu dem ProgressBarGadget()

Code: Alles auswählen

- SetGadgetAttribute(): mit den folgenden Attributen: 
  #PB_ProgressBar_Minimum   : gibt den Minimum-Wert zurück.
  #PB_ProgressBar_Maximum   : gibt den Maximum-Wert zurück.

- GetGadgetAttribute(): mit den folgenden Attributen: 
  #PB_ProgressBar_Minimum   : ändert den Minimum-Wert.
  #PB_ProgressBar_Maximum   : ändert den Maximum-Wert.

[Andre]

Von mir auch in der Art von "alle Rückgabewerte sind LONGs, abweichendes ist angegeben"

Bei "Allgemeine Syntax Regeln" hinzugefügt.

in der Hilfe: SetMenuItemTitle(#Menue, Titel, Text$)
funktioniert (mit 4B7 / 4B8): SetMenuTitleText(#Menue, Titel, Text$)

Fixed.

Falsche Formatierung bei MenuItem()

"&Datei" ergibt in Wirklichkeit: <u>D</u>atei

Fixed.

Zitat:
Syntax

Client = GetClientIP(Client)

sollte wohl eher lauten:
IP.l = GetClientIP(Client)
Zitat:
Syntax

Client = GetClientPort(Client)

sollte wohl eher lauten:
Syntax

Port.l = GetClientPort(Client)
Zitat:

CreateNetworkServer(#Server, Port [, Modus])


läuft auch mit #pb_any, das wird im Text aber noch nicht angegeben.

Erledigt.

OpenHelp (Filename$, Topic$ [, Flags])

Auf die ToDo-Liste gesetzt - zu dem Flags-Parameter muss erst Fred etwas sagen.

MDIGadget()

Bei MDIGadget() - SetGadgetState() sollte stehen, dass hier die WindowID übergeben werden muss, im Gegensatz zur Item-Nummer bei den anderen Gadgets.

Kann man zwar erraten, weil das bei AddgadgetItem() auch so ist, aber vielleicht ist ein Hinweis möglich (auch englische Hilfe).

MDIGadget()

GetGadgetAttribute(): Mit den folgenden Attributen: #PB_MDI_Image... soll bestimmt SetGadgetAttribute() sein (auch in der englischen Hilfe)

Hinzugefügt bzw. korrigiert.

Ein kleiner Fehler in der Hilfe zu dem ProgressBarGadget()

Fixed.

Zu den Anregungen hinsichtlich WaitWindowEvent():
- wegen der weiteren Dokumentation (also auch für Ereignisse) wird ja ausdrücklich auf WindowEvent() verlinkt, um die Doku übersichtlich und kurz zu halten
- TimeOut Konstante habe ich Fred + fr34k vorgeschlagen


Neue Vorschläge bitte in diesem Thread posten:Verbesserungen an der Dokumentation für PureBasic v4

[Toshy]

Schön. Dann warten wir mal auf die Beta11.

Was mir aufgefallen ist auf Grund eines anderen Topic von mir:

ConnectionID()

Syntax

Ergebnis = ConnectionID(Verbindung)

Beschreibung

Gibt den eindeutigen System-Identifier (Bezeichner) der 'Verbindung' zurck.

Diese Ergebnis ist manchmal auch als 'Handle' bekannt. Schauen Sie in das Extra-Kapitel Handles und Nummern fr weitere Informationen.

sollte das Ergebnis der "Socket" sein? Wenn ja, sollte man statt "ergebnis=..." doch "Socket=.." schreiben.