Writing code documentation (please don't do it this way)

Ftlog, whenever you are trying to create any public API, and writing documentation for something, ESP when something becomes deprecated - ALWAYS, like ALWAYS reference where to find new approach of doing things!