Ticket #46085

CodingStyle: New function headers with doxygen parameter documentation

Eröffnet am: 2022-11-21 14:58 Letztes Update: 2023-04-28 07:52

Auswertung:
Verantwortlicher:
Typ:
Status:
Geschlossen
Komponente:
Meilenstein:
Priorität:
5 - Mittel
Schweregrad:
5 - Mittel
Lösung:
Gefixt
Datei:
1

Details

Would it be time to start adding doxygen @param and @return documentation to any new function headers (which are already mandatory) when we start 3.3 cycle? That's to be stated on CodingStyle.

Ticket-Verlauf (3/4 Historien)

2022-11-21 14:58 Aktualisiert von: cazfi
  • New Ticket "CodingStyle: New function headers with doxygen parameter documentation" created
2023-04-23 10:42 Aktualisiert von: cazfi
  • Verantwortlicher Update from (Keine) to cazfi
  • Lösung Update from Keine to Accepted
Kommentar

Attached patch recommends those tags to new function headers, but does not make it mandatory. I've been adding them to some new functions, but have not felt like doing it for all of them when most of our really important functions are missing them in any case.

2023-04-28 07:52 Aktualisiert von: cazfi
  • Status Update from Offen to Geschlossen
  • Lösung Update from Accepted to Gefixt

Bearbeiten

Please login to add comment to this ticket » Anmelden