traceservices/commsdebugutility/INC/commsdebugutility.h
branchRCL_3
changeset 9 667e88a979d7
parent 0 08ec8eefde2f
equal deleted inserted replaced
8:fa9941cf3867 9:667e88a979d7
    14 // Comms Debug Utility (File and Serial logger) Client side header
    14 // Comms Debug Utility (File and Serial logger) Client side header
    15 // 
    15 // 
    16 //
    16 //
    17 
    17 
    18 /**
    18 /**
    19  @file
    19 @file
    20  @internalTechnology
    20 @publishedAll
       
    21 @deprecated Migrate to Open System Trace Instrumentation API instead
    21 */
    22 */
    22 
    23 
    23 #ifndef __COMMSDEBUGUTILITY_H__
    24 #ifndef __COMMSDEBUGUTILITY_H__
    24 #define __COMMSDEBUGUTILITY_H__
    25 #define __COMMSDEBUGUTILITY_H__
    25 
    26 
    65 _LIT(KFloggerPanic, "Comsdbgutil.dll");		///< The text which defines any flogger panic. Sent to User::Panic.
    66 _LIT(KFloggerPanic, "Comsdbgutil.dll");		///< The text which defines any flogger panic. Sent to User::Panic.
    66 
    67 
    67 /**
    68 /**
    68  * Panic codes
    69  * Panic codes
    69  *
    70  *
    70  * @internalTechnology
    71  * @publishedAll
       
    72  * @deprecated Migrate to Open System Trace Instrumentation API instead
    71  * @note The order of the panic numbers should not be changed.
    73  * @note The order of the panic numbers should not be changed.
    72  *       New panic codes must be added at the end of this enum.
    74  *       New panic codes must be added at the end of this enum.
    73  *       All panic codes are assigned to values to ease debugging.
    75  *       All panic codes are assigned to values to ease debugging.
    74  */
    76  */
    75 enum TFloggerPanics
    77 enum TFloggerPanics
    79 	};
    81 	};
    80 
    82 
    81 /**
    83 /**
    82  * Logging Mode codes
    84  * Logging Mode codes
    83  *
    85  *
    84  * @internalTechnology
    86  * @publishedAll
    85  * @deprecated As of version 8.0 the logging modes are deprecated due to the introduction
    87  * @deprecated As of version 8.0 the logging modes are deprecated due to the introduction
    86  *             of a single log file. Appent mode is the default for all write operations,
    88  *             of a single log file. Appent mode is the default for all write operations,
    87  *             while Overwrite can be achieved using new __FLOG_CLEAR macro, or ClearLog API.
    89  *             while Overwrite can be achieved using new __FLOG_CLEAR macro, or ClearLog API.
    88  */
    90  */
    89 enum TFileLoggingMode 
    91 enum TFileLoggingMode 
    99 
   101 
   100 
   102 
   101 /**
   103 /**
   102  * Flogger - File and Serial Logger client interface 
   104  * Flogger - File and Serial Logger client interface 
   103  *
   105  *
   104  * @internalTechnology 
   106  * @publishedAll
       
   107  * @deprecated Migrate to Open System Trace Instrumentation API instead
       
   108  * 
   105  * This class is responsible for providing all functions
   109  * This class is responsible for providing all functions
   106  * clients require of the flogger system. It is preferred, though,
   110  * clients require of the flogger system. It is preferred, though,
   107  * that clients use the provided macros which refer to these API's
   111  * that clients use the provided macros which refer to these API's
   108  * so that all logging code is governed by the global __FLOG_ACTIVE
   112  * so that all logging code is governed by the global __FLOG_ACTIVE
   109  * macro setting. The macro's are not currently documented using
   113  * macro setting. The macro's are not currently documented using