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

Author Topic: 1.6 symbols in 2.0 API documentation  (Read 4720 times)

0 Members and 1 Guest are viewing this topic.

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 10801
    • View Profile
    • development blog
    • Email
1.6 symbols in 2.0 API documentation
« on: August 23, 2012, 12:08:17 pm »
I've quickly searched through the header files and found a few symbols with the old naming conventions, so I thought I might as well share them... ;)

Sound.hpp:123 GetBuffer -> getBuffer
CircleShape.hpp:99 GetPointCount -> getPointCount
ConvexShape.hpp:85 GetPointCount -> getPointCount
ConvexShape.hpp:98 GetPointCount -> getPointCount
ConvexShape.hpp:81 SetPointCount -> setPointCount
RectangleShape.hpp:86 GetPointCount -> getPointCount
Shape.hpp:204 GetPointCount -> getPointCount
VertexArray.hpp:78 GetVertexCount -> getVertexCount
VertexArray.hpp:94 GetVertexCount -> getVertexCount
TcpSocket.hpp:230 GetRemotePort -> getRemotePort
Http.hpp:343 SetHost -> setHost
Http.hpp:376 SetHost -> setHost
SoundRecorder.hpp:218 IsAvailable -> isAvailable
VideoMode.hpp:204 IsValid -> isValid
 
The example in the Transformable.hpp could maybe also be adapted to follow the camelCase scheme. :)
« Last Edit: August 23, 2012, 12:11:43 pm by eXpl0it3r »
Official FAQ: https://www.sfml-dev.org/faq.php
Official Discord Server: https://discord.gg/nr4X7Fh
——————————————————————
Dev Blog: https://duerrenberger.dev/blog/

Hiura

  • SFML Team
  • Hero Member
  • *****
  • Posts: 4321
    • View Profile
    • Email
Re: 1.6 symbols in 2.0 API documentation
« Reply #1 on: August 23, 2012, 12:30:07 pm »
Thanks, I'll commit the modifications in a few minutes.  :)
SFML / OS X developer

Laurent

  • Administrator
  • Hero Member
  • *****
  • Posts: 32504
    • View Profile
    • SFML's website
    • Email
Re: 1.6 symbols in 2.0 API documentation
« Reply #2 on: August 23, 2012, 04:05:14 pm »
Oh nice, I knew there were such names remaining in the comments, but couldn't motivate me to read the entire doc to find them :D

Quote
The example in the Transformable.hpp could maybe also be adapted to follow the camelCase scheme
No:
Quote
It can also be used as a member, if you don't want to use its API directly (because you don't need all its functions, or you have different naming conventions for example).

Quote
Thanks, I'll commit the modifications in a few minutes.
Nice, thank you :)
Laurent Gomila - SFML developer

Hiura

  • SFML Team
  • Hero Member
  • *****
  • Posts: 4321
    • View Profile
    • Email
Re: 1.6 symbols in 2.0 API documentation
« Reply #3 on: August 23, 2012, 05:30:23 pm »
I went through the doc too and found some other typos. However, I might have missed some and I couldn't find any warning option for that.

Quote
The example in the Transformable.hpp could maybe also be adapted to follow the camelCase scheme
No
It seems I was too enthusiastic on that one.  ::)
(It's now fixed.)

Ho, and quick question for you Laurent : which version of doxygen do you use ? I've got some issues with mine (1.8.2), code is not indented as it should be (see attached screenshot of the main example).

[attachment deleted by admin]
SFML / OS X developer

Laurent

  • Administrator
  • Hero Member
  • *****
  • Posts: 32504
    • View Profile
    • SFML's website
    • Email
Re: 1.6 symbols in 2.0 API documentation
« Reply #4 on: August 23, 2012, 09:39:04 pm »
Quote
Ho, and quick question for you Laurent : which version of doxygen do you use ?
1.7.4. But if indentation doesn't work anymore with the new version, it should be fixed.
Laurent Gomila - SFML developer

Hiura

  • SFML Team
  • Hero Member
  • *****
  • Posts: 4321
    • View Profile
    • Email
Re: 1.6 symbols in 2.0 API documentation
« Reply #5 on: August 23, 2012, 10:39:22 pm »
It's not very documented but apparently if you use 1.8+ you have to use the new .css file. Now things are beautiful again! :)

Anyway, when we'll build the packages I'll use your version of the doc to keep things consistant.

[attachment deleted by admin]
SFML / OS X developer