source: pacpusframework/trunk/include/Pacpus/kernel/pacpus.h@ 69

Last change on this file since 69 was 69, checked in by Marek Kurdej, 12 years ago

Added: more documentation.

  • Property svn:keywords set to Id
File size: 1.9 KB
Line 
1// This file is part of the PACPUS framework distributed under the
2// CECILL-C License, Version 1.0.
3//
4/// @file
5/// @author Gerald Dherbomez <firstname.surname@utc.fr>
6/// @author Marek Kurdej <firstname.surname@utc.fr>
7/// @date February, 2006
8/// @version $Id: pacpus.h 69 2013-01-09 23:04:42Z kurdejma $
9/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
10/// @brief Brief description.
11///
12/// Detailed description.
13
14#ifndef DEF_PACPUS_H
15#define DEF_PACPUS_H
16
17#include <Pacpus/kernel/road_time.h>
18
19/// Pi math constant
20///
21/// @deprecated,use M_PI from cmath.
22#ifndef PACPUS_PI
23# define PACPUS_PI 3.1415926
24#endif
25
26/// Export macro for PacpusLib DLL for Windows only
27#ifdef WIN32
28# ifdef PACPUSLIB_EXPORTS
29// make DLL
30# define PACPUSLIB_API __declspec(dllexport)
31# else
32// use DLL
33# define PACPUSLIB_API __declspec(dllimport)
34# endif
35#else
36// On other platforms, simply ignore this
37# define PACPUSLIB_API
38#endif
39
40/// @def PACPUS_DEPRECATED(func)
41/// Develops to the function or method declaration @b func
42/// and marks it as deprecated.
43
44/// @def PACPUS_DEPRECATED(func, msg)
45/// Develops to the function or method declaration @b func
46/// and marks it as deprecated with a given comment @b msg.
47#ifdef __GNUC__
48# define PACPUS_DEPRECATED(func) func __attribute__ ((deprecated))
49# define PACPUS_DEPRECATED_MSG(func, msg) PACPUS_DEPRECATED(func)
50#elif defined(_MSC_VER)
51# define PACPUS_DEPRECATED(func) __declspec(deprecated) func
52# define PACPUS_DEPRECATED_MSG(func, msg) __declspec(deprecated("was declared deprecated: " msg)) func
53#else
54# pragma message("WARNING: You need to implement PACPUS_DEPRECATED for this compiler")
55# define PACPUS_DEPRECATED(func) func
56# define PACPUS_DEPRECATED_MSG(func, msg) func
57#endif
58
59#endif // DEF_PACPUS_H
Note: See TracBrowser for help on using the repository browser.