-
-
Notifications
You must be signed in to change notification settings - Fork 416
Try to add minimal documentation for all core.stdc bindings #1091
Conversation
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Thanks for this work, Steve! |
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 :) |
Don't pull until I get the html.ddoc update into dlang.org |
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. |
Anyone with dlang.org commit rights: dlang/dlang.org#752 |
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. |
Try to add minimal documentation for all core.stdc bindings
Nice try, still missing from the build system though. |
See discussion here: http://forum.dlang.org/post/m8lsit$1eqi$1@digitalmars.com