www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 9370] New: DDoc: switch to one html file per entity (function, type etc)

reply d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9370

           Summary: DDoc: switch to one html file per entity (function,
                    type etc)
           Product: D
           Version: D2
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: enhancement
          Priority: P2
         Component: DMD
        AssignedTo: nobody puremagic.com
        ReportedBy: andrei erdani.com


--- Comment #0 from Andrei Alexandrescu <andrei erdani.com> 2013-01-22 11:44:52
PST ---
Currently we use one HTML file per module. It's worth considering switching to
a format fostering one file per entity (function, struct, class).

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Jan 22 2013
next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9370


Adam D. Ruppe <destructionator gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |destructionator gmail.com


--- Comment #1 from Adam D. Ruppe <destructionator gmail.com> 2013-01-22
11:50:47 PST ---
While it might be a decent option, I like the one file per module approach, one
reason being you can search it more easily, using the built in browser text
search.

Though, I've been kinda leaning toward doing my own ddoc impl with the json
output anyway, which can do all kinds of organization, making dynamic pages out
of it. However, like just about everything non-work I do though, it isn't
finished yet!

http://dpldocs.info/std.stdio

Anyway though I like the ddoc how it is now because it is simple too. So if we
change it, I think the existing behavior should at least still be available.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Jan 22 2013
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9370


9999 <sibaqexozequgaba tempomail.fr> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |sibaqexozequgaba tempomail.
                   |                            |fr


--- Comment #2 from 9999 <sibaqexozequgaba tempomail.fr> 2013-01-22 13:10:17
PST ---
There's the wonderful ddox:
https://github.com/rejectedsoftware/ddox

Phobos:
http://vibed.org/temp/phobos/index.html

I don't understand why don't you:
1. Replace ddoc with it.
2. Use it on dlang.org for Phobos documentation.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Jan 22 2013
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9370



--- Comment #3 from Andrei Alexandrescu <andrei erdani.com> 2013-01-22 23:44:40
PST ---
ddox is indeed the prime candidate for this.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Jan 22 2013
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9370


Knud <knud all-technology.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |knud all-technology.com


--- Comment #4 from Knud <knud all-technology.com> 2013-01-28 14:00:02 PST ---
From http://forum.dlang.org/post/kdl45o$30ak$1 digitalmars.com

== online documentation ==
When I returned to D I felt very frustrated with D online documentation.
After looking for root of the feeling i found that the reason was that
I was used to the documentation of php.
In php each function have a page of it own. (Closely resembling the unix
man page)
This means that if I search for "php strip" google send me to
http://php.net/manual/en/function.trim.php

Where the first line tells me:
trim — Strip whitespace (or other characters) from the beginning and end
of a string

So It is very fast to see if I got the right page.

If I search for "dlang strip" I am send to
http://dlang.org/phobos/std_string.html.
Then I have to look through the document to find the right function
and to find that functions typical is missing examples and good
descriptions of parameters and return values.

(I think that the example part can be improved by automatic including
unittest in the documentation,
which would also insure that the examples is working.)
(When documents is generated ddoc could test for if description for
parameters and return values was present)

Also another thing I like about the php documentation is the user notes
at the bottom of the page,
I know you are trying to make something simmilar with the "Improve this
page" and "Page wiki" at the top,
but I have to say that I don't think it works as well.

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Jan 28 2013
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9370


Andrei Alexandrescu <andrei erdani.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |ASSIGNED


--- Comment #5 from Andrei Alexandrescu <andrei erdani.com> 2013-01-28 15:27:44
PST ---
Assigned to Sönke Ludwig :o)

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Jan 28 2013
prev sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=9370



--- Comment #6 from Sönke Ludwig <sludwig outerproduct.org> 2013-02-16 02:31:48
PST ---
Pull requests adding single page output as an optional feature:

https://github.com/D-Programming-Language/tools/pull/43
https://github.com/D-Programming-Language/d-programming-language.org/pull/267

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