CodingStyle: New function headers with doxygen parameter documentation

• Rapporteur: cazfi
• Propriétaire: cazfi
• Type: Patches
• État: Atteints
• Composant: Documentation
• Jalon: 3.3.0
• Priorité: 5 - moyen
• Sévérité: 5 - moyen
• Résolution: Fixed
• Fichier: 1

Détails

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 History (3/4 Histories)

2022-11-21 14:58 Updated by: cazfi

• New Ticket "CodingStyle: New function headers with doxygen parameter documentation" created

2023-04-23 10:38 Updated by: cazfi

• File 0035-CodingStyle-Recommend-doxygen-tags-param-and-return.patch (File ID: 12266) is attached

2023-04-23 10:42 Updated by: cazfi

• Propriétaire Update from (Aucun) to cazfi
• Résolution Update from Aucun to Accepted

Commentaire

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 Updated by: cazfi

• État Update from Ouvert to Atteints
• Résolution Update from Accepted to Fixed