[Papercut] List of inaccuracies and bugs of documentation

Description

Original list (in Russian) (updates periodically).
Line and revision column corresponds branch default.
My English not so good, therefore in advance excuse.

File

Line

Description

Revision

./ogre/OgreMain/include/OgreAxisAlignedBox.h

300

Describes static member, but there no any static members

4580

./ogre/OgreMain/include/OgreBillboard.h

167

Error in description of return value of getOwnHeight: width instead of height

4580

./ogre/OgreMain/include/OgreBillboardChain.h

63

Not closed bracket? opened on previous line

?

./ogre/OgreMain/include/OgreBillboardChain.h

347

Comment isn't documenting

?

./ogre/OgreMain/include/OgreBillboardParticleRenderer.h

161

Error in description getBillboardRotationType: Set instad of Get

4580

./ogre/OgreMain/include/OgreBillboardSet.h

145

Comment isn't documenting

?

./ogre/OgreMain/include/OgreCamera.h

139

Description of mVisBatchesLastRender copied from mVisFacesLastRender, faces must be replaced with batches

4580

./ogre/OgreMain/include/OgreCamera.h

150

mSceneLodFactor: Comment isn't documenting

4580

./ogre/OgreMain/include/OgreCamera.h

165

mRecalcWindow: Comment isn't documenting

4580

./ogre/OgreMain/include/OgreCamera.h

268

getDirection: Comment isn't documenting

4580

./ogre/OgreMain/include/OgreCamera.h

463

setLodCamera: Get instead of Set

4580

./ogre/OgreMain/include/OgreCamera.h

654

setUseMinPixelSize: Strange comment about concrete value, but function set only flag

4580

./ogre/OgreMain/include/OgreCodec.h

145

Strange comment about different arguments count, but function has only one

4580

./ogre/OgreMain/include/OgreCommon.h

105

Description Ogre::FilterOptions::FO_NONE: FILT_MIP instead of FT_MIP

4580

./ogre/OgreMain/include/OgreCompositionPass.h

57-61

Members of CompositionPass:assType: Comments isn't documenting

4580

./ogre/OgreMain/include/OgreCompositionPass.h

349

mCustomType: Comment isn't documenting

4580

./ogre/OgreMain/include/OgreCompositionTargetPass.h

55-56

Members of CompositionTargetPass::InputMode: Comments isn't documenting

4580

./ogre/OgreMain/include/OgreCompositionTargetPass.h

152

mInputMode: word name instead of mode

4580

./ogre/OgreMain/include/OgreController.h

151

Strange remark on Controller::Controller(), about manual deleting

4660

./ogre/OgreMain/include/OgreControllerManager.h

70

mLastFrameNumber: Comments isn't documenting

4660

./ogre/OgreMain/include/OgreDataStream.h

185

mName: misprint fot his, maybe for his?

4660

./ogre/OgreMain/include/OgreDataStream.h

217

Strange comment to write: it's copied from read

4660

./ogre/OgreMain/include/OgreDataStream.h

334

MemoryDataStream constuctors: error in description of moment of release memory: not destroing stream, but when its closed

4660

./ogre/OgreMain/include/OgreDataStream.h

375

Parameter sourceStream: strange words weak reference -- there no any weak references

4660

./ogre/OgreMain/include/OgreDefaultHardwareBufferManager.h

155

DefaultHardwareBufferManagerBase(): unclosed bracket

4660

./ogre/OgreMain/include/OgreDefaultHardwareBufferManager.h

166

createIndexBuffer: vertex instead of index

4660

./ogre/OgreMain/include/OgreDeflate.h

75

init: strange comment

4660

./ogre/OgreMain/include/OgreDepthBuffer.h

48

Class DepthBuffer: misprint alltoghether

4660

./ogre/OgreMain/include/OgreDepthBuffer.h

49

Twice usage of only word

4660

./ogre/OgreMain/include/OgreDepthBuffer.h

96,100,108

Comments isn't documenting

4660

./ogre/OgreMain/include/OgreDepthBuffer.h

135

_notifyRenderTargetDetached: attached instead of detached

4660

./ogre/OgreMain/include/OgreDynLib.h

84

Class DynLib: strange comment about Resource

4660

./ogre/OgreMain/include/OgreEdgeListBuilder.h

65-67

Comments insige struct Triangle: Comments isn't documenting or comments belong to the wrong element -- use ///< notation

4660

./ogre/OgreMain/include/OgreEdgeListBuilder.h

86

TriangleFaceNormalList: Comment isn't documenting

4660

./ogre/OgreMain/include/OgreEdgeListBuilder.h

91

TriangleLightFacingList: Comment isn't documenting

4660

./ogre/OgreMain/include/OgreEdgeListBuilder.h

154

log: Comment isn't documenting

4660

./ogre/OgreMain/include/OgrePredefinedControllers.h

87

setValue: incorrect describe of algorithm real frame

4660

./ogre/OgreMain/include/OgrePredefinedControllers.h

97

TexCoordModifierControllerValue: misprint you ant instead of you want

4660

./ogre/OgreMain/include/OgrePredefinedControllers.h

149

mParamIndex: misprint to e instead of to be

4660

./ogre/OgreMain/include/OgrePredefinedControllers.h

177

PassthroughControllerFunction(): copied from AnimationControllerFunction()

4660

./ogre/Components/Property/include/OgreProperty.h

141

Comment isn't documenting

4580

./ogre/Components/Property/include/OgreProperty.h

369

Set instead of Get

4580

Environment

None

Assignee

M

Reporter

Mingun

Labels

Components

Fix versions

Priority

Minor
Configure