D issues are now tracked on GitHub. This Bugzilla instance remains as a read-only archive.
Issue 1726 - std.stream FileMode documentation problems
Summary: std.stream FileMode documentation problems
Status: RESOLVED FIXED
Alias: None
Product: D
Classification: Unclassified
Component: phobos (show other issues)
Version: D2
Hardware: All All
: P2 normal
Assignee: Andrej Mitrovic
URL:
Keywords: pull
Depends on:
Blocks:
 
Reported: 2007-12-11 15:51 UTC by Bill Baxter
Modified: 2014-04-28 11:18 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description Bill Baxter 2007-12-11 15:51:13 UTC
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.
Comment 1 Yao Gomez 2012-02-05 00:48:21 UTC
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.
Comment 3 github-bugzilla 2014-04-28 11:18:25 UTC
Commits pushed to master at https://github.com/D-Programming-Language/phobos

https://github.com/D-Programming-Language/phobos/commit/941e2e31f54625a195748f244fe2fe8d3883b77d
Fix Issue 1726 - Document FileMode in std.stream.

https://github.com/D-Programming-Language/phobos/commit/86c83142e4df0e4a557097290a2487972fbcb732
Merge pull request #2119 from AndrejMitrovic/Fix1726

Issue 1726 - Document FileMode in std.stream.