On 6 Jan 2016, at 20:41, David Matthews <[email protected]> wrote:

> Most of the documentation relates to the signatures of library functions.  It 
> would be really nice to be able to have the descriptions of the functions 
> contained in comments in the library source itself and then have a program 
> that would automatically turn the ML signature and the special comments into 
> HTML.  I think there are such things for other languages although I've never 
> used them.  Is there such a thing for ML?  This would make it much easier to 
> keep the source code and the documentation in sync.

There once was ml-doc:

http://people.cs.uchicago.edu/~jhr/tools/ml-doc.html

I’ve never used it. IIUC it was used to render the SML basis library manual 
pages.

haddock (for Haskell) is pretty amazing these days, e.g.

https://hackage.haskell.org/package/base-4.8.1.0/docs/Prelude.html

(I like the “source” links in particular.)

cheers,
peter

-- 
http://peteg.org/

_______________________________________________
polyml mailing list
[email protected]
http://lists.inf.ed.ac.uk/mailman/listinfo/polyml

Reply via email to