<div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Feb 28, 2019 at 9:03 AM Sebastian Huber <<a href="mailto:sebastian.huber@embedded-brains.de">sebastian.huber@embedded-brains.de</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hello,<br>
<br>
we agreed to use @retval instead of @return:<br>
<br>
<a href="https://docs.rtems.org/branches/master/eng/coding-doxygen.html#doxygen-best-practices" rel="noreferrer" target="_blank">https://docs.rtems.org/branches/master/eng/coding-doxygen.html#doxygen-best-practices</a><br>
<br></blockquote><div><br></div><div>Is there going to be a global replacement or have they been purged?</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
How should we indicate that not a particular value is returned, but <br>
instead an element of a set. For example:<br>
<br>
/**<br>
  * @brief Performs something and returns the operation status.<br>
  *<br>
  * @retval 0 Successful operation.<br>
  * @retval EIO Input/output error.<br>
  * @retval <otherwise> Any other value will not be returned.<br>
  */<br>
int f(void);<br></blockquote><div><br></div><div>That last @retval doesn't match what I thought your statement above indicated.</div><div>The English on the last @retval say there are no more. Why even include that?</div><div><br></div><div>If you mean other errno's may be returned, that's different.</div><div><br></div><div>What about the -1 and errno cases? </div><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
/**<br>
  * @brief Creates an object.<br>
  *<br>
  * @retval NULL Not enough resources to create an object.<br>
  * @retval <object> Pointer to created object.<br>
  */<br>
T *create(void);<br>
<br>
We may also use "[object]" or "{object}" or "object" or whatever.<br></blockquote><div><br></div><div>Can we use "instance of T"?</div><div><br></div><div>I assume you used object generically. Wouldn't it be the specific noun for the created object? </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
-- <br>
Sebastian Huber, embedded brains GmbH<br>
<br>
Address : Dornierstr. 4, D-82178 Puchheim, Germany<br>
Phone   : +49 89 189 47 41-16<br>
Fax     : +49 89 189 47 41-09<br>
E-Mail  : <a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brains.de</a><br>
PGP     : Public key available on request.<br>
<br>
Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.<br>
<br>
_______________________________________________<br>
devel mailing list<br>
<a href="mailto:devel@rtems.org" target="_blank">devel@rtems.org</a><br>
<a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.rtems.org/mailman/listinfo/devel</a></blockquote></div></div>