Re: Doxygen @return vs. @retval

2019-03-02 Thread Gedare Bloom
On Fri, Mar 1, 2019 at 4:57 AM Sebastian Huber < sebastian.hu...@embedded-brains.de> wrote: > On 28/02/2019 17:06, Joel Sherrill wrote: > > > > > > On Thu, Feb 28, 2019 at 9:03 AM Sebastian Huber > > > > wrote: > > > > Hello, > > > > we agreed to

Re: Doxygen @return vs. @retval

2019-03-01 Thread Sebastian Huber
On 28/02/2019 17:06, Joel Sherrill wrote: On Thu, Feb 28, 2019 at 9:03 AM Sebastian Huber > wrote: Hello, we agreed to use @retval instead of @return: https://docs.rtems.org/branches/master/eng/coding-doxygen.html#doxygen-best-practic

Re: Doxygen @return vs. @retval

2019-02-28 Thread Joel Sherrill
On Thu, Feb 28, 2019 at 9:03 AM Sebastian Huber < sebastian.hu...@embedded-brains.de> wrote: > Hello, > > we agreed to use @retval instead of @return: > > > https://docs.rtems.org/branches/master/eng/coding-doxygen.html#doxygen-best-practices > > Is there going to be a global replacement or have t

Doxygen @return vs. @retval

2019-02-28 Thread Sebastian Huber
Hello, we agreed to use @retval instead of @return: https://docs.rtems.org/branches/master/eng/coding-doxygen.html#doxygen-best-practices How should we indicate that not a particular value is returned, but instead an element of a set. For example: /**  * @brief Performs something and returns