Changeset 69 in pacpusframework for trunk/include/Pacpus/kernel

Timestamp:

01/10/13 00:04:42 (12 years ago)

Author:

Marek Kurdej

Message:

Added: more documentation.

File:

• trunk/include/Pacpus/kernel/pacpus.h (modified) (2 diffs)

trunk/include/Pacpus/kernel/pacpus.h

@@ -17 +17 @@
 #include <Pacpus/kernel/road_time.h>
 
-// Deprecated, you should use M_PI from cmath.
+/// Pi math constant
+/// 
+/// @deprecated,use M_PI from cmath.
 #ifndef PACPUS_PI
 #   define PACPUS_PI       3.1415926
 #endif
 
-// Export macro for PacpusLib DLL for Windows only
+/// Export macro for PacpusLib DLL for Windows only
 #ifdef WIN32
 #   ifdef PACPUSLIB_EXPORTS
@@ -36 +38 @@
 #endif
 
+/// @def PACPUS_DEPRECATED(func)
+/// Develops to the function or method declaration @b func
+/// and marks it as deprecated.
+
+/// @def PACPUS_DEPRECATED(func, msg)
+/// Develops to the function or method declaration @b func
+/// and marks it as deprecated with a given comment @b msg.
 #ifdef __GNUC__
 #   define PACPUS_DEPRECATED(func)              func __attribute__ ((deprecated))