SFML community forums

General => SFML website => Topic started by: Jalfor on October 04, 2012, 08:46:25 am

Title: Missing 'sf::' in Documentation
Post by: Jalfor on October 04, 2012, 08:46:25 am
In the example in http://www.sfml-dev.org/documentation/2.0/classsf_1_1Drawable.php I think
virtual void draw(sf::RenderTarget& target, RenderStates states) const
should be
virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const
That's all  ;)
Title: Re: Missing 'sf::' in Documentation
Post by: FRex on October 04, 2012, 11:56:36 am
Documentation isn't really top notch possibly because sfml 2.0 is rc, but it's not extremely misleading. Off the top of my head I remember that sleep function is kind of.. hard to find ??? Unless you spot it's header among hpp files or see it mentioned in tutorial or something, keyboard hpp on site is old so it(and documentation generated from it) is missing 'unknown' key.
Title: Re: Missing 'sf::' in Documentation
Post by: Laurent on October 04, 2012, 12:05:46 pm
Quote
Documentation isn't really top notch possibly because sfml 2.0 is rc
Nop, the documentation is complete, so this kind of minor correction is relevant ;)

Quote
Off the top of my head I remember that sleep function is kind of.. hard to find
It's easy to find in the "Module" section. Since all other sections are indexed by class, it's indeed hard to find there.
Title: Re: Missing 'sf::' in Documentation
Post by: eXpl0it3r on October 04, 2012, 12:12:01 pm
Documentation isn't really top notch possibly because sfml 2.0 is rc, but it's not extremely misleading. Off the top of my head I remember that sleep function is kind of.. hard to find ??? Unless you spot it's header among hpp files or see it mentioned in tutorial or something, keyboard hpp on site is old so it(and documentation generated from it) is missing 'unknown' key.
And you wanted to say with that want exactly? ???
Yes the online documentation is mostly outdated and if you need it then check the BUILD_DOC in the CMake process, or build it manually. ;)
As for the hard to find thongs, well Doxygen is the generator in use which creates the documentation automatically. So to get functions to show better one would probavly have to create a custom site...

Btw already fixed (https://github.com/SFML/SFML/blob/master/include/SFML/Graphics/Drawable.hpp#L103)
Title: Re: Missing 'sf::' in Documentation
Post by: FRex on October 04, 2012, 01:14:32 pm
http://www.sfml-dev.org/documentation/2.0/classsf_1_1Keyboard.php#acb4cacd7cc5802dec45724cf3314a142
Uknown key is still missing.
Quote
And you wanted to say with that want exactly?
Yes the online documentation is mostly outdated and if you need it then check the BUILD_DOC in the CMake process, or build it manually.
That the amount of changes to sfml like changing setTexture behaviour, adding unknown key ect. make it so docs can fall behind and it's to be expected out of rc version. It's not like it's already  'Director's cut super extended edition SFML-aurent DELUXE 2.0' so obviosuly docs will get fixed and tutorials written some time in the future so it's not to be worried about.
Title: Re: Missing 'sf::' in Documentation
Post by: Laurent on October 04, 2012, 01:56:35 pm
Quote
Uknown key is still missing.
The doc has not been uploaded since RC, which doesn't mean that things are not already fixed in sources.

Quote
so obviosuly docs will get fixed
I insist: the doc is not broken and doesn't need to be fixed (except the minor corrections that are reported sometimes), it just doesn't match one's particular version of SFML 2 (it currently matches the RC).
If you build SFML, build the doc too (sounds quite obvious :P).