core.stdc.* documentation

[Andrei Alexandrescu via Digitalmars-d]

I just fixed documentation to generate docs for all symbols in 
core.stdc.complex. Looks unhelpful:


http://erdani.com/d/library-prerelease/core/stdc/complex.html

Any idea on how to make this better?


Thanks,

Andrei

Re: core.stdc.* documentation

[Kiith-Sa via Digitalmars-d]

On Monday, 12 January 2015 at 00:29:49 UTC, Andrei Alexandrescu 
wrote:
I just fixed documentation to generate docs for all symbols in 
core.stdc.complex. Looks unhelpful:


http://erdani.com/d/library-prerelease/core/stdc/complex.html

Any idea on how to make this better?


Thanks,

Andrei


Links to cppreference.com . Please not LUCKY, it often results in 
not-the-best or even straght not-good results.


E.g. cacos/cacosf/cacosl:
http://en.cppreference.com/w/c/numeric/complex/cacos

Re: core.stdc.* documentation

[Andrei Alexandrescu via Digitalmars-d]

On 1/11/15 5:04 PM, Kiith-Sa wrote:

On Monday, 12 January 2015 at 00:29:49 UTC, Andrei Alexandrescu wrote:

I just fixed documentation to generate docs for all symbols in
core.stdc.complex. Looks unhelpful:

http://erdani.com/d/library-prerelease/core/stdc/complex.html

Any idea on how to make this better?


Thanks,

Andrei


Links to cppreference.com . Please not LUCKY, it often results in
not-the-best or even straght not-good results.

E.g. cacos/cacosf/cacosl:
http://en.cppreference.com/w/c/numeric/complex/cacos


Problem is not that, but instead the repeated description. -- Andrei

Re: core.stdc.* documentation

[Jacob Carlborg via Digitalmars-d]

On 2015-01-12 02:24, Andrei Alexandrescu wrote:


Problem is not that, but instead the repeated description. -- Andrei


How about folding symbols with the same documentation, like "ditto" does?

--
/Jacob Carlborg

Re: core.stdc.* documentation

[Andrei Alexandrescu via Digitalmars-d]

On 1/12/15 12:05 AM, Jacob Carlborg wrote:

On 2015-01-12 02:24, Andrei Alexandrescu wrote:


Problem is not that, but instead the repeated description. -- Andrei


How about folding symbols with the same documentation, like "ditto" does?


I used "ditto" to generate that. -- Andrei

Re: core.stdc.* documentation

[Steven Schveighoffer via Digitalmars-d]

On 1/11/15 7:29 PM, Andrei Alexandrescu wrote:

I just fixed documentation to generate docs for all symbols in
core.stdc.complex. Looks unhelpful:

http://erdani.com/d/library-prerelease/core/stdc/complex.html

Any idea on how to make this better?


Yeah, ddox should put the prototype in the overview. How annoying to 
have to click on the name to figure out what the function call requires 
as parameters. Is there a command-line parameter to fix this?


-Steve

Re: core.stdc.* documentation

[Andrei Alexandrescu via Digitalmars-d]

On 1/12/15 3:53 AM, Steven Schveighoffer wrote:

On 1/11/15 7:29 PM, Andrei Alexandrescu wrote:

I just fixed documentation to generate docs for all symbols in
core.stdc.complex. Looks unhelpful:

http://erdani.com/d/library-prerelease/core/stdc/complex.html

Any idea on how to make this better?


Yeah, ddox should put the prototype in the overview. How annoying to
have to click on the name to figure out what the function call requires
as parameters. Is there a command-line parameter to fix this?

-Steve


Yah, for stdc it seems the page-per-module approach is better. -- Andrei

Re: core.stdc.* documentation

[Steven Schveighoffer via Digitalmars-d]

On 1/12/15 11:10 AM, Andrei Alexandrescu wrote:

On 1/12/15 3:53 AM, Steven Schveighoffer wrote:

On 1/11/15 7:29 PM, Andrei Alexandrescu wrote:

I just fixed documentation to generate docs for all symbols in
core.stdc.complex. Looks unhelpful:

http://erdani.com/d/library-prerelease/core/stdc/complex.html

Any idea on how to make this better?


Yeah, ddox should put the prototype in the overview. How annoying to
have to click on the name to figure out what the function call requires
as parameters. Is there a command-line parameter to fix this?

-Steve


Yah, for stdc it seems the page-per-module approach is better. -- Andrei


The ideal for me would be:

1. Show function + prototype (even if prototype is cut short but has 
popup to show full sig) and short description.

2. Have a "+" button or "more..." link that unhides the full docs inline.

Going to separate pages for each function is quite annoying.

In fact, I would say all leaf nodes should act this way instead of 
having their own page specifically. You would still have user defined 
constructs get their own page (classes, structs, templates, enums).


This would cut down tremendously on the noise and clicking.

-Steve

Re: core.stdc.* documentation

[Andrei Alexandrescu via Digitalmars-d]

On 1/12/15 10:38 AM, Steven Schveighoffer wrote:

On 1/12/15 11:10 AM, Andrei Alexandrescu wrote:

On 1/12/15 3:53 AM, Steven Schveighoffer wrote:

On 1/11/15 7:29 PM, Andrei Alexandrescu wrote:

I just fixed documentation to generate docs for all symbols in
core.stdc.complex. Looks unhelpful:

http://erdani.com/d/library-prerelease/core/stdc/complex.html

Any idea on how to make this better?


Yeah, ddox should put the prototype in the overview. How annoying to
have to click on the name to figure out what the function call requires
as parameters. Is there a command-line parameter to fix this?

-Steve


Yah, for stdc it seems the page-per-module approach is better. -- Andrei


The ideal for me would be:

1. Show function + prototype (even if prototype is cut short but has
popup to show full sig) and short description.
2. Have a "+" button or "more..." link that unhides the full docs inline.

Going to separate pages for each function is quite annoying.

In fact, I would say all leaf nodes should act this way instead of
having their own page specifically. You would still have user defined
constructs get their own page (classes, structs, templates, enums).

This would cut down tremendously on the noise and clicking.

-Steve


Sounds good. Anyone want to take this? -- Andrei