Page 1 of 1

Missing constants in the documentation

Posted: Fri Aug 30, 2024 10:42 pm
by elwood
By a search in Google, I learnt about these 2 constants : #CRLF$ and #MAX_PATH.
They could be added to the "PureBasic Constants" page.

Now I wonder which other constants I missed :P

Re: Missing constants in the documentation

Posted: Fri Aug 30, 2024 11:18 pm
by Quin
A lot of these are Windows API constants. #MAX_PATH is documented by Microsoft here, for example.

Re: Missing constants in the documentation

Posted: Sat Aug 31, 2024 12:56 am
by Little John
All built-in constants are listed in the IDE's Structure Viewer on the „Constants“ tab.
I don't think it's necessary to repeat them in the help.

Re: Missing constants in the documentation

Posted: Sat Aug 31, 2024 2:00 pm
by blueb
When a new version of PureBasic is released, I always use this:
https://www.purebasic.fr/english/viewto ... 09#p591909

Re: Missing constants in the documentation

Posted: Sun Sep 01, 2024 10:26 pm
by elwood
Quin wrote: Fri Aug 30, 2024 11:18 pm A lot of these are Windows API constants. #MAX_PATH is documented by Microsoft here, for example.
Little John wrote: Sat Aug 31, 2024 12:56 am All built-in constants are listed in the IDE's Structure Viewer on the „Constants“ tab.
I don't think it's necessary to repeat them in the help.
Hum, how complete a documentation is if it's not exhaustive...
And blueb has also a starting point to push these constants to the manual so the first step is already done.

Re: Missing constants in the documentation

Posted: Mon Sep 02, 2024 12:31 am
by Little John
elwood wrote:
Little John wrote: Sat Aug 31, 2024 12:56 am All built-in constants are listed in the IDE's Structure Viewer on the „Constants“ tab.
I don't think it's necessary to repeat them in the help.
Hum, how complete a documentation is if it's not exhaustive...
The Structure Viewer and its content can be considered part of PureBasic's documentation. Documentation does
not necessarily only consist of HTML or CHM files. So the built-in constants are documented.
Previously, elwood wrote: By a search in Google, I learnt about these 2 constants : #CRLF$ and #MAX_PATH.
They could be added to the "PureBasic Constants" page.

Now I wonder which other constants I missed :P
I told you where to find the wanted information. What is the problem?

Re: Missing constants in the documentation

Posted: Mon Sep 02, 2024 9:50 am
by BarryG
elwood wrote: Sun Sep 01, 2024 10:26 pmHum, how complete a documentation is if it's not exhaustive...
From https://www.purebasic.com/faq.php

"Why the Windows API description isn't included in the PureBasic documentation ? Even if PureBasic supports natively nearly all of the Windows API functions, it's impossible to include all their descriptions as it's more than 1 GB of data. You can get all the needed information on the Microsoft site."

Re: Missing constants in the documentation

Posted: Mon Sep 02, 2024 10:16 am
by Fred
It's much bigger nowaday :D

Re: Missing constants in the documentation

Posted: Mon Sep 02, 2024 10:21 am
by DarkDragon
elwood wrote: Sun Sep 01, 2024 10:26 pm
Quin wrote: Fri Aug 30, 2024 11:18 pm A lot of these are Windows API constants. #MAX_PATH is documented by Microsoft here, for example.
Little John wrote: Sat Aug 31, 2024 12:56 am All built-in constants are listed in the IDE's Structure Viewer on the „Constants“ tab.
I don't think it's necessary to repeat them in the help.
Hum, how complete a documentation is if it's not exhaustive...
And blueb has also a starting point to push these constants to the manual so the first step is already done.
Do you expect your vacuum cleaner to include a documentation for your TV as well?

Re: Missing constants in the documentation

Posted: Mon Sep 02, 2024 10:39 am
by Little John
DarkDragon wrote: Mon Sep 02, 2024 10:21 am Do you expect your vacuum cleaner to include a documentation for your TV as well?
:D

Re: Missing constants in the documentation

Posted: Mon Sep 02, 2024 12:58 pm
by elwood
Oh, I didn't think it was beyond the scope of the PB manual.
Ok then.

Thanks.