March 10, 2014 ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Consider it alpha quality. Please don't announce yet before we put it in good shape. https://github.com/D-Programming-Language/dlang.org/pull/516 http://dlang.org/library http://dlang.org/library-prerelease I needed to change quite a bit about the makefile. It was building everything over and over again, and it's _slow_. Some functions are not ready, compare e.g. http://dlang.org/library/std/algorithm/balancedParens.html with http://dlang.org/library/std/algorithm/any.html Andrei |
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | I have to say its looking good. Although it does show just how much we need to break things up and make it a little bit more organised. Great example is the digest modules. |
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | I very like how Tango docs organized http://www.dsource.org/projects/tango/docs/stable/ Also good example how docs organized http://devdocs.io |
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 10 March 2014 at 03:44:54 UTC, Andrei Alexandrescu
wrote:
> Consider it alpha quality. Please don't announce yet before we put it in good shape.
>
> https://github.com/D-Programming-Language/dlang.org/pull/516
>
> http://dlang.org/library
>
> http://dlang.org/library-prerelease
>
> I needed to change quite a bit about the makefile. It was building everything over and over again, and it's _slow_.
>
> Some functions are not ready, compare e.g.
>
> http://dlang.org/library/std/algorithm/balancedParens.html
>
> with
>
> http://dlang.org/library/std/algorithm/any.html
>
>
> Andrei
Huge improvement in a lot of ways. Thanks Sönke and Andrei.
|
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | Fantastic! The organization makes it easy to find the right tool for the job. This is probably nitpicking, but in std.algorithm and other modules ( http://dlang.org/library/std/algorithm.html ) there are multiple overloads of the same function (splitter, reverse, etc); it'd be nice if these could be organized into their own sub-categories, so there's no unnecessary visual redundancy. There's also the library list which displays all modules; do the internal modules (druntime, etc) need to be exposed? It might be nicer for the end-user for these to be hidden, or kept in their own category. Otherwise, very nice! :) |
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 10 March 2014 at 03:44:54 UTC, Andrei Alexandrescu wrote:
> http://dlang.org/library
Looking good!
The module list current shows deeply nested modules (e.g. std.c.stdio) before less nested ones (std.stdio). I think it should be the other way round, otherwise you have all the std.c.* modules listed first.
|
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | 10-Mar-2014 07:44, Andrei Alexandrescu пишет: > Consider it alpha quality. Please don't announce yet before we put it in > good shape. > > https://github.com/D-Programming-Language/dlang.org/pull/516 > > http://dlang.org/library > > http://dlang.org/library-prerelease > > I needed to change quite a bit about the makefile. It was building > everything over and over again, and it's _slow_. > > Some functions are not ready, compare e.g. > > http://dlang.org/library/std/algorithm/balancedParens.html > > with > > http://dlang.org/library/std/algorithm/any.html > > > Andrei > The front page shouldn't contain std.internal.* stuff and we probably need to adjust DDocs so that all modules have proper blurb text. -- Dmitry Olshansky |
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 10 March 2014 at 03:44:54 UTC, Andrei Alexandrescu wrote:
> Consider it alpha quality. Please don't announce yet before we put it in good shape.
>
> https://github.com/D-Programming-Language/dlang.org/pull/516
>
> http://dlang.org/library
>
> http://dlang.org/library-prerelease
>
> I needed to change quite a bit about the makefile. It was building everything over and over again, and it's _slow_.
>
> Some functions are not ready, compare e.g.
>
> http://dlang.org/library/std/algorithm/balancedParens.html
>
> with
>
> http://dlang.org/library/std/algorithm/any.html
>
>
> Andrei
For me it's a real improvement! One thing: symbol names (modules, functions, etc.) shouldn't be hyphenated, specially in tables.
Nicolas
|
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 10 March 2014 at 03:44:54 UTC, Andrei Alexandrescu wrote:
> Consider it alpha quality. Please don't announce yet before we put it in good shape.
>
> https://github.com/D-Programming-Language/dlang.org/pull/516
>
> http://dlang.org/library
>
> http://dlang.org/library-prerelease
>
> I needed to change quite a bit about the makefile. It was building everything over and over again, and it's _slow_.
>
> Some functions are not ready, compare e.g.
>
> http://dlang.org/library/std/algorithm/balancedParens.html
>
> with
>
> http://dlang.org/library/std/algorithm/any.html
>
>
> Andrei
Nice, but those duplicates have got to go!
|
March 10, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | Very nice! std.algorithm, std.net.curl etc. have their functions/classes split in categories. I haven't used ddox myself but would it be possible to modify it to read a "category" variable in the documentation for a function and then use that to group things in the resulting html file? Or would that need modifications to dmd itself. /Jonas |
Copyright © 1999-2021 by the D Language Foundation