Commenting source code

[zvonimir]

@Thanhson89, who is a PhD student at Utah, has been investing a lot of time to understand the source code of FPTaylor. He is documenting his findings along the way, and I thought it would be a good idea for this effort not to go to waste and that he turns this into nice comments in the code.

@monadius what do you think? If this sounds like it would be a potential improvement of FPTaylor for future users, please let us know and we'll create pull requests to add these comments in. Thanks!

[ganeshutah]

On Thu, Mar 28, 2019 at 8:26 AM Zvonimir ***@***.***> wrote: @Thanhson89 <https://github.com/Thanhson89>, who is a PhD student at Utah, has been investing a lot of time to understand the source code of FPTaylor. He is documenting his findings along the way, and I thought it would be a good idea for this effort not to go to waste and that he turns this into nice comments in the code.

I would be happy to even discuss this with Thanhson, as this will help me stay on top of OCaml (used to program using a basic subset once, but don't any more). This is a great idea!! Are there good Doxygen-equivalents in OCaml so that one can produce nice web documents etc? That can be an artifact claimed under our NSF grant.

…

@monadius <https://github.com/monadius> what do you think? If this sounds like it would be a potential improvement of FPTaylor for future users, please let us know and we'll create pull requests to add these comments in. Thanks! — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#15>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AEyiCq6USNjnJJUFoNTTj1DcBGvPYBC-ks5vbND7gaJpZM4cQSyE> .

[monadius]

@zvonimir Comments are always good. So please create a pull request and I will review and merge it.

@ganeshutah There is ocamldoc for generating html and LaTeX files from OCaml source files. A common practice among OCaml programmers is to provide documentation comments inside interface files (.mli). Examples of documentation comments can be found in the INTEVAL directory: interval.mli.