hedgedoc / react-client

The frontend of the upcoming version 2.0

Home Page:https://hedgedoc.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rework ESDoc comments

DerMolly opened this issue · comments

Browsing the ESDoc blocks throughout the whole project, it seems we're quite inconsistent with ESDoc in general.
I will change it for the occurrences here but we should go over all ESDoc in another PR again to ensure that
a) every exported method has an ESDoc block,
b) @throws are applied everywhere where necessary (there are many missing ones right now!),
c) the blank lines are present and
d) the description ends with a dot.

Originally posted by @ErikMichelson in #1545 (comment)