search

natnat-mc / jfun

0 stars 0 forks source link

Autogenerate docs #1

Open natnat-mc opened 3 years ago

natnat-mc commented 3 years ago

Actual docs, with a description of what the functions do, what module they're defined in, etc.

// map :: list 'a -> ('a -> 'b) -> list 'b
// map := src -> fn -> dst
// maps `src` to `dst`, applying `fn` to each element
Annwan commented 3 years ago

Use Javadoc?

natnat-mc commented 3 years ago

That would be a start, but some functions are duplicated (Iter<T> for example) which feels heavy in a Javadoc, and Javadoc lacks any real way to represent types in a "clean" fashion

Annwan commented 3 years ago

Here are my suggestions

For duplicate functions: Document one of them, link to the documented one from the other

For types: Specify ML-Style signatures inside the doc