Welcome, Guest. Please login or register. Did you miss your activation email?
Pages: [1]

Author Topic: About the documentation  (Read 3422 times)

0 Members and 1 Guest are viewing this topic.

jokoon

  • Newbie
  • *
  • Posts: 35
    • View Profile
About the documentation
« on: March 15, 2014, 10:44:06 am »
I don't want to sound whiny, but why isn't there any downloadable API doc ? I found myself several times without internet, so no doxygen and going through the source code.

I know I could do it myself, but why not provide it in the zip packages ? Would save devs some time...

Logged

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 11034
    • View Profile
    • development blog
    • Email
Re: About the documentation
« Reply #1 on: March 15, 2014, 11:12:11 am »
Not sure what you're talking about. The SDK packages contain both the plain HTML output and the "compiled" HTML file (.chm) in the doc directory.
If you're talking about the source code from GitHub itself, yes then you have to generate it yourself by simply installing DoxyGen and then choosing the right CMake settings. That the source code doesn't ship with the generated docs make sense, otherwise they'd need to be regenerated for every commit (including pull request etc). ;)
Logged
Official FAQ: https://www.sfml-dev.org/faq.php
Official Discord Server: https://discord.gg/nr4X7Fh
——————————————————————
Dev Blog: https://duerrenberger.dev/blog/

jokoon

  • Newbie
  • *
  • Posts: 35
    • View Profile
Re: About the documentation
« Reply #2 on: March 15, 2014, 12:22:43 pm »
yeah you're right, sorry !
Logged
Pages: [1]