GH-644: documenter clean

[tobHai]

writeDocumentation cleans the output directory before writing any documentation files per default.

I think for the other public writeXYZ method, clearing the directory does not make any sense since writeModulesAsPlantUml, writeIndividualModulesAsPlantUml and writeModuleCanvases are called from writeDocumentation - additional cleans in those methods would delete previously created files.

@odrotbohm your feedback would be appreciated! :)
Thanks!

[odrotbohm]

This looks pretty decent to me already. A couple of general comments:

• Would you mind adding Javadoc to the public methods of the newly introduced Options type?
• Switch to var for the variables created in test cases for consistency

Regarding the “wipe once approach”: IIRC, we discussed this with Cora at some point. I don't remember the exact details anymore but wonder whether we can keep a variable within the Documenter instance whether an initial wiping has occurred. As the write… methods all return this we could flip the flag for the first method invoked. clearOutputFolder() looks like a good place to implement such logic. I guess we'd need to document this behavior clearly in Options.defaults()'s Javadoc.

[tobHai]

Thanks for the feedback! Sure, no problem - I will add Javadoc and make use of var.
I will investigate into the "wipe once approach" - I hope I find some time soon 😄

[odrotbohm]

Do you have a rough estimate when you would get to this? I'd love to get the changes into the release next Friday. I am happy to take it from here but don't want to break your flow if you're still considering it.

[tobHai]

Hi!
I tackled the points regarding the documentation and the use of var.
Unfortunately, I do not have time before Friday to work on the "wipe once approach" - it would be great if you could take it from here.

Thanks!

[odrotbohm]

No worries at all! Thanks for the contribution so far!

[odrotbohm]

That's polished and merged against GH-644, thanks!