http://d.puremagic.com/issues/show_bug.cgi?id=5872

           Summary: core.demangle, core.sys.*, core.stdc.* not documented
           Product: D
           Version: D2
          Platform: All
               URL: http://www.digitalmars.com/d/2.0/phobos/phobos.html
        OS/Version: All
            Status: NEW
          Severity: minor
          Priority: P4
         Component: websites
        AssignedTo: nobody@puremagic.com
        ReportedBy: kennytm@gmail.com


--- Comment #0 from kennytm@gmail.com 2011-04-23 05:30:56 PDT ---
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.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------

http://d.puremagic.com/issues/show_bug.cgi?id=5872


Sean Kelly <sean@invisibleduck.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |ASSIGNED
                 CC|                            |sean@invisibleduck.org


--- Comment #1 from Sean Kelly <sean@invisibleduck.org> 2011-05-06 10:56:50 PDT ---
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.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------

http://d.puremagic.com/issues/show_bug.cgi?id=5872



--- Comment #2 from kennytm@gmail.com 2011-05-06 11:21:47 PDT ---
(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).

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------

http://d.puremagic.com/issues/show_bug.cgi?id=5872


Jacob Carlborg <doob@me.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |doob@me.com


--- Comment #3 from Jacob Carlborg <doob@me.com> 2011-05-06 11:47:13 PDT ---
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.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------

http://d.puremagic.com/issues/show_bug.cgi?id=5872



--- Comment #4 from Sean Kelly <sean@invisibleduck.org> 2011-05-09 15:25:28 PDT ---
The module headers already say which spec they follow.  What if I added a hyperlink to the official docs (when available) as well?

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------

http://d.puremagic.com/issues/show_bug.cgi?id=5872



--- Comment #5 from Jacob Carlborg <doob@me.com> 2011-05-10 00:21:46 PDT ---
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.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------