Bug 5872 – core.sys.*, core.stdc.* modules are not documented

Status
REOPENED
Severity
minor
Priority
P4
Component
dlang.org
Product
D
Version
D2
Platform
All
OS
All
Creation time
2011-04-23T05:30:56Z
Last change time
2024-12-15T15:21:48Z
Assigned to
No Owner
Creator
kennytm
Moved to GitHub: dlang.org#4015 →

Comments

Comment #0 by kennytm — 2011-04-23T05:30:56Z
As titled, the module core.demangle and the subpackages core.sys.* and core.stdc.* are not found in the link in http://www.digitalmars.com/d/2.0/phobos/phobos.html. They should be documented.
Comment #1 by sean — 2011-05-06T10:56:50Z
I'll take care of core.demangle. core.sys.* and core.stdc.* are interfaces for C libraries and I'd expect the user to refer to the documentation for those libraries directly. Documenting that stuff would be a tremendous amount of work and risks copyright violation if I simply paste it in from the reference docs.
Comment #2 by kennytm — 2011-05-06T11:21:47Z
(In reply to comment #1) > I'll take care of core.demangle. core.sys.* and core.stdc.* are interfaces for > C libraries and I'd expect the user to refer to the documentation for those > libraries directly. Documenting that stuff would be a tremendous amount of > work and risks copyright violation if I simply paste it in from the reference > docs. Well, at least mention what modules are inside these subpackages (e.g. it is core.sys.posix.setjmp, not core.stdc.setjmp).
Comment #3 by doob — 2011-05-06T11:47:13Z
How about add an empty doc comment at every declaration making the declarations visible in the documentation. And also add a note that the user should look up the original documentation, perhaps even with a link.
Comment #4 by sean — 2011-05-09T15:25:28Z
The module headers already say which spec they follow. What if I added a hyperlink to the official docs (when available) as well?
Comment #5 by doob — 2011-05-10T00:21:46Z
I think (In reply to comment #4) > The module headers already say which spec they follow. What if I added a > hyperlink to the official docs (when available) as well? To me, ISO/IEC 9899:1999 (E), for example, doesn't say much, so yes, a link would be better. But I think the most important thing is that the modules show up in the documentation here: http://www.digitalmars.com/d/2.0/phobos/phobos.html so one know that they exist at all. It would also help if every declaration also show up in the documentation, even though it's only the declaration and no actual documentation.
Comment #6 by andrej.mitrovich — 2014-04-23T13:19:20Z
Changed title as core.demangle is documented now.
Comment #7 by briancschott — 2014-06-06T19:12:11Z
It seems that these are now included in the new documentation format: http://dlang.org/library/index.html
Comment #8 by bugzilla — 2019-12-11T14:52:38Z
core.stdc.* is meanwhile added, but core.sys.* is still missing
Comment #9 by bugzilla — 2019-12-18T16:28:10Z
*** This issue has been marked as a duplicate of issue 14263 ***
Comment #10 by nick — 2023-01-29T11:24:57Z
core.stdc: 3eef2c0303c4d2c7fe9cb1f7aef42d22c0584aa8 core.sys - still missing, reopening.
Comment #11 by nick — 2023-01-29T11:25:07Z
*** Issue 14263 has been marked as a duplicate of this issue. ***
Comment #12 by robert.schadek — 2024-12-15T15:21:48Z
THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dlang.org/issues/4015 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB