www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 2381] New: Minor mistakes in DDoc comments of std.path.

reply d-bugmail puremagic.com writes:
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
next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=2381





------- Comment #1 from andrei metalanguage.com  2008-09-30 21:07 -------
Fixed the doc but not the GENERATED_BY. I understand the latter would need a
change in the compiler, correct?


-- 
Sep 30 2008
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=2381





------- Comment #2 from aziz.kerim gmail.com  2008-10-01 05:28 -------
(In reply to comment #1)
 Fixed 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
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=2381





------- Comment #3 from aziz.kerim gmail.com  2008-10-01 16:47 -------
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
prev sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=2381





------- Comment #4 from bugzilla digitalmars.com  2008-10-02 03:59 -------
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