Jw/doxygen arg of @param not found (#296)

* fixed some of the doxygen warnings of the form "argument '<arg>' of command @param is not found in the argument list of <method>" (the ones with the most obvious fixes) * Minor changes made by clang-format.
OGRECave · May 30, 2022 · dc52a1d · dc52a1d
1 parent 60f890a
commit dc52a1d
Show file tree

Hide file tree

Showing 29 changed files with 76 additions and 78 deletions.
diff --git a/Components/Hlms/Pbs/include/OgreHlmsPbsDatablock.h b/Components/Hlms/Pbs/include/OgreHlmsPbsDatablock.h
@@ -616,7 +616,7 @@ namespace Ogre
         float getRefractionStrength() const { return mRefractionStrength; }
 
         /** Sets the strength of the of the clear coat layer and its roughness.
-        @param strength
+        @param clearCoat
             This should be treated as a binary value, set to either 0 or 1. Intermediate values are
             useful to control transitions between parts of the surface that have a clear coat layers and
             parts that don't.

diff --git a/OgreMain/include/Animation/OgreSkeletonAnimation.h b/OgreMain/include/Animation/OgreSkeletonAnimation.h
@@ -115,7 +115,7 @@ namespace Ogre
         void setTime( Real time ) { setFrame( time * mFrameRate ); }
 
         /** Sets the animation to a particular frame.
-        @param frames
+        @param frame
             Frame to set to, in frames
         */
         void setFrame( Real frame );

diff --git a/OgreMain/include/Compositor/OgreCompositorNodeDef.h b/OgreMain/include/Compositor/OgreCompositorNodeDef.h
@@ -174,7 +174,7 @@ namespace Ogre
             using linked lists or other containers with two level of indirections)
         @remarks
             Calling this function is not obligatory, but recommended
-        @param numPasses
+        @param numOuts
             The number of output channels expected to contain.
         */
         void setNumOutputChannels( size_t numOuts ) { mOutChannelMapping.reserve( numOuts ); }
@@ -206,7 +206,7 @@ namespace Ogre
             than using linked lists or other containers with two level of indirections)
         @remarks
             Calling this function is not obligatory, but recommended
-        @param numPasses
+        @param numOuts
             The number of output buffer channels expected to contain.
         */
         void setNumOutputBufferChannels( size_t numOuts )
@@ -225,7 +225,7 @@ namespace Ogre
             channel name hasn't been set yet (declaration order is important!).
         @param outChannel
             Output channel # to map
-        @param textureName
+        @param bufferName
             Name of the buffer
         */
         void mapOutputBufferChannel( size_t outChannel, IdString bufferName );

diff --git a/OgreMain/include/Compositor/OgreTextureDefinition.h b/OgreMain/include/Compositor/OgreTextureDefinition.h
@@ -250,7 +250,7 @@ namespace Ogre
             You're assigning an alias named "myRT" to channel Input #0
             For local or global textures, the index parameter documentation
 
-        @param fullName
+        @param name
             The name of the texture. Names are usually valid only throughout this node.
             We need the name, not its hash because we need to validate the global_ prefix
             is used correctly.
@@ -310,7 +310,7 @@ namespace Ogre
         /** Reserves enough memory for all texture definitions
         @remarks
             Calling this function is not obligatory, but recommended
-        @param numPasses
+        @param numTDs
             The number of texture definitions expected to contain.
         */
         void setNumLocalTextureDefinitions( size_t numTDs ) { mLocalTextureDefs.reserve( numTDs ); }
@@ -399,8 +399,6 @@ namespace Ogre
         @param finalTarget
             The final render target (usually the render window) we have to clone parameters from
             (eg. when using auto width & height, or fsaa settings)
