first draft of doc comments

Sudha247 / ocaml-joy

MIT License

21 stars 14 forks source link

first draft of doc comments #112

Open FayCarsons opened 5 months ago

FayCarsons commented 5 months ago

Thanks! Did you mean to add the doc comments to .mli files rather than in the .ml files? The API docs are included in the interface files, and odoc generates HTML files from them.

Oops, I had just assumed it works like other languages I've used. Will move those today!

FayCarsons commented 5 months ago

@Sudha247 Moved everything to joy.mli, I figured since that's all that's exposed then that's all that needs documentation but please let me know if I'm wrong.

Sudha247 commented 3 months ago

I'll fix the conflicts and merge this.