Skip to content
This repository was archived by the owner on Oct 12, 2022. It is now read-only.

Conversation

schveiguy
Copy link
Member

@schveiguy
Copy link
Member Author

Note, I did test and make sure all the links are correct, but I did not test how ddoc or ddox outputs this.

* This contains bindings to selected types and functions from the standard C
* header $(LINK2 http://pubs.opengroup.org/onlinepubs/009695399/basedefs/complex.h.html, <complex.h>). Note
* that this is not automatically generated, and may omit some types/functions
* from the original C header.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! This seems to be repeated (modulo link), so could you please put it in a macro that we can update wholesale?

C_HEADER_DESCRIPTION = This module contains bindings to selected types and functions from the standard C
header $(HTTP pubs.opengroup.org/onlinepubs/009695399/basedefs/$1.html, $(LT)$1$(GT)). Note that this is not
automatically generated, and may omit some types/functions from the original C header.

Plant this bad boy in html.ddoc and expand it in all these modules.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, will do. But I think due to the possible instability of the Internet, I'll take both name of header and URL as parameters.

@andralex
Copy link
Member

andralex commented Jan 9, 2015

Thanks for this work, Steve!

@schveiguy
Copy link
Member Author

BTW, it may be a good idea before pulling to actually build the docs and look at the preview to make sure it's not horrible :)

@schveiguy
Copy link
Member Author

Don't pull until I get the html.ddoc update into dlang.org

@jacob-carlborg
Copy link
Contributor

Some of the comments in the first two files are not aligned with the declaration, but that might not be your fault. The declarations are not really consistently aligned.

@schveiguy
Copy link
Member Author

Anyone with dlang.org commit rights: dlang/dlang.org#752

@schveiguy
Copy link
Member Author

Some of the comments in the first two files are not aligned with the declaration, but that might not be your fault. The declarations are not really consistently aligned.

Yeah, it's a combination of the existing file and the editor I use. It's aligning the comment to the previous indentation. This was just a hell of a lot of applying vim macros to add those triple-slashes :) I didn't pay too much attention to the looks.

andralex added a commit that referenced this pull request Jan 9, 2015
Try to add minimal documentation for all core.stdc bindings
@andralex andralex merged commit 0803287 into dlang:master Jan 9, 2015
@MartinNowak
Copy link
Member

Nice try, still missing from the build system though.

MartinNowak added a commit to MartinNowak/druntime that referenced this pull request Feb 16, 2015
@schveiguy schveiguy deleted the updatecheaddocs branch April 20, 2015 15:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants