Documentation File Generation

[iwillspeak]

It would be nice to generate .xml style docs for our libraries. An example format for these comments in Scheme is SchemeDoc: http://people.cs.aau.dk/~normark/schemedoc/

see also monodocer: https://www.mono-project.com/docs/tools+libraries/tools/monodoc/generating-documentation/

[iwillspeak]

One approach here would be to start tracking whitespace as "trivia" tokens. When binding a tree and we encounter a define form we can look in the leading trivia for documentation comments.

Generally speaking tokens collect all the leading trivia since the last token, and trailing trivia until the end of the line. Not sure how easy this will be to achieve with FParsec.

[iwillspeak]

Mono.Cecil.Rocks seems to haver some types to aid in generating the documentation names that would be needed for this:

https://github.com/jbevain/cecil/blob/master/rocks/Mono.Cecil.Rocks/DocCommentId.cs

[iwillspeak]

We don’t have enough trivia information in the current tree to properly support this. Hopefully switching to full fidelity concrete trees will solve the problem by including trivia.