add functions param details for msvc code analysis.

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@6902 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
Michael Jerris 2007-12-19 15:36:07 +00:00
parent 8a9ac53124
commit 899b5fd066
2 changed files with 23 additions and 7 deletions

View File

@ -74,7 +74,7 @@ typedef switch_status_t (*switch_log_function_t) (const switch_log_node_t *node,
\param pool the memory pool to use \param pool the memory pool to use
\note to be called at application startup by the core \note to be called at application startup by the core
*/ */
SWITCH_DECLARE(switch_status_t) switch_log_init(switch_memory_pool_t *pool); SWITCH_DECLARE(switch_status_t) switch_log_init(_In_ switch_memory_pool_t *pool);
/*! /*!
\brief Shut down the logging engine \brief Shut down the logging engine
@ -94,30 +94,32 @@ SWITCH_DECLARE(switch_status_t) switch_log_shutdown(void);
\param ... variable args \param ... variable args
\note there are channel macros to supply the first 4 parameters \note there are channel macros to supply the first 4 parameters
*/ */
SWITCH_DECLARE(void) switch_log_printf(switch_text_channel_t channel, const char *file, const char *func, int line, SWITCH_DECLARE(void) switch_log_printf(_In_ switch_text_channel_t channel, _In_z_ const char *file,
const char *userdata, switch_log_level_t level, const char *fmt, ...) PRINTF_FUNCTION(7, 8); _In_z_ const char *func, _In_ int line,
_In_opt_z_ const char *userdata, _In_ switch_log_level_t level,
_In_z_ _Printf_format_string_ const char *fmt, ...) PRINTF_FUNCTION(7, 8);
/*! /*!
\brief Shut down the logging engine \brief Shut down the logging engine
\note to be called at application termination by the core \note to be called at application termination by the core
*/ */
SWITCH_DECLARE(switch_status_t) switch_log_bind_logger(switch_log_function_t function, switch_log_level_t level); SWITCH_DECLARE(switch_status_t) switch_log_bind_logger(_In_ switch_log_function_t function, _In_ switch_log_level_t level);
/*! /*!
\brief Return the name of the specified log level \brief Return the name of the specified log level
\param level the level \param level the level
\return the name of the log level \return the name of the log level
*/ */
SWITCH_DECLARE(const char *) switch_log_level2str(switch_log_level_t level); _Ret_z_ SWITCH_DECLARE(const char *) switch_log_level2str(_In_ switch_log_level_t level);
/*! /*!
\brief Return the level number of the specified log level name \brief Return the level number of the specified log level name
\param str the name of the level \param str the name of the level
\return the log level \return the log level
*/ */
SWITCH_DECLARE(switch_log_level_t) switch_log_str2level(const char *str); SWITCH_DECLARE(switch_log_level_t) switch_log_str2level(_In_z_ const char *str);
SWITCH_DECLARE(uint32_t) switch_log_str2mask(const char *str); SWITCH_DECLARE(uint32_t) switch_log_str2mask(_In_z_ const char *str);
#define switch_log_check_mask(_mask, _level) (_mask & (1 << _level)) #define switch_log_check_mask(_mask, _level) (_mask & (1 << _level))
///\} ///\}

View File

@ -296,6 +296,20 @@ SWITCH_END_EXTERN_C
#ifndef switch_assert #ifndef switch_assert
#define switch_assert(expr) assert(expr) #define switch_assert(expr) assert(expr)
#endif #endif
#ifndef __ATTR_SAL
/* used for msvc code analysis */
/* http://msdn2.microsoft.com/en-us/library/ms235402.aspx */
#define _In_
#define _In_z_
#define _In_opt_z_
#define _Printf_format_string_
#define _Ret_opt_z_
#define _Ret_z_
#define _Check_return_
#endif
/* For Emacs: /* For Emacs:
* Local Variables: * Local Variables:
* mode:c * mode:c