Missing constants in the documentation

Just starting out? Need help? Post your questions and find answers here.
elwood
User
User
Posts: 30
Joined: Tue Dec 27, 2016 4:40 pm
Location: Lyon, France

Missing constants in the documentation

Post 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
AmigaOS betatester
French Amiga Translation Team
Team for the Planet member
Quin
Addict
Addict
Posts: 1126
Joined: Thu Mar 31, 2022 7:03 pm
Location: Colorado, United States
Contact:

Re: Missing constants in the documentation

Post by Quin »

A lot of these are Windows API constants. #MAX_PATH is documented by Microsoft here, for example.
Little John
Addict
Addict
Posts: 4777
Joined: Thu Jun 07, 2007 3:25 pm
Location: Berlin, Germany

Re: Missing constants in the documentation

Post 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.
User avatar
blueb
Addict
Addict
Posts: 1111
Joined: Sat Apr 26, 2003 2:15 pm
Location: Cuernavaca, Mexico

Re: Missing constants in the documentation

Post by blueb »

When a new version of PureBasic is released, I always use this:
https://www.purebasic.fr/english/viewto ... 09#p591909
- It was too lonely at the top.

System : PB 6.21(x64) and Win 11 Pro (x64)
Hardware: AMD Ryzen 9 5900X w/64 gigs Ram, AMD RX 6950 XT Graphics w/16gigs Mem
elwood
User
User
Posts: 30
Joined: Tue Dec 27, 2016 4:40 pm
Location: Lyon, France

Re: Missing constants in the documentation

Post 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.
AmigaOS betatester
French Amiga Translation Team
Team for the Planet member
Little John
Addict
Addict
Posts: 4777
Joined: Thu Jun 07, 2007 3:25 pm
Location: Berlin, Germany

Re: Missing constants in the documentation

Post 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?
BarryG
Addict
Addict
Posts: 4128
Joined: Thu Apr 18, 2019 8:17 am

Re: Missing constants in the documentation

Post 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."
Fred
Administrator
Administrator
Posts: 18162
Joined: Fri May 17, 2002 4:39 pm
Location: France
Contact:

Re: Missing constants in the documentation

Post by Fred »

It's much bigger nowaday :D
DarkDragon
Addict
Addict
Posts: 2344
Joined: Mon Jun 02, 2003 9:16 am
Location: Germany
Contact:

Re: Missing constants in the documentation

Post 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?
bye,
Daniel
Little John
Addict
Addict
Posts: 4777
Joined: Thu Jun 07, 2007 3:25 pm
Location: Berlin, Germany

Re: Missing constants in the documentation

Post 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
elwood
User
User
Posts: 30
Joined: Tue Dec 27, 2016 4:40 pm
Location: Lyon, France

Re: Missing constants in the documentation

Post by elwood »

Oh, I didn't think it was beyond the scope of the PB manual.
Ok then.

Thanks.
AmigaOS betatester
French Amiga Translation Team
Team for the Planet member
Post Reply