Welcome, Guest. Please login or register. Did you miss your activation email?

Author Topic: Is there an open issue in related to missing Doxygen tags  (Read 1309 times)

0 Members and 1 Guest are viewing this topic.

abdennour

  • Newbie
  • *
  • Posts: 2
    • View Profile
Is there an open issue in related to missing Doxygen tags
« on: June 01, 2023, 09:15:18 pm »
Hi there,

While reading parts of the source, I noticed missing doxygen tag \return in a [[nodiscard]] function.
I also found missing comments // namespace NAME (which does not follow the style recommended in https://www.sfml-dev.org/style.php).

I wanted to make the changes and send the pull-request, but I wanted to know first if these changes are important enough to make a patch? if its the case, does this require opening an issue on github first or is there a default issue for these changes ?

Thanks for your help.

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 10846
    • View Profile
    • development blog
    • Email
Re: Is there an open issue in related to missing Doxygen tags
« Reply #1 on: June 01, 2023, 09:22:31 pm »
Yeah, while they don't change anything on the functionality of the library, such changes are still important and highly appreciated. :)

They don't need an accompanying GitHub issue, since the fixes should be straight forward.
Official FAQ: https://www.sfml-dev.org/faq.php
Official Discord Server: https://discord.gg/nr4X7Fh
——————————————————————
Dev Blog: https://duerrenberger.dev/blog/

abdennour

  • Newbie
  • *
  • Posts: 2
    • View Profile
Re: Is there an open issue in related to missing Doxygen tags
« Reply #2 on: June 01, 2023, 09:34:13 pm »
Thank you for your response and clarification  :D.
I will proceed with making the necessary changes.

Once again, thank you for your help!