Indicates that a documentation of a field, method or class needs to be improved
(or added if absent).
Example usages:
- Certain aspects are under-documented or not-yet-known and need to be improved
in the future.
- You need to urgently integrate a patch, but have not upgraded the documentation properly,
and will do that ASAP. Such annotation is preferred to crude, inadequate comments.
- A badly documented code got into the project, and you had to dig deeply
into implementation details to understand how to use it.
Do not leave this task unassigned!
It also works as a waiver for the CI server. Do not abuse.