Как правильно написать документ для привязок? - PullRequest
0 голосов
/ 26 ноября 2018

При написании привязки на Haskell для некоторых библиотек, написанных на C, необходимо написать документы в формате Haddock.Но так как обычно привязка просто, документ будет просто переформатировать оригинал документа libs.

Так что мой вопрос, есть ли какие-нибудь инструменты, чтобы помочь с этим?Спасибо.

1 Ответ

0 голосов
/ 26 ноября 2018

Я не знаю ни одного инструмента для этого.Поскольку документы C могут принимать разные формы, я не думаю, что существует какой-либо инструмент.

Если привязка действительно простая, то есть практически все в IO, те же имена, что и в библиотеке C, и т. Д.очень ленивый вариант: предоставить ссылку на C-документы и сослаться на это.

Лучше: если C-документы находятся в сети, и у каждой функции / переменной / сущности есть своя собственная ссылка, укажите ссылку для каждой сущности.Таким образом, программист на Haskell может найти ваши документы в Hackage, как обычно, а затем еще один клик до настоящих документов.

Конечно, в идеале нужно копировать документы C, чтобыСразу Доступно.Однако это может потребовать большой работы и некоторой осторожности при правильном обращении с авторским правом.

...