Which is the correct way of documenting getter &am...

# getting-started

[miha-x64]

Which is the correct way of documenting getter & setter separately?

var value: T
    /**
     * Returns current value.
     */
    get <-- 'redundant getter'
    /**
     * Changes value and notifies listeners. Will break current binding, if any.
     */
    set <-- 'redundant setter'

UPD: found: https://youtrack.jetbrains.com/issue/KT-17962

[orangy]

Why do you need to document getter and setter? I would document a property instead.

[miha-x64]

Because the setter has an important side-effect which I want to describe. Finally, documented a property.

[nfrankel]

the setter has an important side-effect

🤔

[miha-x64]

The property is observable. The side-effect is observers notification. Anything wrong? 🙂

[nfrankel]

not wrong, uncommon
now i understand why you want to document it