1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/sys/posix/pthread/include/pthread_scheduling.h
René Kijewski e135bdc266 documentation: fix doxygen for pthread_*.h
The pthread header files aren't in the doxygen page anymore after #1137,
because I `@file`'d the `.c` files, not the `.h` files.

This change moves doxygen boilerplate.

Closes #1199.
2014-05-18 17:33:49 +02:00

47 lines
1.6 KiB
C

/**
* @ingroup pthread
* @{
* @file
* @brief Scheduling parameters and policies of pthreads.
* @note None of these functions are implemented, yet.
* @note Do not include this header file directly, but pthread.h.
*/
#ifndef __SYS__POSIX__PTHREAD_SCHEDULING__H
#define __SYS__POSIX__PTHREAD_SCHEDULING__H
/**
* @brief Unimplemented.
* @note Due to the native of RIOT it is unlikely that this function will ever be implemented.
* @param[in] target_thread Unused
* @param[in] policy Unused
* @param[in] param Unused
* @returns The function is unimplemented. Using it will cause a link time error.
*/
int pthread_setschedparam(pthread_t target_thread, int policy, const struct sched_param *param);
/**
* @brief Unimplemented.
* @note Due to the native of RIOT it is unlikely that this function will ever be implemented.
* @param[in] target_thread Unused
* @param[in,out] policy Unused
* @param[out] param Unused
* @returns The function is unimplemented. Using it will cause a link time error.
*/
int pthread_getschedparam(pthread_t target_thread, int *policy, struct sched_param *param);
/**
* @brief Unimplemented.
* @note Due to the native of RIOT it is unlikely that this function will ever be implemented.
* @param[in] target_thread Unused
* @param[in] prio Unused
* @returns The function is unimplemented. Using it will cause a link time error.
*/
int pthread_setschedprio(pthread_t target_thread, int prio);
#endif
/**
* @}
*/