I have written some projects. I try to annotate or comment all possible (hard to say if correctly toward clean explaining).I would like to write documentation for it, but I have problem with examples.It is not problem to write in annotation above each function (where it is really needed) examples of all possible using of that function - but it would be good to describe each of those examples.And for this, it would be better to use additional file where it will be written as well as possible. But what format and what filetype to use for it?Secondary question is (partly related to main one), that I am not sure if is it needed to examples would be running. Because in case of functions stored in traits it is probably very hard to make those examples running.
The best practice for writing of examples
documentation