SFML community forums

General => General discussions => Topic started by: jokoon on March 15, 2014, 10:44:06 am

Title: About the documentation
Post by: jokoon 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...

Title: Re: About the documentation
Post by: eXpl0it3r 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). ;)

Title: Re: About the documentation
Post by: jokoon on March 15, 2014, 12:22:43 pm

yeah you're right, sorry !