Write proper scaladoc (and validate it)

[zainab-ali]

This issue was copied over from: https://github.com/disneystreaming/weaver-test/issues/252
It was opened by: Baccata

---

Self explanatory