doxygen \retval mit eigenem Paragraphtitel
-
Ich moechte Rueckgabewerte im Fehlerfall im eigenen Absatz documentieren. Vorbild sind die man-pages wie in:
ERRORS EINVAL description ... EBUSY description ...
Benutzt und formatiert soll das ganze wie mit \retval werden. Beispiel
\errorval -1 unavailable on friday \errorval -2 you are too tall
Fragen: Wie veraendere ich \retval projektspezifisch oder wie sieht der benutzerdefinierte Befehl/Alias aus? Gibt es Alternativen.
-
Nun gut, habe Create new custom command that ... befolgt und folgendes als ALIASES hinzugefuegt:
errors=<dl class="retval"><dt>Errors</dt><dd><table class="retval"> error{2}=<tr><td class="paramname">\1</td><td>\2</td></tr> enderrors=</table></dd></dl>
Es produziert genau das, was ich will. Leider ist die Benutzung mit Klamern unschoen und es ist auf HTML beschraenkt. Schade, dachte doxygen bietet mehr.
\errors \error{-1, line width is too big} \error{-2, buffer to small for header and line section} \enderrors