[OpenWalnut-Dev] How to avoid duplication in your documentation

[Mathias Goldau]

Developers, developers, developers [1],

I've sometimes the problem that the description of the return type is also a
good brief description for the function, e.g.:

    /**
     * The number of positions in this grid.
     *
     * \return \copybrief WGrid::size()
     */
    size_t size() const;

This way the brief description is now also used for the return type.
Especially when inheritance comes into play, this could make our documentation
much more robust!

I hate both alternatives to live with just the brief or just the return type
documenation, since then you must scroll and scroll, search... this simply
pisses me off.

Especially the new doxygen versions will warn on missing return type
documentation so we should them provide anyway.

regards
math

[1] http://www.youtube.com/watch?v=8To-6VIJZRE yes its old but still so funny.

-- 
Institut für Informatik
Universität Leipzig
Johannisgasse 26, 04103 Leipzig
Phone: +493419732283