PureBasic Docs - Errors & needed improvements to the man

[Arctic Fox]

Descriptions of InitializeStructure() and CopyStructure() miss in the help for PB 4.50. Using the shortcut for help leads to Compiler Functions, but they are not here.

Edit
Same problem as rudz had with CopyList() and FreeList() although they can be found manually.

Also, I think the link to the Palette library should be removed as this library (and its functions) does not exist anymore - at least the example Palette.pb does not function.

[#NULL]

pb450b1 - english help file - some "Useful Internet Links" are not useful anymore

"The PureBasic Visual Designer Website (maintained by Berikco)" : my comodo seems to block that site for some reason (saying something about parked site or to much advertisement or whatever)
"PBDev - PureBasic Developer" (dead link)
"Robsite - PureBasic Tutorials" (dead link. "http://robsite.net/" works though, but seems not too much PB-related anymore (it was a great site once))
"AllAPI.net - Another source for using API-functions" (domain seems to be grabbed)

"Lethal Judgement + Lethal Judgement 2" (...)
"Andreas' PureBasic Site (german)" (grabbed domain that makes my security suite popping up quite a lot)

[#NULL]

typo in a link tag: Using the Debugger - Data Breakpoints:

Most functions of the @libryrylink"Math" "Math", Memory and String libraries are also available.

[atomo]

PureBasic v.4.50b1 - English help file
Structures exemples :
- Typo error on "AddAlement()"

[Seymour Clufley]

Statusbar hint for CopyStructure is the one for ClearStructure.

And I've always wondered... why is ClearStructure in the Compiler Functions section of the help? Shouldn't it be in the Structure section?

[Demivec]

The PB v4.50 beta documentation for CosH() includes this statement:

The inverse function of Cos() is ACosH().

It should read:

The inverse function of CosH() is ACosH().

A similar typo is present in the documentation for SinH().

[Arctic Fox]

Though InitializeStructure() is now found in the manual for Beta 2, CopyStructure() still misses. However, ClearStructure() is mentioned two times.

[walker]

The Movie commands needed to be updated to reflect the recent changes:

MovieInfo()

Supported values for now:
0: return the number of frames per second.


MovieSeek()

Result = MovieSeek(#Movie, Position)
Description
Change the #Movie position to the given Position.

MovieStatus()

Get the status of the #Movie.
'Result' can be one of the following values:

-1: Movie is paused.
0: Movie is stopped
> 0: Movie is playing. The returned value is the current position of the Movie in in a 10th of a million second.

[Melissa]

http://www.purebasic.com/documentation/ ... coder.html
Additional 7 bytes for trailing '=' characters and string terminator (#Null) should be mentioned.

http://www.purebasic.com/documentation/ ... coder.html

It's recommended to get a slightly larger buffer, like 30% smaller to avoid overflows.

Fail, it should be 25% smaller.


...Also it would be great to note that Base64 only works with ASCII strings.

[Melissa]

http://www.purebasic.com/documentation/ ... pokes.html
I should be mentioned that 'Text$' is passed by reference, so 'flattering' string into it's own buffer isn’t really best idea here:

Code: Select all

PokeS(@Text, Text, -1, #PB_Ascii) ; Fail

...however, it could be used that way:

Code: Select all

PokeS(@Text, Text+"", -1, #PB_Ascii) ; Win

[Seymour Clufley]

Fail, it should be 25% smaller.

Surely 25% larger?

[Melissa]

Surely 25% larger?

No, read harder.

[Thomas]

In the german docs the description for StartDrawing() claims that the default background color is black and the default foreground color is white. In fact, the default background color is grey.

Code: Select all

OpenWindow(0,0,0,320,200,"Test",#PB_Window_ScreenCentered|#PB_Window_SystemMenu)
StartDrawing(WindowOutput(0))
Circle(160,100,70)
StopDrawing()
Repeat
Until WaitWindowEvent()=#PB_Event_CloseWindow

For OpenWindow() the default flag is #PB_Window_SystemMenu. What if you want to open a window without the close button?

[Kaeru Gaman]

It's recommended to get a slightly larger buffer, like 30% smaller to avoid overflows.

Fail, it should be 25% smaller.

Surely 25% larger?

No, read harder.

think!

... how can you avoid an overflow by using a smaller buffer?
... if only a smaller buffer was needed, how can using a bigger buffer produce an overflow?

surely, it should read "like 30% larger"

[Arctic Fox]

You are discussing the last one of two sentences.

The output buffer can be up to 33% smaller than the input buffer, with a minimum size of 64 bytes. It's recommended to get a slightly larger buffer, like 30% smaller to avoid overflows.