diff --git a/include/osg/Drawable b/include/osg/Drawable index 935ae0e78..2ae458f54 100644 --- a/include/osg/Drawable +++ b/include/osg/Drawable @@ -306,7 +306,7 @@ class OSG_EXPORT Drawable : public Node * must be implemented in concrete subclasses of the Drawable base class, examples include osg::Geometry and osg::ShapeDrawable. * drawImplementation(RenderInfo&) is called from the draw(RenderInfo&) method, with the draw method handling management of OpenGL display lists, * and drawImplementation(RenderInfo&) handling the actual drawing itself. - * @param renderInfo The osg::RenderInfo object that encapsulates the current rendering information including the osg::State OpenGL state for the current graphics context. */ + * renderInfo : The osg::RenderInfo object that encapsulates the current rendering information including the osg::State OpenGL state for the current graphics context. */ virtual void drawImplementation(RenderInfo& /*renderInfo*/) const {} diff --git a/include/osg/PrimitiveSet b/include/osg/PrimitiveSet index f3893647b..b281c2ba5 100644 --- a/include/osg/PrimitiveSet +++ b/include/osg/PrimitiveSet @@ -418,13 +418,17 @@ class OSG_EXPORT DrawElementsUByte : public DrawElements, public VectorGLubyte vector_type(array) {} /** + * \param mode One of osg::PrimitiveSet::Mode. Determines the type of primitives used. * \param no Number of intended elements. This will be the size of the underlying vector. + * \param ptr Pointer to a GLubyte to copy index data from. + * \param numInstances When non zero passed as the number of draw instances to use re. */ DrawElementsUByte(GLenum mode, unsigned int no, const GLubyte* ptr, int numInstances=0) : DrawElements(DrawElementsUBytePrimitiveType,mode,numInstances), vector_type(ptr,ptr+no) {} /** + * \param mode One of osg::PrimitiveSet::Mode. Determines the type of primitives used. * \param no Number of intended elements. This will be the size of the underlying vector. */ DrawElementsUByte(GLenum mode, unsigned int no) : @@ -477,13 +481,17 @@ class OSG_EXPORT DrawElementsUShort : public DrawElements, public VectorGLushort vector_type(array) {} /** + * \param mode One of osg::PrimitiveSet::Mode. Determines the type of primitives used. * \param no Number of intended elements. This will be the size of the underlying vector. + * \param ptr Pointer to a GLushort to copy index data from. + * \param numInstances When non zero passed as the number of draw instances to use re. */ DrawElementsUShort(GLenum mode, unsigned int no, const GLushort* ptr, int numInstances=0) : DrawElements(DrawElementsUShortPrimitiveType,mode,numInstances), vector_type(ptr,ptr+no) {} /** + * \param mode One of osg::PrimitiveSet::Mode. Determines the type of primitives used. * \param no Number of intended elements. This will be the size of the underlying vector. */ DrawElementsUShort(GLenum mode, unsigned int no) : @@ -542,12 +550,15 @@ class OSG_EXPORT DrawElementsUInt : public DrawElements, public VectorGLuint /** * \param mode One of osg::PrimitiveSet::Mode. Determines the type of primitives used. * \param no Number of intended elements. This will be the size of the underlying vector. + * \param ptr Pointer to a GLuint to copy index data from. + * \param numInstances When non zero passed as the number of draw instances to use re. */ DrawElementsUInt(GLenum mode, unsigned int no, const GLuint* ptr, int numInstances=0) : DrawElements(DrawElementsUIntPrimitiveType,mode,numInstances), vector_type(ptr,ptr+no) {} /** + * \param mode One of osg::PrimitiveSet::Mode. Determines the type of primitives used. * \param no Number of intended elements. This will be the size of the underlying vector. */ DrawElementsUInt(GLenum mode, unsigned int no) : diff --git a/include/osg/Program b/include/osg/Program index 7c2525a17..36aa7ed2f 100644 --- a/include/osg/Program +++ b/include/osg/Program @@ -180,7 +180,7 @@ class OSG_EXPORT Program : public osg::StateAttribute META_Object(osg, ProgramBinary); - /** Allocated a data buffer of specified size/*/ + /** Allocated a data buffer of specified size.*/ void allocate(unsigned int size); /** Assign program binary data, copying the specified data into locally stored data buffer, the original data can then be deleted.*/ diff --git a/include/osg/Shader b/include/osg/Shader index c24229134..fdfbc3f7e 100644 --- a/include/osg/Shader +++ b/include/osg/Shader @@ -49,7 +49,7 @@ class OSG_EXPORT ShaderBinary : public osg::Object META_Object(osg, ShaderBinary); - /** Allocated a data buffer of specified size/*/ + /** Allocated a data buffer of specified size.*/ void allocate(unsigned int size); /** Assign shader binary data, copying the specified data into locally stored data buffer, the original data can then be deleted.*/ @@ -321,7 +321,7 @@ class OSG_EXPORT ShaderComponent : public osg::Object ShaderComponent(); ShaderComponent(const ShaderComponent& sc,const CopyOp& copyop=CopyOp::SHALLOW_COPY); - META_Object(osg, ShaderComponent) + META_Object(osg, ShaderComponent); unsigned int addShader(osg::Shader* shader); void removeShader(unsigned int i); diff --git a/include/osg/ShaderComposer b/include/osg/ShaderComposer index 68c6d6c39..c8f88d4c6 100644 --- a/include/osg/ShaderComposer +++ b/include/osg/ShaderComposer @@ -31,7 +31,7 @@ class OSG_EXPORT ShaderComposer : public osg::Object ShaderComposer(); ShaderComposer(const ShaderComposer& sa,const CopyOp& copyop=CopyOp::SHALLOW_COPY); - META_Object(osg, ShaderComposer) + META_Object(osg, ShaderComposer); virtual osg::Program* getOrCreateProgram(const ShaderComponents& shaderComponents); diff --git a/include/osg/State b/include/osg/State index 131bd91ca..f3a098a30 100644 --- a/include/osg/State +++ b/include/osg/State @@ -207,7 +207,7 @@ class OSG_EXPORT State : public Referenced /** Get the unform list in which to inject any uniforms that StateAttribute::apply(State&) methods provide.*/ StateSet::UniformList& getCurrentShaderCompositionUniformList() { return _currentShaderCompositionUniformList; } - /** Convenience method for StateAttribute:::apply(State&) methods to pass on their uniforms to osg::State so it can apply them at the appropriate point.*/ + /** Convenience method for StateAttribute::apply(State&) methods to pass on their uniforms to osg::State so it can apply them at the appropriate point.*/ void applyShaderCompositionUniform(const osg::Uniform* uniform, StateAttribute::OverrideValue value=StateAttribute::ON) { StateSet::RefUniformPair& up = _currentShaderCompositionUniformList[uniform->getName()]; @@ -1493,7 +1493,7 @@ class OSG_EXPORT State : public Referenced /** print out the internal details of osg::State - useful for debugging.*/ void print(std::ostream& fout) const; - /** Initialize extension used by osg:::State.*/ + /** Initialize extension used by osg::State.*/ void initializeExtensionProcs(); /** Get the GL adapter object used to map OpenGL 1.0 glBegin/glEnd usage to vertex arrays.*/ diff --git a/include/osg/StateSet b/include/osg/StateSet index 4213852d0..6a7b204f0 100644 --- a/include/osg/StateSet +++ b/include/osg/StateSet @@ -337,10 +337,10 @@ class OSG_EXPORT StateSet : public Object typedef std::pair DefinePair; typedef std::map DefineList; - /** Added define pass on to shaders that use utilize that define, as specified by the GLSL #pragma import_defines(..) and #pragma requires(..). */ + /** Added define pass on to shaders that use utilize that define, as specified by the GLSL \#pragma import_defines(..) and \#pragma requires(..). */ void setDefine(const std::string& defineName, StateAttribute::OverrideValue value=StateAttribute::ON); - /** Added define with value to pass on to shaders that use utilize that define, as specified by the GLSL #pragma import_defines(..) and #pragma requires(..). */ + /** Added define with value to pass on to shaders that use utilize that define, as specified by the GLSL \#pragma import_defines(..) and \#pragma requires(..). */ void setDefine(const std::string& defineName, const std::string& defineValue, StateAttribute::OverrideValue value=StateAttribute::ON); DefinePair* getDefinePair(const std::string& defineName) { DefineList::iterator itr = _defineList.find(defineName); return (itr!=_defineList.end()) ? &(itr->second) : 0; } diff --git a/include/osg/Transform b/include/osg/Transform index f8f20ce47..9fd1fdd8f 100644 --- a/include/osg/Transform +++ b/include/osg/Transform @@ -59,7 +59,7 @@ extern OSG_EXPORT Matrix computeEyeToLocal(const Matrix& modelview, const NodePa * Transform itself does not provide set/get functions, only the interface * for defining what the 4x4 transformation is. Subclasses, such as * MatrixTransform and PositionAttitudeTransform support the use of an - * osg::Matrix or a osg::Vec3/osg::Quat respectively. + * osg::Matrix or a Vec3 and Quat respectively. * * Note: If the transformation matrix scales the subgraph then the normals * of the underlying geometry will need to be renormalized to be unit diff --git a/include/osg/ValueMap b/include/osg/ValueMap index 9b9cd1728..29687d9f0 100644 --- a/include/osg/ValueMap +++ b/include/osg/ValueMap @@ -30,7 +30,7 @@ class OSG_EXPORT ValueMap : public osg::Object ValueMap(const ValueMap& vm, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY); - META_Object(osg, ValueMap) + META_Object(osg, ValueMap); typedef std::map< osg::ref_ptr, osg::ref_ptr > KeyValueMap; diff --git a/include/osg/ValueStack b/include/osg/ValueStack index b180f3b03..ac567d669 100644 --- a/include/osg/ValueStack +++ b/include/osg/ValueStack @@ -28,7 +28,7 @@ class OSG_EXPORT ValueStack : public osg::Object ValueStack(const ValueStack& ps, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY); - META_Object(osg, ValueStack) + META_Object(osg, ValueStack); typedef std::vector< osg::ref_ptr > Values; typedef std::map< osg::ref_ptr, Values> ValueStackMap; diff --git a/include/osgDB/DatabasePager b/include/osgDB/DatabasePager index 8bd9954e4..8ad4f5033 100644 --- a/include/osgDB/DatabasePager +++ b/include/osgDB/DatabasePager @@ -219,7 +219,7 @@ class OSGDB_EXPORT DatabasePager : public osg::NodeVisitor::DatabaseRequestHandl /** Set whether newly loaded textures should have a PixelBufferObject assigned to them to aid download to the GPU.*/ void setApplyPBOToImages(bool assignPBOToImages) { _assignPBOToImages = assignPBOToImages; } - /** Get whether newly loaded textures should have a PixelBufferObject assigned to them..*/ + /** Get whether newly loaded textures should have a PixelBufferObject assigned to them.*/ bool getApplyPBOToImages() const { return _assignPBOToImages; } diff --git a/include/osgDB/DatabaseRevisions b/include/osgDB/DatabaseRevisions index d0df00976..ee8184d58 100644 --- a/include/osgDB/DatabaseRevisions +++ b/include/osgDB/DatabaseRevisions @@ -29,7 +29,7 @@ class OSGDB_EXPORT FileList : public osg::Object FileList(); FileList(const FileList& fileList, const osg::CopyOp & copyop=osg::CopyOp::SHALLOW_COPY); - META_Object(osgDB, FileList) + META_Object(osgDB, FileList); typedef std::set FileNames; FileNames& getFileNames() { return _files; } @@ -101,7 +101,7 @@ class OSGDB_EXPORT DatabaseRevisions : public osg::Object DatabaseRevisions(); DatabaseRevisions(const DatabaseRevisions& revisions, const osg::CopyOp & copyop=osg::CopyOp::SHALLOW_COPY); - META_Object(osgDB, DatabaseRevisions) + META_Object(osgDB, DatabaseRevisions); typedef std::vector< osg::ref_ptr > DatabaseRevisionList; diff --git a/include/osgManipulator/Dragger b/include/osgManipulator/Dragger index 7b3888dac..14cc5dede 100644 --- a/include/osgManipulator/Dragger +++ b/include/osgManipulator/Dragger @@ -196,7 +196,7 @@ class OSGMANIPULATOR_EXPORT Dragger : public osg::MatrixTransform public: - META_Node(osgManipulator,Dragger) + META_Node(osgManipulator,Dragger); /** * Set/Get parent dragger. For simple draggers parent points to itself. @@ -314,7 +314,7 @@ class OSGMANIPULATOR_EXPORT CompositeDragger : public Dragger { public: - META_Node(osgManipulator,CompositeDragger) + META_Node(osgManipulator,CompositeDragger); typedef std::vector< osg::ref_ptr > DraggerList; diff --git a/include/osgManipulator/Translate1DDragger b/include/osgManipulator/Translate1DDragger index eefa70c3a..0786d4dd2 100644 --- a/include/osgManipulator/Translate1DDragger +++ b/include/osgManipulator/Translate1DDragger @@ -30,7 +30,7 @@ class OSGMANIPULATOR_EXPORT Translate1DDragger : public Dragger Translate1DDragger(); - META_OSGMANIPULATOR_Object(osgManipulator,Translate1DDragger) + META_OSGMANIPULATOR_Object(osgManipulator,Translate1DDragger); Translate1DDragger(const osg::Vec3d& s, const osg::Vec3d& e); diff --git a/include/osgShadow/MinimalDrawBoundsShadowMap b/include/osgShadow/MinimalDrawBoundsShadowMap index 8fae4e0be..1796d7018 100644 --- a/include/osgShadow/MinimalDrawBoundsShadowMap +++ b/include/osgShadow/MinimalDrawBoundsShadowMap @@ -83,7 +83,7 @@ class OSGSHADOW_EXPORT MinimalDrawBoundsShadowMap friend struct ViewData; - META_ViewDependentShadowTechniqueData( ThisClass, ThisClass::ViewData ) + META_ViewDependentShadowTechniqueData( ThisClass, ThisClass::ViewData ); struct CameraPostDrawCallback : public osg::Camera::DrawCallback { diff --git a/include/osgSim/SphereSegment b/include/osgSim/SphereSegment index d41f41f0e..905115995 100644 --- a/include/osgSim/SphereSegment +++ b/include/osgSim/SphereSegment @@ -89,7 +89,7 @@ public: /** Construct by angle ranges. Note that the azimuth 'zero' is the Y axis; specifying - an azimuth range from azMin -osg::PI/2.0f to azMax osg::PI/2.0f will cover the + an azimuth range from azMin -PI/2.0f to azMax PI/2.0f will cover the 'top half' of the circle in the XY plane. The elev angles are 'out' of the 'zero' XY plane with +ve angles above the plane, and -ve angles below. @param centre sphere centre diff --git a/include/osgTerrain/Layer b/include/osgTerrain/Layer index 5a17e9f00..e4c5eb464 100644 --- a/include/osgTerrain/Layer +++ b/include/osgTerrain/Layer @@ -118,9 +118,9 @@ class OSGTERRAIN_EXPORT Layer : public osg::Object /** * Get the layer value at position i,j. - * @param[in] i X-axis (or column) index. - * @param[in] j Y-axis (or row) index. - * @param[out] value Returned layer value. + * param i X-axis (or column) index. + * param j Y-axis (or row) index. + * param value Returned layer value. * @return true if value is valid, else false */ virtual bool getValue(unsigned int /*i*/, unsigned int /*j*/, float& /*value*/) const { return false; } diff --git a/include/osgText/Style b/include/osgText/Style index b2ca5a3e2..34b4a3b9a 100644 --- a/include/osgText/Style +++ b/include/osgText/Style @@ -42,7 +42,7 @@ class OSGTEXT_EXPORT Bevel : public osg::Object void setSmoothConcaveJunctions(bool flag) { _smoothConcaveJunctions = flag; } bool getSmoothConcaveJunctions() const { return _smoothConcaveJunctions; } - + void setBevelThickness(float thickness) { _thickness = thickness; } float getBevelThickness() const { return _thickness; } @@ -75,7 +75,7 @@ class OSGTEXT_EXPORT Style : public osg::Object Style(); Style(const Style& style, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY); - META_Object(osgText, Style) + META_Object(osgText, Style); /// default Layout implementation used if no other is specified on TextNode static osg::ref_ptr