Issue 5872 - core.sys.*, core.stdc.* modules are not documented
Summary: core.sys.*, core.stdc.* modules are not documented
Status: REOPENED
Alias: None
Product: D
Classification: Unclassified
Component: dlang.org (show other issues)
Version: D2
Hardware: All All
: P4 minor
Assignee: No Owner
URL: http://www.digitalmars.com/d/2.0/phob...
Keywords:
: 14263 (view as issue list)
Depends on:
Blocks:
 
Reported: 2011-04-23 05:30 UTC by kennytm
Modified: 2024-02-17 22:31 UTC (History)
8 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description kennytm 2011-04-23 05:30:56 UTC
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 Sean Kelly 2011-05-06 10:56:50 UTC
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 kennytm 2011-05-06 11:21:47 UTC
(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 Jacob Carlborg 2011-05-06 11:47:13 UTC
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 Sean Kelly 2011-05-09 15:25:28 UTC
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 Jacob Carlborg 2011-05-10 00:21:46 UTC
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 Andrej Mitrovic 2014-04-23 13:19:20 UTC
Changed title as core.demangle is documented now.
Comment 7 briancschott 2014-06-06 19:12:11 UTC
It seems that these are now included in the new documentation format:

http://dlang.org/library/index.html
Comment 8 berni44 2019-12-11 14:52:38 UTC
core.stdc.* is meanwhile added, but core.sys.* is still missing
Comment 9 berni44 2019-12-18 16:28:10 UTC

*** This issue has been marked as a duplicate of issue 14263 ***
Comment 10 Nick Treleaven 2023-01-29 11:24:57 UTC
core.stdc: 3eef2c0303c4d2c7fe9cb1f7aef42d22c0584aa8
core.sys - still missing, reopening.
Comment 11 Nick Treleaven 2023-01-29 11:25:07 UTC
*** Issue 14263 has been marked as a duplicate of this issue. ***