FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed doxygen warnings

Browse Source
This commit is contained in:
Robert Osfield 2016-06-01 14:20:14 +01:00
parent 99391a2cea
commit d3c6dc6f34
20 changed files with 38 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/osg/Drawable
View File

@ -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 {}

11
include/osg/PrimitiveSet
View File

@ -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) :

2
include/osg/Program
View File

@ -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.*/

4
include/osg/Shader
View File

@ -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);

2
include/osg/ShaderComposer
View File

@ -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);

4
include/osg/State
View File

@ -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.*/

4
include/osg/StateSet
View File

@ -337,10 +337,10 @@ class OSG_EXPORT StateSet : public Object
typedef std::pair<std::string, StateAttribute::OverrideValue> DefinePair;
typedef std::map<std::string, DefinePair> 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; }

2
include/osg/Transform
View File

@ -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

2
include/osg/ValueMap
View File

@ -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<const osg::Referenced>, osg::ref_ptr<osg::Object> > KeyValueMap;

2
include/osg/ValueStack
View File

@ -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<Object> > Values;
typedef std::map< osg::ref_ptr<const osg::Referenced>, Values> ValueStackMap;

2
include/osgDB/DatabasePager
View File

@ -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; }

4
include/osgDB/DatabaseRevisions
View File

@ -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<std::string> 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<DatabaseRevision> > DatabaseRevisionList;

4
include/osgManipulator/Dragger
View File

@ -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<Dragger> > DraggerList;

2
include/osgManipulator/Translate1DDragger
View File

@ -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);

2
include/osgShadow/MinimalDrawBoundsShadowMap
View File

@ -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 {

2
include/osgSim/SphereSegment
View File

@ -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

6
include/osgTerrain/Layer
View File

@ -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; }

2
include/osgText/Style
View File

@ -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<Style>& getDefaultStyle();

2
include/osgViewer/View
View File

@ -142,7 +142,7 @@ class OSGVIEWER_EXPORT View : public osg::View, public osgGA::GUIActionAdapter
template<class T> void addDevice(const osg::ref_ptr<T>& eventSource) { addDevice(eventSource.get()); }
/** Remove a Device. /*/
/** Remove a Device. */
void removeDevice(osgGA::Device* eventSource);
template<class T> void removeDevice(const osg::ref_ptr<T>& eventSource) { removeDevice(eventSource.get()); }

1
include/osgViewer/ViewerEventHandlers
View File

@ -446,6 +446,7 @@ class OSGVIEWER_EXPORT ScreenCaptureHandler : public osgGA::GUIEventHandler
std::vector<unsigned int> _contextSaveCounter;
};
/** @param defaultOperation : operation to do when screen capture happens. */
/** @param numFrames >0: capture that number of frames. <0: capture all frames, call stopCapture() to stop it. */
ScreenCaptureHandler(CaptureOperation* defaultOperation = 0, int numFrames = 1);