Jump to page: 1 2
Thread overview
dpldocs: xlinking and Documented destructors and postblits
Mar 01, 2017
Adam D. Ruppe
Mar 01, 2017
lobo
Mar 01, 2017
rikki cattermole
Mar 01, 2017
Adam D. Ruppe
Mar 01, 2017
lobo
Mar 01, 2017
Sebastiaan Koppe
Mar 01, 2017
bachmeier
Mar 01, 2017
Adam D. Ruppe
Mar 01, 2017
Seb
Mar 02, 2017
Adam D. Ruppe
Mar 02, 2017
Adam D. Ruppe
Mar 04, 2017
Adam D. Ruppe
Mar 01, 2017
Adam D. Ruppe
March 01, 2017
I stumbled across std.typecons.Unique in my doc website today and realized there was a postblit in the source, but I didn't display the documentation comment.

Aghast at my awful bug, I immediately set out to fix it. Behold:

http://dpldocs.info/experimental-docs/std.typecons.RefCounted.html#destructor

Now, mind you, dpldocs remains buggy in a few places. I'm not happy with how I display the `alias this` for example... but I am kinda proud that I *do* actually display it. Similarly, the link in the destructor goes sort of to the right place, but not quite - it leaves you two clicks short. I'll fix that. But on the other hand, click through to many of the other things, like the enum values referenced in the introduction. My generator brings you right to the enum page, highlighting the specific value!

Similarly, I now display destructors, postblits, alias this, and disabled default constructors, whether they have ddoc or not. And if they do, I display it. The user needs to know about those things, otherwise the code is a mysterious black box!

Contrast to the official docs:
http://dlang.org/phobos/std_typecons.html#.RefCounted
http://dlang.org/library-prerelease/std/typecons/ref_counted.html

I'm actually a bit surprised that the documentation comments written in that source have NEVER BEFORE been displayed online! Someone took the effort to write those docs, but the generators all discarded them.

Y'all maintaining ddoc and ddox should file bugs ;) At the very least, you should display everything that has explicit ddoc comments attached!

Or better yet, surrender to me! D is gaining features that ddoc doesn't even know how to handle.... but I do...
March 01, 2017
On Wednesday, 1 March 2017 at 05:18:59 UTC, Adam D. Ruppe wrote:
> I stumbled across std.typecons.Unique in my doc website today and realized there was a postblit in the source, but I didn't display the documentation comment.
>
> [...]

Is it possible to use your tool to generate the docs for my own code?

Thanks,
lobo
March 01, 2017
On 01/03/2017 7:19 PM, lobo wrote:
> On Wednesday, 1 March 2017 at 05:18:59 UTC, Adam D. Ruppe wrote:
>> I stumbled across std.typecons.Unique in my doc website today and
>> realized there was a postblit in the source, but I didn't display the
>> documentation comment.
>>
>> [...]
>
> Is it possible to use your tool to generate the docs for my own code?
>
> Thanks,
> lobo

Link[0].

[0] https://github.com/adamdruppe/adrdox
March 01, 2017
On 03/01/2017 12:18 AM, Adam D. Ruppe wrote:
>
> Or better yet, surrender to me! D is gaining features that ddoc doesn't
> even know how to handle.... but I do...

http://www.youtube.com/watch?v=lBEn3a4TIUw&t=0m11s

But seriously though, nice job!

March 01, 2017
On 03/01/2017 01:56 AM, Nick Sabalausky (Abscissa) wrote:
> On 03/01/2017 12:18 AM, Adam D. Ruppe wrote:
>>
>> Or better yet, surrender to me! D is gaining features that ddoc doesn't
>> even know how to handle.... but I do...
>
> http://www.youtube.com/watch?v=lBEn3a4TIUw&t=0m11s
>
> But seriously though, nice job!
>

(There needs to be a language based entirely on Youtube links. Take that, Darmok and Jalad at Tanagra!)

March 01, 2017
On Wednesday, 1 March 2017 at 05:18:59 UTC, Adam D. Ruppe wrote:
> Contrast to the official docs:
> http://dlang.org/phobos/std_typecons.html#.RefCounted
> http://dlang.org/library-prerelease/std/typecons/ref_counted.html

my 2 cents:

The officials docs has too much grey and the information is not where you expect it to be. Yours is way more readable to me.
March 01, 2017
On Wednesday, 1 March 2017 at 05:18:59 UTC, Adam D. Ruppe wrote:
> Or better yet, surrender to me! D is gaining features that ddoc doesn't even know how to handle.... but I do...

If by "surrender", you mean adopt your system for the official documentation, well I sure hope not. That's a fast way to kill progress on anything related to this language.
March 01, 2017
On Wednesday, 1 March 2017 at 06:19:30 UTC, lobo wrote:
> Is it possible to use your tool to generate the docs for my own code?

Yes, but I don't actually support it yet (you can grab the code from the link rikki gave but you're on your own).

I work on this in between the other million things I have to do, so we are probably still a bit away from this, but once I'm happy with the feature set, I'll call it "beta" in the header and start supporting it for other people, through a download of the generator or probably an upload to my site of a zip of your project.

My ideal end goal is to have a combined search too btw, so you can find docs for anything from the dpldocs.info homepage.
March 01, 2017
On Wednesday, 1 March 2017 at 12:05:33 UTC, bachmeier wrote:
> If by "surrender", you mean adopt your system for the official documentation, well I sure hope not. That's a fast way to kill progress on anything related to this language.

Yeah, I'd prolly have to continue working on it myself but they could fork off a stable version to use on the website.

Regardless though, I'd also be happy if the competitive pressure leads to improvements on the main site (while I continue to be streets ahead on my own site).
March 01, 2017
Seeing ddmd coming to dlang.org <https://dlang.org/phobos-prerelease/ddmd_access.html>, just for fun I ran my doc generator over the dmd source code too: http://dpldocs.info/experimental-docs/ddmd.html I didn't enable search over it but you can browse to the extent that there are ddoc comments in there.

This is an interesting case to look at because dmd is pretty class-heavy... and my class handling is OK, but not great.

Like here, it shows inherited members from Declaration, but not from Dsymbol.

http://dpldocs.info/experimental-docs/ddmd.declaration.AliasDeclaration.html

but hey at least you can navigate up the tree with just a few clicks anyway.
« First   ‹ Prev
1 2