Skip to content
Permalink
Browse files
Modify error code comments format
  • Loading branch information
xuzhenbao committed Feb 17, 2022
1 parent 58043e6 commit a456c47840f1cd70e7f43cc89ac7fe68417af6e7
Showing 1 changed file with 15 additions and 12 deletions.
@@ -21,15 +21,18 @@
* \file
* \brief Error codes
* \defgroup framework Celix Framework
* \note Error code has 32bits, its internal structure as following
* \details Error code has 32bits. If the value of error code is 0,it indicates success;if no-zero,it indicates error.
* its internal structure as following,
*
*|31-30bit|29bit|28-27bit|26-16bit|15-0bit|
*|--------|-----|--------|--------|-------|
*|R |C |R |Facility|Code |
* |31-30bit|29bit|28-27bit|26-16bit|15-0bit|
* |-------:|:---:|:------:|:------:|:------|
* |R |C |R |Facility|Code |
*
* C (1bit): Customer. If set, indicates that the error code is customer-defined. If clear, indicates that the error code is celix-defines
* R : Reserved. It should be set to 0
* Facility (11 bits): An indicator of the source of the error
* - C (1bit): Customer. If set, indicates that the error code is customer-defined.
* If clear, indicates that the error code is celix-defines.
* - R : Reserved. It should be set to 0.
* - Facility (11 bits): An indicator of the source of the error.
* - Code (16bits): The remainder of error code.
*/
#ifndef CELIX_ERRNO_H_
#define CELIX_ERRNO_H_
@@ -71,31 +74,31 @@ typedef int celix_status_t;
const char* celix_strerror(celix_status_t status);

/*!
* \brief Customer error code mask
* Customer error code mask
*
*/
#define CELIX_CUSTOMER_ERR_MASK 0x02000000

/*!
* \brief The facility of system error code,
* The facility of system error code,
* \note Error code 0 indicates success,it is not system error code.
*/
#define CELIX_FACILITY_SYSTEM 0

/*!
* \brief The facility of celix default error code
* The facility of celix default error code
*
*/
#define CELIX_FACILITY_NULL 1

/*!
* \brief The facility of the http suppoter error code
* The facility of the http suppoter error code
*
*/
#define CELIX_FACILITY_HTTP 2

/*!
* \brief Make the error code accroding to the specification
* Make the error code accroding to the specification
* \param fac Facility
* \param code Code
*/

0 comments on commit a456c47

Please sign in to comment.