What is the proper way to write doc for bindings?
While writing a Haskell binding for some libs written in C, a thing has to do is writing docs in haddock format. But since normally the binding is just plain, the doc would be just reformat of original libs' doc.
So my question is, is there some tools to help with this? Thanks.
haskell c2hs
asked Nov 26 '18 at 9:01
MagicloudMagicloud
3191313
add a comment |
While writing a Haskell binding for some libs written in C, a thing has to do is writing docs in haddock format. But since normally the binding is just plain, the doc would be just reformat of original libs' doc.
So my question is, is there some tools to help with this? Thanks.
haskell c2hs
asked Nov 26 '18 at 9:01
MagicloudMagicloud
3191313
add a comment |
While writing a Haskell binding for some libs written in C, a thing has to do is writing docs in haddock format. But since normally the binding is just plain, the doc would be just reformat of original libs' doc.
So my question is, is there some tools to help with this? Thanks.
haskell c2hs
asked Nov 26 '18 at 9:01
MagicloudMagicloud
3191313
While writing a Haskell binding for some libs written in C, a thing has to do is writing docs in haddock format. But since normally the binding is just plain, the doc would be just reformat of original libs' doc.
So my question is, is there some tools to help with this? Thanks.
haskell c2hs
haskell c2hs
asked Nov 26 '18 at 9:01
MagicloudMagicloud
3191313
asked Nov 26 '18 at 9:01
MagicloudMagicloud
3191313
asked Nov 26 '18 at 9:01
MagicloudMagicloud
3191313
asked Nov 26 '18 at 9:01
MagicloudMagicloud
3191313
asked Nov 26 '18 at 9:01
MagicloudMagicloud
3191313
3191313
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
I don't know of any tool for that. Since C docs can take many forms, I don't think there is any tool.
If the binding is indeed plain, essentially everything in IO, same names as the C library, etc. there is a very lazy option: provide a link to the C docs and refer to that.
Better: if the C docs are online, and each function/variable/entity has its own link, provide a link for each entity. In such way, the Haskell programmer can find your docs in Hackage, as usual, and then it's just one more click away to the real docs.
Of course, ideally one should copy the C docs, so that it's immediately available. However, this can require a lot of work, and some care in handling copyright correctly.
answered Nov 26 '18 at 9:49
chichi
77.2k287146
That is what I am doing. But I wonder if it may be done in some way? Since many C docs can be in online(html) or man page, some information for the pre-processor to grab the C doc and generate haddock. May be able to do?
– Magicloud
Nov 27 '18 at 5:13
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53477658%2fwhat-is-the-proper-way-to-write-doc-for-bindings%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
I don't know of any tool for that. Since C docs can take many forms, I don't think there is any tool.
If the binding is indeed plain, essentially everything in IO, same names as the C library, etc. there is a very lazy option: provide a link to the C docs and refer to that.
Better: if the C docs are online, and each function/variable/entity has its own link, provide a link for each entity. In such way, the Haskell programmer can find your docs in Hackage, as usual, and then it's just one more click away to the real docs.
Of course, ideally one should copy the C docs, so that it's immediately available. However, this can require a lot of work, and some care in handling copyright correctly.
answered Nov 26 '18 at 9:49
chichi
77.2k287146
That is what I am doing. But I wonder if it may be done in some way? Since many C docs can be in online(html) or man page, some information for the pre-processor to grab the C doc and generate haddock. May be able to do?
– Magicloud
Nov 27 '18 at 5:13
add a comment |
I don't know of any tool for that. Since C docs can take many forms, I don't think there is any tool.
If the binding is indeed plain, essentially everything in IO, same names as the C library, etc. there is a very lazy option: provide a link to the C docs and refer to that.
Better: if the C docs are online, and each function/variable/entity has its own link, provide a link for each entity. In such way, the Haskell programmer can find your docs in Hackage, as usual, and then it's just one more click away to the real docs.
Of course, ideally one should copy the C docs, so that it's immediately available. However, this can require a lot of work, and some care in handling copyright correctly.
answered Nov 26 '18 at 9:49
chichi
77.2k287146
That is what I am doing. But I wonder if it may be done in some way? Since many C docs can be in online(html) or man page, some information for the pre-processor to grab the C doc and generate haddock. May be able to do?
– Magicloud
Nov 27 '18 at 5:13
add a comment |
I don't know of any tool for that. Since C docs can take many forms, I don't think there is any tool.
If the binding is indeed plain, essentially everything in IO, same names as the C library, etc. there is a very lazy option: provide a link to the C docs and refer to that.
Better: if the C docs are online, and each function/variable/entity has its own link, provide a link for each entity. In such way, the Haskell programmer can find your docs in Hackage, as usual, and then it's just one more click away to the real docs.
Of course, ideally one should copy the C docs, so that it's immediately available. However, this can require a lot of work, and some care in handling copyright correctly.
answered Nov 26 '18 at 9:49
chichi
77.2k287146
I don't know of any tool for that. Since C docs can take many forms, I don't think there is any tool.
If the binding is indeed plain, essentially everything in IO, same names as the C library, etc. there is a very lazy option: provide a link to the C docs and refer to that.
Better: if the C docs are online, and each function/variable/entity has its own link, provide a link for each entity. In such way, the Haskell programmer can find your docs in Hackage, as usual, and then it's just one more click away to the real docs.
Of course, ideally one should copy the C docs, so that it's immediately available. However, this can require a lot of work, and some care in handling copyright correctly.
answered Nov 26 '18 at 9:49
chichi
77.2k287146
answered Nov 26 '18 at 9:49
chichi
77.2k287146
answered Nov 26 '18 at 9:49
chichi
77.2k287146
answered Nov 26 '18 at 9:49
chichi
77.2k287146
77.2k287146
That is what I am doing. But I wonder if it may be done in some way? Since many C docs can be in online(html) or man page, some information for the pre-processor to grab the C doc and generate haddock. May be able to do?
– Magicloud
Nov 27 '18 at 5:13
add a comment |
That is what I am doing. But I wonder if it may be done in some way? Since many C docs can be in online(html) or man page, some information for the pre-processor to grab the C doc and generate haddock. May be able to do?
– Magicloud
Nov 27 '18 at 5:13
That is what I am doing. But I wonder if it may be done in some way? Since many C docs can be in online(html) or man page, some information for the pre-processor to grab the C doc and generate haddock. May be able to do?
– Magicloud
Nov 27 '18 at 5:13
That is what I am doing. But I wonder if it may be done in some way? Since many C docs can be in online(html) or man page, some information for the pre-processor to grab the C doc and generate haddock. May be able to do?
– Magicloud
Nov 27 '18 at 5:13
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53477658%2fwhat-is-the-proper-way-to-write-doc-for-bindings%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