-        @param renderSys
-            The RenderSystem to use
         */
         static void recreateResizableTextures01( const TextureDefinitionVec &textureDefs,
                                                  CompositorChannelVec       &inOutTexContainer,
@@ -462,7 +460,7 @@ namespace Ogre
         /** Reserves enough memory for all texture definitions
         @remarks
             Calling this function is not obligatory, but recommended
-        @param numPasses
+        @param numTDs
             The number of texture definitions expected to contain.
         */
         void setNumLocalBufferDefinitions( size_t numTDs ) { mLocalBufferDefs.reserve( numTDs ); }
@@ -568,7 +566,7 @@ namespace Ogre
             as we're missing:
                 + Whether the texture is colour or depth
                 + The default depth settings (prefersDepthTexture, depth format, etc)
-                
+
             Use this function to force the given texture to be analyzed at runtime when
             creating the pass.
         @remarks

diff --git a/OgreMain/include/Compositor/Pass/OgreCompositorPassProvider.h b/OgreMain/include/Compositor/Pass/OgreCompositorPassProvider.h
@@ -81,7 +81,7 @@ namespace Ogre
         @param customId
             Arbitrary ID in case there is more than one type of custom pass you want to implement.
             Defaults to IdString()
-        @param rtIndex
+        @param parentTargetDef
         @param parentNodeDef
         @return
         */

diff --git a/OgreMain/include/Compositor/Pass/PassUav/OgreCompositorPassUavDef.h b/OgreMain/include/Compositor/Pass/PassUav/OgreCompositorPassUavDef.h
@@ -128,7 +128,7 @@ namespace Ogre
             The texture access privileges given to the shader.
         @param mipmapLevel
             The texture mipmap level to use.
-        @param format
+        @param pixelFormat
             Texture format to be read in by shader. This may be different than the bound texture format.
             Will be the same is left as PFG_UNKNOWN
         */

diff --git a/OgreMain/include/Math/Array/C/OgreArrayMatrix4.h b/OgreMain/include/Math/Array/C/OgreArrayMatrix4.h
@@ -155,7 +155,7 @@ namespace Ogre
         /** Assigns the value of the other matrix. Does not reference the
             ptr address, but rather perform a memory copy
             @param
-                rkmatrix The other matrix
+                rkMatrix The other matrix
         */
         inline ArrayMatrix4 &operator=( const ArrayMatrix4 &rkMatrix )
         {

diff --git a/OgreMain/include/Math/Array/C/OgreArrayMatrixAf4x3.h b/OgreMain/include/Math/Array/C/OgreArrayMatrixAf4x3.h
@@ -115,7 +115,7 @@ namespace Ogre
                 This function is defined in ArrayMatrix4 to avoid including this header into
                 ArrayQuaternion. The idea is that ArrayMatrix4 requires ArrayQuaternion, and
                 ArrayQuaternion requires ArrayVector3. Simple dependency order
-            @param
+            @param q
                 The quaternion to convert from.
         */
         inline void fromQuaternion( const ArrayQuaternion &q );

diff --git a/OgreMain/include/Math/Array/C/OgreArrayQuaternion.h b/OgreMain/include/Math/Array/C/OgreArrayQuaternion.h
@@ -220,9 +220,9 @@ namespace Ogre
                 decide between two ArrayQuaternions, i.e. a = Cmov4( b, c ) then
                 @see Cmov4( const ArrayQuaternion &arg1, const ArrayQuaternion &arg2, ArrayReal mask );
                 instead.
-            @param
+            @param replacement
                 Vectors to be used as replacement if the mask is zero.
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? this[i] : replacement[i]
@@ -237,11 +237,11 @@ namespace Ogre
                 If you wanted to do a = cmov4( a, b ), then consider using the update version
                 @see Cmov4( ArrayReal mask, const ArrayQuaternion &replacement );
                 instead.
-            @param
+            @param arg1
                 First array of Vectors
-            @param
+            @param arg2
                 Second array of Vectors
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? arg1[i] : arg2[i]

diff --git a/OgreMain/include/Math/Array/C/OgreArrayVector3.h b/OgreMain/include/Math/Array/C/OgreArrayVector3.h
@@ -285,9 +285,9 @@ namespace Ogre
                 decide between two ArrayVector3s, i.e. a = Cmov4( b, c ) then
                 @see Cmov4( const ArrayVector3 &arg1, const ArrayVector3 &arg2, ArrayReal mask );
                 instead.
-            @param
+            @param replacement
                 Vectors to be used as replacement if the mask is zero.
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? this[i] : replacement[i]
@@ -307,9 +307,9 @@ namespace Ogre
                 decide between two ArrayVector3s, i.e. a = Cmov4( b, c ) then
                 @see Cmov4( const ArrayVector3 &arg1, const ArrayVector3 &arg2, ArrayReal mask );
                 instead.
-            @param
+            @param replacement
                 Vectors to be used as replacement if the mask is zero.
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? this[i] : replacement[i]
@@ -324,11 +324,11 @@ namespace Ogre
                 If you wanted to do a = cmov4( a, b ), then consider using the update version
                 @see Cmov4( ArrayReal mask, const ArrayVector3 &replacement );
                 instead.
-            @param
+            @param arg1
                 First array of Vectors
-            @param
+            @param arg2
                 Second array of Vectors
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? arg1[i] : arg2[i]

diff --git a/OgreMain/include/Math/Array/C/OgreMathlibC.h b/OgreMain/include/Math/Array/C/OgreMathlibC.h
@@ -64,7 +64,7 @@ namespace Ogre
         static const ArrayReal MAX_POS;    // Max negative number (x4)
 
         /** Returns the absolute values of each 4 floats
-            @param
+            @param a
                 4 floating point values
             @return
                 abs( a )
@@ -76,11 +76,11 @@ namespace Ogre
                 Will NOT work if any of the arguments contains Infinite
                 or NaNs or non-floating point values. If an exact binary
                 copy is needed, @see CmovRobust
-            @param
+            @param arg1
                 4 floating point values. Can't be NaN or Inf
-            @param
+            @param arg2
                 4 floating point values. Can't be NaN or Inf
-            @param
+            @param mask
                 4 values containing either 0 or 0xffffffff
                 Any other value, the result is undefined
             @return
@@ -115,11 +115,11 @@ namespace Ogre
                 Bypass between Execution Domains, Intel® 64 and IA-32
                 Architectures Optimization Reference Manual Order
                 Number: 248966-026 April (and also Table 2-12)
-            @param
+            @param arg1
                 A value containing 128 bits
-            @param
+            @param arg2
                 A value containing 128 bits
-            @param
+            @param mask
                 Mask, each bit is evaluated
             @return
                 For each bit:

diff --git a/OgreMain/include/Math/Array/NEON/Single/OgreArrayMatrix4.h b/OgreMain/include/Math/Array/NEON/Single/OgreArrayMatrix4.h
@@ -170,7 +170,7 @@ namespace Ogre
         /** Assigns the value of the other matrix. Does not reference the
             ptr address, but rather perform a memory copy
             @param
-                rkmatrix The other matrix
+                rkMatrix The other matrix
         */
         inline ArrayMatrix4 &operator=( const ArrayMatrix4 &rkMatrix )
         {
@@ -201,7 +201,7 @@ namespace Ogre
                 This function is defined in ArrayMatrix4 to avoid including this header into
                 ArrayQuaternion. The idea is that ArrayMatrix4 requires ArrayQuaternion, and
                 ArrayQuaternion requires ArrayVector3. Simple dependency order
-            @param
+            @param q
                 The quaternion to convert from.
         */
         inline void fromQuaternion( const ArrayQuaternion &q );

diff --git a/OgreMain/include/Math/Array/NEON/Single/OgreArrayMatrixAf4x3.h b/OgreMain/include/Math/Array/NEON/Single/OgreArrayMatrixAf4x3.h
@@ -115,7 +115,7 @@ namespace Ogre
                 This function is defined in ArrayMatrix4 to avoid including this header into
                 ArrayQuaternion. The idea is that ArrayMatrix4 requires ArrayQuaternion, and
                 ArrayQuaternion requires ArrayVector3. Simple dependency order
-            @param
+            @param q
                 The quaternion to convert from.
         */
         inline void fromQuaternion( const ArrayQuaternion &q );

diff --git a/OgreMain/include/Math/Array/NEON/Single/OgreArrayQuaternion.h b/OgreMain/include/Math/Array/NEON/Single/OgreArrayQuaternion.h
@@ -219,9 +219,9 @@ namespace Ogre
                 decide between two ArrayQuaternions, i.e. a = Cmov4( b, c ) then
                 @see Cmov4( const ArrayQuaternion &arg1, const ArrayQuaternion &arg2, ArrayReal mask );
                 instead.
-            @param
+            @param replacement
                 Vectors to be used as replacement if the mask is zero.
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? this[i] : replacement[i]
@@ -236,11 +236,11 @@ namespace Ogre
                 If you wanted to do a = cmov4( a, b ), then consider using the update version
                 @see Cmov4( ArrayReal mask, const ArrayQuaternion &replacement );
                 instead.
-            @param
+            @param arg1
                 First array of Vectors
-            @param
+            @param arg2
                 Second array of Vectors
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? arg1[i] : arg2[i]

diff --git a/OgreMain/include/Math/Array/NEON/Single/OgreArrayVector3.h b/OgreMain/include/Math/Array/NEON/Single/OgreArrayVector3.h
@@ -316,9 +316,9 @@ namespace Ogre
                 decide between two ArrayVector3s, i.e. a = Cmov4( b, c ) then
                 @see Cmov4( const ArrayVector3 &arg1, const ArrayVector3 &arg2, ArrayReal mask );
                 instead.
-            @param
+            @param replacement
                 Vectors to be used as replacement if the mask is zero.
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? this[i] : replacement[i]
@@ -333,11 +333,11 @@ namespace Ogre
                 If you wanted to do a = cmov4( a, b ), then consider using the update version
                 @see Cmov4( ArrayReal mask, const ArrayVector3 &replacement );
                 instead.
-            @param
+            @param arg1
                 First array of Vectors
-            @param
+            @param arg2
                 Second array of Vectors
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? arg1[i] : arg2[i]

diff --git a/OgreMain/include/Math/Array/OgreArrayMemoryManager.h b/OgreMain/include/Math/Array/OgreArrayMemoryManager.h
@@ -95,7 +95,7 @@ namespace Ogre
                     The hierarchy depth level
                 @param basePtrs
                     The base pointers from each pool so we can calculate the differences
-                @param utDiffsList
+                @param outDiffsList
                     The list we'll generate. "outDiffsList" already has enough reserved space
             */
             virtual void buildDiffList( uint16 level, const MemoryPoolVec &basePtrs,
@@ -229,7 +229,7 @@ namespace Ogre
         /// ArrayMemoryManager::destroySlot already does this when the number
         /// of fragmented slots reaches mCleanupThreshold
         void defragment();
-        
+
         ///  Prevent defragmentation from ever happening.
         void neverDefragment();
 

diff --git a/OgreMain/include/Math/Array/SSE2/Single/OgreArrayMatrix4.h b/OgreMain/include/Math/Array/SSE2/Single/OgreArrayMatrix4.h
@@ -155,7 +155,7 @@ namespace Ogre
         /** Assigns the value of the other matrix. Does not reference the
             ptr address, but rather perform a memory copy
             @param
-                rkmatrix The other matrix
+                rkMatrix The other matrix
         */
         inline ArrayMatrix4 &operator=( const ArrayMatrix4 &rkMatrix )
         {
@@ -186,7 +186,7 @@ namespace Ogre
                 This function is defined in ArrayMatrix4 to avoid including this header into
                 ArrayQuaternion. The idea is that ArrayMatrix4 requires ArrayQuaternion, and
                 ArrayQuaternion requires ArrayVector3. Simple dependency order
-            @param
+            @param q
                 The quaternion to convert from.
         */
         inline void fromQuaternion( const ArrayQuaternion &q );

diff --git a/OgreMain/include/Math/Array/SSE2/Single/OgreArrayMatrixAf4x3.h b/OgreMain/include/Math/Array/SSE2/Single/OgreArrayMatrixAf4x3.h
@@ -115,7 +115,7 @@ namespace Ogre
                 This function is defined in ArrayMatrix4 to avoid including this header into
                 ArrayQuaternion. The idea is that ArrayMatrix4 requires ArrayQuaternion, and
                 ArrayQuaternion requires ArrayVector3. Simple dependency order
-            @param
+            @param q
                 The quaternion to convert from.
         */
         inline void fromQuaternion( const ArrayQuaternion &q );

diff --git a/OgreMain/include/Math/Array/SSE2/Single/OgreArrayQuaternion.h b/OgreMain/include/Math/Array/SSE2/Single/OgreArrayQuaternion.h
@@ -220,9 +220,9 @@ namespace Ogre
                 decide between two ArrayQuaternions, i.e. a = Cmov4( b, c ) then
                 @see Cmov4( const ArrayQuaternion &arg1, const ArrayQuaternion &arg2, ArrayReal mask );
                 instead.
-            @param
+            @param replacement
                 Vectors to be used as replacement if the mask is zero.
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? this[i] : replacement[i]
@@ -237,11 +237,11 @@ namespace Ogre
                 If you wanted to do a = cmov4( a, b ), then consider using the update version
                 @see Cmov4( ArrayReal mask, const ArrayQuaternion &replacement );
                 instead.
-            @param
+            @param arg1
                 First array of Vectors
-            @param
+            @param arg2
                 Second array of Vectors
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? arg1[i] : arg2[i]

diff --git a/OgreMain/include/Math/Array/SSE2/Single/OgreArrayVector3.h b/OgreMain/include/Math/Array/SSE2/Single/OgreArrayVector3.h
@@ -331,11 +331,11 @@ namespace Ogre
                 If you wanted to do a = cmov4( a, b ), then consider using the update version
                 @see Cmov4( ArrayReal mask, const ArrayVector3 &replacement );
                 instead.
-            @param
+            @param arg1
                 First array of Vectors
-            @param
+            @param arg2
                 Second array of Vectors
-            @param
+            @param mask
                 mask filled with either 0's or 0xFFFFFFFF
             @return
                 this[i] = mask[i] != 0 ? arg1[i] : arg2[i]