net: coap: Capitalize and document COAP_MAKE_RESPONSE_CODE macro

- Capitalize COAP_MAKE_RESPONSE_CODE macro to align
  better with coding style
- Added missing Doxygen comments

Signed-off-by: Benjamin Cabé <[email protected]>

Author: kartben

include/zephyr/net/coap.h

@@ -115,43 +115,49 @@ enum coap_msgtype {
 	COAP_TYPE_RESET = 3
 };
 
-#define coap_make_response_code(class, det) ((class << 5) | (det))
+/**
+ * Utility macro to create a CoAP response code.
+ * @param class Class of the response code (ex. 2, 4, 5, ...)
+ * @param det Detail of the response code
+ * @return Response code literal
+*/
+#define COAP_MAKE_RESPONSE_CODE(class, det) ((class << 5) | (det))
 
 /**
  * @brief Set of response codes available for a response packet.
  *
  * To be used when creating a response.
  */
 enum coap_response_code {
-	COAP_RESPONSE_CODE_OK = coap_make_response_code(2, 0),
-	COAP_RESPONSE_CODE_CREATED = coap_make_response_code(2, 1),
-	COAP_RESPONSE_CODE_DELETED = coap_make_response_code(2, 2),
-	COAP_RESPONSE_CODE_VALID = coap_make_response_code(2, 3),
-	COAP_RESPONSE_CODE_CHANGED = coap_make_response_code(2, 4),
-	COAP_RESPONSE_CODE_CONTENT = coap_make_response_code(2, 5),
-	COAP_RESPONSE_CODE_CONTINUE = coap_make_response_code(2, 31),
-	COAP_RESPONSE_CODE_BAD_REQUEST = coap_make_response_code(4, 0),
-	COAP_RESPONSE_CODE_UNAUTHORIZED = coap_make_response_code(4, 1),
-	COAP_RESPONSE_CODE_BAD_OPTION = coap_make_response_code(4, 2),
-	COAP_RESPONSE_CODE_FORBIDDEN = coap_make_response_code(4, 3),
-	COAP_RESPONSE_CODE_NOT_FOUND = coap_make_response_code(4, 4),
-	COAP_RESPONSE_CODE_NOT_ALLOWED = coap_make_response_code(4, 5),
-	COAP_RESPONSE_CODE_NOT_ACCEPTABLE = coap_make_response_code(4, 6),
-	COAP_RESPONSE_CODE_INCOMPLETE = coap_make_response_code(4, 8),
-	COAP_RESPONSE_CODE_CONFLICT = coap_make_response_code(4, 9),
-	COAP_RESPONSE_CODE_PRECONDITION_FAILED = coap_make_response_code(4, 12),
-	COAP_RESPONSE_CODE_REQUEST_TOO_LARGE = coap_make_response_code(4, 13),
+	COAP_RESPONSE_CODE_OK = COAP_MAKE_RESPONSE_CODE(2, 0),
+	COAP_RESPONSE_CODE_CREATED = COAP_MAKE_RESPONSE_CODE(2, 1),
+	COAP_RESPONSE_CODE_DELETED = COAP_MAKE_RESPONSE_CODE(2, 2),
+	COAP_RESPONSE_CODE_VALID = COAP_MAKE_RESPONSE_CODE(2, 3),
+	COAP_RESPONSE_CODE_CHANGED = COAP_MAKE_RESPONSE_CODE(2, 4),
+	COAP_RESPONSE_CODE_CONTENT = COAP_MAKE_RESPONSE_CODE(2, 5),
+	COAP_RESPONSE_CODE_CONTINUE = COAP_MAKE_RESPONSE_CODE(2, 31),
+	COAP_RESPONSE_CODE_BAD_REQUEST = COAP_MAKE_RESPONSE_CODE(4, 0),
+	COAP_RESPONSE_CODE_UNAUTHORIZED = COAP_MAKE_RESPONSE_CODE(4, 1),
+	COAP_RESPONSE_CODE_BAD_OPTION = COAP_MAKE_RESPONSE_CODE(4, 2),
+	COAP_RESPONSE_CODE_FORBIDDEN = COAP_MAKE_RESPONSE_CODE(4, 3),
+	COAP_RESPONSE_CODE_NOT_FOUND = COAP_MAKE_RESPONSE_CODE(4, 4),
+	COAP_RESPONSE_CODE_NOT_ALLOWED = COAP_MAKE_RESPONSE_CODE(4, 5),
+	COAP_RESPONSE_CODE_NOT_ACCEPTABLE = COAP_MAKE_RESPONSE_CODE(4, 6),
+	COAP_RESPONSE_CODE_INCOMPLETE = COAP_MAKE_RESPONSE_CODE(4, 8),
+	COAP_RESPONSE_CODE_CONFLICT = COAP_MAKE_RESPONSE_CODE(4, 9),
+	COAP_RESPONSE_CODE_PRECONDITION_FAILED = COAP_MAKE_RESPONSE_CODE(4, 12),
+	COAP_RESPONSE_CODE_REQUEST_TOO_LARGE = COAP_MAKE_RESPONSE_CODE(4, 13),
 	COAP_RESPONSE_CODE_UNSUPPORTED_CONTENT_FORMAT =
-						coap_make_response_code(4, 15),
-	COAP_RESPONSE_CODE_UNPROCESSABLE_ENTITY = coap_make_response_code(4, 22),
-	COAP_RESPONSE_CODE_TOO_MANY_REQUESTS = coap_make_response_code(4, 29),
-	COAP_RESPONSE_CODE_INTERNAL_ERROR = coap_make_response_code(5, 0),
-	COAP_RESPONSE_CODE_NOT_IMPLEMENTED = coap_make_response_code(5, 1),
-	COAP_RESPONSE_CODE_BAD_GATEWAY = coap_make_response_code(5, 2),
-	COAP_RESPONSE_CODE_SERVICE_UNAVAILABLE = coap_make_response_code(5, 3),
-	COAP_RESPONSE_CODE_GATEWAY_TIMEOUT = coap_make_response_code(5, 4),
+						COAP_MAKE_RESPONSE_CODE(4, 15),
+	COAP_RESPONSE_CODE_UNPROCESSABLE_ENTITY = COAP_MAKE_RESPONSE_CODE(4, 22),
+	COAP_RESPONSE_CODE_TOO_MANY_REQUESTS = COAP_MAKE_RESPONSE_CODE(4, 29),
+	COAP_RESPONSE_CODE_INTERNAL_ERROR = COAP_MAKE_RESPONSE_CODE(5, 0),
+	COAP_RESPONSE_CODE_NOT_IMPLEMENTED = COAP_MAKE_RESPONSE_CODE(5, 1),
+	COAP_RESPONSE_CODE_BAD_GATEWAY = COAP_MAKE_RESPONSE_CODE(5, 2),
+	COAP_RESPONSE_CODE_SERVICE_UNAVAILABLE = COAP_MAKE_RESPONSE_CODE(5, 3),
+	COAP_RESPONSE_CODE_GATEWAY_TIMEOUT = COAP_MAKE_RESPONSE_CODE(5, 4),
 	COAP_RESPONSE_CODE_PROXYING_NOT_SUPPORTED =
-						coap_make_response_code(5, 5)
+						COAP_MAKE_RESPONSE_CODE(5, 5)
 };
 
 #define COAP_CODE_EMPTY (0)