[openssl/technical-policies] df1d25: Add Doxygen comment requirement to coding style

[Tomáš Mráz]

  Branch: refs/heads/master
  Home:   https://github.com/openssl/technical-policies
  Commit: df1d254ef3038c0b16f62b5523adbc0c961a8899
      https://github.com/openssl/technical-policies/commit/df1d254ef3038c0b16f62b5523adbc0c961a8899
  Author: Neil Horman <nhorman at openssl.org>
  Date:   2024-07-02 (Tue, 02 Jul 2024)

  Changed paths:
    M policies/coding-style.md

  Log Message:
  -----------
  Add Doxygen comment requirement to coding style

In an effort to better document our code in such a way that is condusive
to future developers getting involved with our code base, I thought I
would propose adding a requirement to our coding style that
structures/macros/functions/etc should have Doxygen style comments added
to them, so that we could build alternate docs directly from our source
base.


  Commit: dad084fb8f165d9569167b515ecef13297850cd5
      https://github.com/openssl/technical-policies/commit/dad084fb8f165d9569167b515ecef13297850cd5
  Author: Neil Horman <nhorman at openssl.org>
  Date:   2024-07-02 (Tue, 02 Jul 2024)

  Changed paths:
    M policies/coding-style.md

  Log Message:
  -----------
  Update Doxygen coding style with guidance examples


  Commit: b4c7630ee19b0802fdabd4df74a144db50bd5563
      https://github.com/openssl/technical-policies/commit/b4c7630ee19b0802fdabd4df74a144db50bd5563
  Author: Tomas Mraz <tomas at openssl.org>
  Date:   2024-07-02 (Tue, 02 Jul 2024)

  Changed paths:
    A votes/vote-20240618-coding-style-doxygen.txt

  Log Message:
  -----------
  Add vote on adding Doxygen in Coding style


Compare: https://github.com/openssl/technical-policies/compare/b08825a0d981...b4c7630ee19b

To unsubscribe from these emails, change your notification settings at https://github.com/openssl/technical-policies/settings/notifications