Black list of erroneous/ misleading entries in doxygen docs

[paul424]

Here, I would put all the >>flowers<< from the doc's. Error's , mistypos , lacking information, etc...
For the purpose of feature improvement ....

1.

virtual Viewport* Ogre::RenderTarget::addViewport ...

Adds a viewport to the rendering target. ...

Parameters:
cam The camera from which the viewport contents will be rendered (mandatory)

It's not mandatory , it can be NULL . ( Ogre engine won't crash ).

2.

EdgeData * getEdgeList (void)
Define a default implementation of method from ShadowCaster which implements no shadows.
bool hasEdgeList (void)
Define a default implementation of method from ShadowCaster which implements no shadows.

Description does not match method declaration ( doxygen's script fault ? ) .

3.
From Viewport class : classOgre_1_1Viewport.html

void addListener (Listener *l)
Add a listener to this camera.

4. http://www.ogre3d.org/docs/api/html/cla ... f7a5579b9c

NO IDEA HOW TO DEDUCE DEFAULT CAMERA MEMBERS VALUE.
That is how it will be oriented or positioned with default ctor.
Neither the methods' nor the memebers' info give a clue.

[Zonder]

Issue pull requests with the fixed documentation.

[paul424]

HOW TO DEDUCE DEFAULT MEMBERS VALUE OF OBJECTS NOT SET IN CTOR IN OGRE ?


What does it mean issue pull request ? , Zonder ?

[masterfalcon]

I'll take care of these myself. But for future reference: http://www.ogre3d.org/developers/submit-patch

[paul424]

From the ChangeLog of Ogre 1 9 0

Loads of documentation updates

I go to the online docs . By links I get to http://www.ogre3d.org/docs/api/html/Ogr ... ource.html

54 namespace Ogre {
55 // Define ogre version
56 #define OGRE_VERSION_MAJOR 1
57 #define OGRE_VERSION_MINOR 8
58 #define OGRE_VERSION_PATCH 0
59 #define OGRE_VERSION_SUFFIX ""
60 #define OGRE_VERSION_NAME "Byatis"

BUAHAHA ! ( laugh through tears )

Could you just sort the docs versions like there is a link for every recent Ogre3d version , and link to it ?
http://www.ogre3d.org/docs/api/html/index.html Here, no info of which Ogre's version it does describe ... what a failure >_>

On my distro - OpenSuse 12.3 I got 1 9 0 with auto-update. I said ok , time to adapt my source code to newer version . Installed ogre-docs-1.9.0-1.1.x86_64.rpm , but Bang it's empty ! Looks like the maintainers just made dummy package as you didn't prepered anything :

rpm -ql ogre-docs-1.9.0-1.1.x86_64 gives:

/usr/share/OGRE/docs
/usr/share/OGRE/docs/CMakeLists.txt
/usr/share/OGRE/docs/ChangeLog.html
/usr/share/OGRE/docs/CodingStandards.html
/usr/share/OGRE/docs/License.html
/usr/share/OGRE/docs/ReadMe.html
/usr/share/OGRE/docs/api
/usr/share/OGRE/docs/licenses
/usr/share/OGRE/docs/licenses/bsd.txt
/usr/share/OGRE/docs/licenses/freeimage.txt
/usr/share/OGRE/docs/licenses/freetype.txt
/usr/share/OGRE/docs/licenses/libjpeg.txt
/usr/share/OGRE/docs/licenses/libmng.txt
/usr/share/OGRE/docs/licenses/libpng.txt
/usr/share/OGRE/docs/licenses/libtiff.txt
/usr/share/OGRE/docs/licenses/mit.txt
/usr/share/OGRE/docs/licenses/mpl.txt
/usr/share/OGRE/docs/licenses/nedmalloc_boost.txt
/usr/share/OGRE/docs/licenses/uiuc.txt
/usr/share/OGRE/docs/licenses/zlib.txt
/usr/share/OGRE/docs/ogre-logo-wetfloor.gif
/usr/share/OGRE/docs/ogre-logo.gif
/usr/share/OGRE/docs/shadows
/usr/share/OGRE/docs/shadows/OgreShadows.pdf
/usr/share/OGRE/docs/style.css

[c6burns]

BUAHAHA ! ( laugh through tears )

I had the same reaction to your post about media wiki and Jimmy Wales

The stable version only just recently was updated from 1-8 to 1-9 so to me it's not outlandish to see 1-8 up there. Why don't you build the doxygen docs yourself from source, then you will have the latest docs for the exact version you are using? There should be an OgreDoc build target after generating via cmake.

As far the contents of your distro packages, I think that's something to take up with the package maintainer ... or whatever the process for your distro is.

[spacegaier]

New up-to-date online API will become available in the next few days.

[spacegaier]

All taken care of: http://www.ogre3d.org/forums/viewtopic.php?f=27&t=79736