Fix some doxygen warnings

This commit is contained in:
Robin Gareus 2020-03-02 17:44:35 +01:00
parent be4bdb5365
commit 7c6eadd84a
Signed by: rgareus
GPG Key ID: A090BCE02CF57F04
2 changed files with 7 additions and 1 deletions

View File

@ -35,7 +35,6 @@ class LIBAUDIOGRAPHER_API SampleRateConverter
* Note that outpt size may vary a lot. * Note that outpt size may vary a lot.
* May or may not output several contexts of data. * May or may not output several contexts of data.
* \n Should be RT safe. * \n Should be RT safe.
* \TODO Check RT safety from libsamplerate
*/ */
void process (ProcessContext<float> const & c); void process (ProcessContext<float> const & c);
using Sink<float>::process; using Sink<float>::process;

View File

@ -62,6 +62,7 @@ private:
when returning objects, to avoid an explicit temporary variable, since when returning objects, to avoid an explicit temporary variable, since
the destructor executes after the return statement. For example: the destructor executes after the return statement. For example:
\code
template <class U> template <class U>
U cast (lua_State* L) U cast (lua_State* L)
{ {
@ -69,6 +70,7 @@ private:
... ...
return U (); // dtor called after this line return U (); // dtor called after this line
} }
\endcode
@note The `StackPop` object must always be a named local variable. @note The `StackPop` object must always be a named local variable.
*/ */
@ -77,6 +79,7 @@ private:
public: public:
/** Create a StackPop object. /** Create a StackPop object.
@param L the LuaState to modify
@param count The number of stack entries to pop on destruction. @param count The number of stack entries to pop on destruction.
*/ */
StackPop (lua_State* L, int count) StackPop (lua_State* L, int count)
@ -277,6 +280,7 @@ private:
http://social.msdn.microsoft.com/Forums/en-US/vcgeneral/thread/e30b2664-a92d-445c-9db2-e8e0fbde2014 http://social.msdn.microsoft.com/Forums/en-US/vcgeneral/thread/e30b2664-a92d-445c-9db2-e8e0fbde2014
https://connect.microsoft.com/VisualStudio/feedback/details/771509/correct-code-doesnt-compile https://connect.microsoft.com/VisualStudio/feedback/details/771509/correct-code-doesnt-compile
\code
// This code snippet fails to compile in vs2010,vs2012 // This code snippet fails to compile in vs2010,vs2012
struct S { struct S {
template <class T> inline operator T () const { return T (); } template <class T> inline operator T () const { return T (); }
@ -285,6 +289,7 @@ private:
S () || false; S () || false;
return 0; return 0;
} }
\endcode
*/ */
template <class T> template <class T>
inline operator T () const inline operator T () const
@ -886,6 +891,7 @@ public:
http://social.msdn.microsoft.com/Forums/en-US/vcgeneral/thread/e30b2664-a92d-445c-9db2-e8e0fbde2014 http://social.msdn.microsoft.com/Forums/en-US/vcgeneral/thread/e30b2664-a92d-445c-9db2-e8e0fbde2014
https://connect.microsoft.com/VisualStudio/feedback/details/771509/correct-code-doesnt-compile https://connect.microsoft.com/VisualStudio/feedback/details/771509/correct-code-doesnt-compile
\code
// This code snippet fails to compile in vs2010,vs2012 // This code snippet fails to compile in vs2010,vs2012
struct S { struct S {
template <class T> inline operator T () const { return T (); } template <class T> inline operator T () const { return T (); }
@ -894,6 +900,7 @@ public:
S () || false; S () || false;
return 0; return 0;
} }
\endcode
*/ */
template <class T> template <class T>
inline operator T () const inline operator T () const