www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.learn - How to find the content of core.sys.* ?

reply chmike <christophe meessen.net> writes:
Hello,

The nice and handy documentation of dlang doesn't provide any 
info on the core.sys. How can I find out all the things that are 
in there ?
May 16 2016
parent reply rikki cattermole <rikki cattermole.co.nz> writes:
On 17/05/2016 6:55 PM, chmike wrote:
 Hello,

 The nice and handy documentation of dlang doesn't provide any info on
 the core.sys. How can I find out all the things that are in there ?
https://github.com/dlang/druntime/tree/master/src/core/sys
May 16 2016
parent reply Ryan Frame <dlang ryanjframe.com> writes:
On Tuesday, 17 May 2016 at 06:56:36 UTC, rikki cattermole wrote:
 On 17/05/2016 6:55 PM, chmike wrote:
 Hello,

 The nice and handy documentation of dlang doesn't provide any 
 info on
 the core.sys. How can I find out all the things that are in 
 there ?
https://github.com/dlang/druntime/tree/master/src/core/sys
So is there a reason it's not being documented? I've got a deprecation message saying to switch from std.c.linux.linux to core.sys.posix.* Generally I'd assume undocumented features mean "don't use this", or at least "use at your own risk" (I believe that's why deprecated features are removed from the docs before they're pulled from the code). It looks like doc comments are pretty sparse in core/sys - is that the only reason docs aren't being generated?
Oct 28 2017
parent reply user1234 <user1234 12.nl> writes:
On Saturday, 28 October 2017 at 11:41:16 UTC, Ryan Frame wrote:
 On Tuesday, 17 May 2016 at 06:56:36 UTC, rikki cattermole wrote:
 On 17/05/2016 6:55 PM, chmike wrote:
 Hello,

 The nice and handy documentation of dlang doesn't provide any 
 info on
 the core.sys. How can I find out all the things that are in 
 there ?
https://github.com/dlang/druntime/tree/master/src/core/sys
So is there a reason it's not being documented? I've got a deprecation message saying to switch from std.c.linux.linux to core.sys.posix.* Generally I'd assume undocumented features mean "don't use this", or at least "use at your own risk" (I believe that's why deprecated features are removed from the docs before they're pulled from the code). It looks like doc comments are pretty sparse in core/sys - is that the only reason docs aren't being generated?
It's not documented because everything is already well documented either at microsoft, posix reference, c reference etc. It would be copy and paste monkey work to do that.
Oct 28 2017
parent Jacob Carlborg <doob me.com> writes:
On 2017-10-28 13:48, user1234 wrote:

 It's not documented because everything is already well documented either 
 at microsoft, posix reference, c reference etc. It would be copy and 
 paste monkey work to do that.
I would be nice to have empty Ddoc comments so the symbols show up in the generated documentation. That way you'll know which symbols are available without having to read the source code. -- /Jacob Carlborg
Oct 28 2017