RKH
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
rkhfwk_module.h File Reference

Specifies the macros to identify file modules. More...

#include "rkhtype.h"
#include "rkhcfg.h"
Include dependency graph for rkhfwk_module.h:

Go to the source code of this file.

Macros

#define RKH_MODULE_VERSION(__fname, __version)   static RKHROM char *const m_version = # __version;
 This macro appears at the top of each C/C++ source file defining the version string for that file (module). More...
 
#define RKH_MODULE_GET_VERSION()   ((const char *)m_version);
 Get the module version.
 
#define RKH_MODULE_DESC(__fname, __desc)   static RKHROM char *const m_desc = __desc;
 This macro appears at the top of each C/C++ source file defining the description string for that file (module). More...
 
#define RKH_MODULE_GET_DESC()   ((const char *)m_desc)
 Get the module description.
 
#define RKH_MODULE_NAME(__fname)   static RKHROM char *const m_name = # __fname;
 This macro appears at the top of each C/C++ source file defining a name for that file. More...
 
#define RKH_THIS_MODULE   static RKHROM char *const m_name = __FILE__;
 This macro appears at the top of each C/C++ source file defining a name for that file, by means of FILE compiler directive.
 

Detailed Description

Specifies the macros to identify file modules.

Definition in file rkhfwk_module.h.

Macro Definition Documentation

#define RKH_MODULE_VERSION (   __fname,
  __version 
)    static RKHROM char *const m_version = # __version;

This macro appears at the top of each C/C++ source file defining the version string for that file (module).

Parameters
[in]__fnamefile (module) name.
[in]__versionfile (module) version.

Definition at line 71 of file rkhfwk_module.h.

#define RKH_MODULE_DESC (   __fname,
  __desc 
)    static RKHROM char *const m_desc = __desc;

This macro appears at the top of each C/C++ source file defining the description string for that file (module).

Parameters
[in]__fnamefile (module) name.
[in]__descfile (module) description.

Definition at line 89 of file rkhfwk_module.h.