digitalmars.D.bugs - [Issue 2381] New: Minor mistakes in DDoc comments of std.path.
- d-bugmail puremagic.com (25/25) Sep 30 2008 http://d.puremagic.com/issues/show_bug.cgi?id=2381
- d-bugmail puremagic.com (5/5) Sep 30 2008 http://d.puremagic.com/issues/show_bug.cgi?id=2381
- d-bugmail puremagic.com (16/19) Oct 01 2008 http://d.puremagic.com/issues/show_bug.cgi?id=2381
- d-bugmail puremagic.com (10/10) Oct 01 2008 http://d.puremagic.com/issues/show_bug.cgi?id=2381
- d-bugmail puremagic.com (5/5) Oct 02 2008 http://d.puremagic.com/issues/show_bug.cgi?id=2381
- d-bugmail puremagic.com (25/25) Feb 05 2012 http://d.puremagic.com/issues/show_bug.cgi?id=2381
- d-bugmail puremagic.com (14/14) Feb 18 2012 http://d.puremagic.com/issues/show_bug.cgi?id=2381
http://d.puremagic.com/issues/show_bug.cgi?id=2381 Summary: Minor mistakes in DDoc comments of std.path. Product: D Version: 1.035 Platform: PC OS/Version: Linux Status: NEW Keywords: ddoc Severity: enhancement Priority: P2 Component: Phobos AssignedTo: bugzilla digitalmars.com ReportedBy: aziz.kerim gmail.com Please correct the following errors. It helps documentation generation and the syntax-highlighter in Kwrite/Kate. phobos/std/path.d line 343 and 344 (pseudo diff format :) - * getDirName(r"d:\path\foo.bat") => "d:\path" - * getDirName(getDirName(r"d:\path\foo.bat")) => "d:\" + * getDirName(r"d:\path\foo.bat") => r"d:\path" + * getDirName(getDirName(r"d:\path\foo.bat")) => r"d:\" While you're at it, could you also create a GENERATED_BY macro for the "Page generated by XYZ" message. That way other ddoc generation tools can override this macro to customize this message without having to modify std.ddoc for example. Thanks. --
Sep 30 2008
http://d.puremagic.com/issues/show_bug.cgi?id=2381 Fixed the doc but not the GENERATED_BY. I understand the latter would need a change in the compiler, correct? --
Sep 30 2008
http://d.puremagic.com/issues/show_bug.cgi?id=2381Fixed the doc but not the GENERATED_BY. I understand the latter would need a change in the compiler, correct?The change would have to be made in src/dmd/doc.c at line 118: - <hr>$(SMALL Page generated by $(LINK2 http://www.digitalmars.com/d/1.0/ddoc.html, Ddoc). $(COPYRIGHT))\n\ + <hr>$(SMALL $(GENERATED_BY) $(COPYRIGHT))\n\ +GENERATED_BY = Page generated by $(LINK2 http://www.digitalmars.com/d/1.0/ddoc.html, Ddoc). Please, also make this change in src/phobos/std.ddoc at line 65: -Page generated by $(LINK2 http://www.digitalmars.com/d/1.0/ddoc.html, Ddoc). +$(GENERATED_BY) At line 70 add: +GENERATED_BY = Page generated by $(LINK2 http://www.digitalmars.com/d/1.0/ddoc.html, Ddoc). --
Oct 01 2008
http://d.puremagic.com/issues/show_bug.cgi?id=2381 Two other strings that should have an r-prefix in phobos/std/path.d: line 195 - * getName(r"d:\path\foo.bat") => "d:\path\foo" + * getName(r"d:\path\foo.bat") => r"d:\path\foo" line 201 - * getName(r"d:\path.two\bar") => "d:\path" + * getName(r"d:\path.two\bar") => r"d:\path" --
Oct 01 2008
http://d.puremagic.com/issues/show_bug.cgi?id=2381 I don't see a real need to change this in the compiler source, but it's fine to change it in std.ddoc. --
Oct 02 2008
http://d.puremagic.com/issues/show_bug.cgi?id=2381 Yao Gomez <yao.gomez gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |yao.gomez gmail.com Version|1.035 |D1 Summary|Minor mistakes in DDoc |(D1 only) Minor mistakes in |comments of std.path. |DDoc comments of std.path. == D2 std.path == getDirName doesn't appear anymore in the documentation. In the code is just an alias to dirname. Moreover, std.path.dirname[1], and std.path.getName[2] will be marked as deprecated this very same month (february 2012), so I think that it's safe to close this bug report now, or when the deprecation actually takes place, because there's no point in updating the docs. [1] http://dlang.org/phobos/std_path.html#dirname [2] http://dlang.org/phobos/std_path.html#getName == D1 std.path == pull: https://github.com/D-Programming-Language/phobos/pull/419 This fixes only the documentation issues. The GENERATED_BY macro is an issue apart (or not an issue at all). -- Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email ------- You are receiving this mail because: -------
Feb 05 2012
http://d.puremagic.com/issues/show_bug.cgi?id=2381 Yao Gomez <yao.gomez gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |pull Status|NEW |RESOLVED Resolution| |FIXED Pull merged: https://github.com/D-Programming-Language/phobos/commit/94a399d6933267ced15db1ee88dbee9ba8f6e35d Closin' this. -- Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email ------- You are receiving this mail because: -------
Feb 18 2012