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

Author Topic: Doxygen Warnings  (Read 3088 times)

0 Members and 1 Guest are viewing this topic.

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 10818
    • View Profile
    • development blog
    • Email
Doxygen Warnings
« on: April 09, 2014, 09:53:37 pm »
While going over warnings and errors with the 3DEE version, I noticed that some of the warnings from Doxygen were from the original SFML version, so I thought it might be useful to provide them here. Not sure if they should all get fixed.

Warning: Tag `SYMBOL_CACHE_SIZE' at line 299 of file doc/doxyfile has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

Warning: Tag `SHOW_DIRECTORIES' at line 483 of file doc/doxyfile has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

Warning: Tag `HTML_ALIGN_MEMBERS' at line 808 of file doc/doxyfile has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

Warning: doxygen no longer ships with the FreeSans font.
You may want to clear or change DOT_FONTNAME.
Otherwise you run the risk that the wrong font is being used for dot generated graphs.

include/SFML/Graphics/Rect.hpp:187: warning: include file SFML/Graphics/Rect.inl not found, perhaps you forgot to add its directory to INCLUDE_PATH?
include/SFML/System/String.hpp:613: warning: include file SFML/System/String.inl not found, perhaps you forgot to add its directory to INCLUDE_PATH?
include/SFML/System/Thread.hpp:193: warning: include file SFML/System/Thread.inl not found, perhaps you forgot to add its directory to INCLUDE_PATH?
include/SFML/System/Utf.hpp:731: warning: include file SFML/System/Utf.inl not found, perhaps you forgot to add its directory to INCLUDE_PATH?
include/SFML/System/Vector2.hpp:250: warning: include file SFML/System/Vector2.inl not found, perhaps you forgot to add its directory to INCLUDE_PATH?
include/SFML/System/Vector3.hpp:252: warning: include file SFML/System/Vector3.inl not found, perhaps you forgot to add its directory to INCLUDE_PATH?

include/SFML/Network/Packet.hpp:178: warning: Member operator>>(Int8 &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:179: warning: Member operator>>(Uint8 &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:180: warning: Member operator>>(Int16 &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:181: warning: Member operator>>(Uint16 &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:182: warning: Member operator>>(Int32 &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:183: warning: Member operator>>(Uint32 &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:184: warning: Member operator>>(float &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:185: warning: Member operator>>(double &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:186: warning: Member operator>>(char *data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:187: warning: Member operator>>(std::string &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:188: warning: Member operator>>(wchar_t *data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:189: warning: Member operator>>(std::wstring &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:190: warning: Member operator>>(String &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:197: warning: Member operator<<(Int8 data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:198: warning: Member operator<<(Uint8 data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:199: warning: Member operator<<(Int16 data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:200: warning: Member operator<<(Uint16 data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:201: warning: Member operator<<(Int32 data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:202: warning: Member operator<<(Uint32 data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:203: warning: Member operator<<(float data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:204: warning: Member operator<<(double data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:205: warning: Member operator<<(const char *data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:206: warning: Member operator<<(const std::string &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:207: warning: Member operator<<(const wchar_t *data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:208: warning: Member operator<<(const std::wstring &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:209: warning: Member operator<<(const String &data) (function) of class sf::Packet is not documented.
include/SFML/Network/Packet.hpp:192: warning: parameters of member sf::Packet::operator<< are not (all) documented
include/SFML/Network/Packet.hpp:192: warning: return type of member sf::Packet::operator<< is not documented
include/SFML/Network/Packet.hpp:173: warning: parameters of member sf::Packet::operator>> are not (all) documented
include/SFML/Network/Packet.hpp:173: warning: return type of member sf::Packet::operator>> is not documented
<@3>:1: warning: parameters of member sf::UdpSocket::@3 are not (all) documented
Official FAQ: https://www.sfml-dev.org/faq.php
Official Discord Server: https://discord.gg/nr4X7Fh
——————————————————————
Dev Blog: https://duerrenberger.dev/blog/

Jesper Juhl

  • Hero Member
  • *****
  • Posts: 1405
    • View Profile
    • Email
Re: Doxygen Warnings
« Reply #1 on: April 09, 2014, 09:58:13 pm »
By the way; clang - with the -Wdocumentation option, can also be used to do some basic checking of doc comments :)

Nexus

  • SFML Team
  • Hero Member
  • *****
  • Posts: 6286
  • Thor Developer
    • View Profile
    • Bromeon
Re: Doxygen Warnings
« Reply #2 on: April 09, 2014, 10:19:51 pm »
I recently fixed quite a few of them, but I didn't want to update the Doxyfile -- if that leads to a loss of compatibility with older Doxygen versions, then I prefer warnings.

The warnings for << and >> appear because not every single member function is documented. I don't think it makes sense to duplicate the obvious descriptions for every operator. About UdpSocket, that @3 seems to refer to an inner type, but I have not found out what exactly the problem was. The .inl warnings were the reason why I excluded file extensions other than .hpp, no idea why it doesn't work at you...
Zloxx II: action platformer
Thor Library: particle systems, animations, dot products, ...
SFML Game Development: