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

           Summary: std.stream FileMode documentation problems
           Product: D
           Version: 1.024
          Platform: PC
        OS/Version: Windows
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Phobos
        AssignedTo: bugzilla@digitalmars.com
        ReportedBy: wbaxter@gmail.com


Issue 1 is that the FileMode default arguments in the D1 version of the documentation are screwed up.  Instead of seeing symbolic constants you see things like "Filemode mode=cast(FileMode)1".  It's ok in the D2 version of the doc, so maybe the D1 documentation just needs to be re-generated.

Second, the FileMode enum really needs a doc comment added.  It doesn't have one currently (in either D1 or D2) so the only way to figure out what the possible values are is from the documentation from the constructor of one particular class way down near the end of the doc page.


-- 

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


Yao Gomez <yao.gomez@gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |yao.gomez@gmail.com
            Version|1.024                       |D1 & D2


--- Comment #1 from Yao Gomez <yao.gomez@gmail.com> 2012-02-05 00:48:21 PST ---
I just added a pull request (https://github.com/D-Programming-Language/phobos/pull/417) to the Phobos repo to address the second issue. However, bear in mind that D2 std.streams will be revamped or rewritten, so I don't know if the pull will be accepted (besides my english is not good).

And, with respect to the first one is a bug in the doc generator, when documenting parameters that are enums with default int arguments. I don't have the issue number at the moment but I will look for it and mark this as a duplicated or just add the link.

Marking as both D1 and D2 because the doc gen bug is present in both versions.

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