@@ -389,9 +389,9 @@ typedef otError (*otCoapBlockwiseReceiveHook)(void * aContext,
389389 * is enabled.
390390 *
391391 * @param[in] aContext A pointer to application-specific context.
392- * @param[inout] aBlock A pointer to where the block segment can be written to.
392+ * @param[in,out] aBlock A pointer to where the block segment can be written to.
393393 * @param[in] aPosition The position in a sequence from which to obtain the block segment.
394- * @param[inout] aBlockLength On entry, the maximum block segment length in bytes.
394+ * @param[in,out] aBlockLength On entry, the maximum block segment length in bytes.
395395 * @param[out] aMore A pointer to the flag if more block segments will follow.
396396 *
397397 * @warning By changing the value of aBlockLength, the block size of the whole exchange is
@@ -485,9 +485,9 @@ typedef struct otCoapTxParameters
485485/**
486486 * This function initializes the CoAP header.
487487 *
488- * @param[inout ] aMessage A pointer to the CoAP message to initialize.
489- * @param[in] aType CoAP message type.
490- * @param[in] aCode CoAP message code.
488+ * @param[in,out ] aMessage A pointer to the CoAP message to initialize.
489+ * @param[in] aType CoAP message type.
490+ * @param[in] aCode CoAP message code.
491491 *
492492 */
493493void otCoapMessageInit (otMessage * aMessage , otCoapType aType , otCoapCode aCode );
@@ -497,10 +497,10 @@ void otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode);
497497 *
498498 * @note Both message ID and token are set according to @p aRequest.
499499 *
500- * @param[inout] aResponse A pointer to the CoAP response message.
501- * @param[in] aRequest A pointer to the CoAP request message.
502- * @param[in] aType CoAP message type.
503- * @param[in] aCode CoAP message code.
500+ * @param[in,out] aResponse A pointer to the CoAP response message.
501+ * @param[in] aRequest A pointer to the CoAP request message.
502+ * @param[in] aType CoAP message type.
503+ * @param[in] aCode CoAP message code.
504504 *
505505 * @retval OT_ERROR_NONE Successfully initialized the response message.
506506 * @retval OT_ERROR_NO_BUFS Insufficient message buffers available to initialize the response message.
@@ -511,9 +511,9 @@ otError otCoapMessageInitResponse(otMessage *aResponse, const otMessage *aReques
511511/**
512512 * This function sets the Token value and length in a header.
513513 *
514- * @param[inout ] aMessage A pointer to the CoAP message.
515- * @param[in] aToken A pointer to the Token value.
516- * @param[in] aTokenLength The Length of @p aToken.
514+ * @param[in,out ] aMessage A pointer to the CoAP message.
515+ * @param[in] aToken A pointer to the Token value.
516+ * @param[in] aTokenLength The Length of @p aToken.
517517 *
518518 * @retval OT_ERROR_NONE Successfully set the Token value.
519519 * @retval OT_ERROR_NO_BUFS Insufficient buffers to set the Token value.
@@ -524,8 +524,8 @@ otError otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_
524524/**
525525 * This function sets the Token length and randomizes its value.
526526 *
527- * @param[inout ] aMessage A pointer to the CoAP message.
528- * @param[in] aTokenLength The Length of a Token to set.
527+ * @param[in,out ] aMessage A pointer to the CoAP message.
528+ * @param[in] aTokenLength The Length of a Token to set.
529529 *
530530 */
531531void otCoapMessageGenerateToken (otMessage * aMessage , uint8_t aTokenLength );
@@ -540,8 +540,8 @@ void otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength);
540540 * and if the desired format type code isn't listed in otCoapOptionContentFormat,
541541 * this base function should be used instead.
542542 *
543- * @param[inout ] aMessage A pointer to the CoAP message.
544- * @param[in] aContentFormat One of the content formats listed in
543+ * @param[in,out ] aMessage A pointer to the CoAP message.
544+ * @param[in] aContentFormat One of the content formats listed in
545545 * otCoapOptionContentFormat above.
546546 *
547547 * @retval OT_ERROR_NONE Successfully appended the option.
@@ -554,10 +554,10 @@ otError otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOption
554554/**
555555 * This function appends a CoAP option in a header.
556556 *
557- * @param[inout ] aMessage A pointer to the CoAP message.
558- * @param[in] aNumber The CoAP Option number.
559- * @param[in] aLength The CoAP Option length.
560- * @param[in] aValue A pointer to the CoAP value.
557+ * @param[in,out ] aMessage A pointer to the CoAP message.
558+ * @param[in] aNumber The CoAP Option number.
559+ * @param[in] aLength The CoAP Option length.
560+ * @param[in] aValue A pointer to the CoAP value.
561561 *
562562 * @retval OT_ERROR_NONE Successfully appended the option.
563563 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -570,9 +570,9 @@ otError otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_
570570 * This function appends an unsigned integer CoAP option as specified in
571571 * https://tools.ietf.org/html/rfc7252#section-3.2
572572 *
573- * @param[inout ] aMessage A pointer to the CoAP message.
574- * @param[in] aNumber The CoAP Option number.
575- * @param[in] aValue The CoAP Option unsigned integer value.
573+ * @param[in,out ] aMessage A pointer to the CoAP message.
574+ * @param[in] aNumber The CoAP Option number.
575+ * @param[in] aValue The CoAP Option unsigned integer value.
576576 *
577577 * @retval OT_ERROR_NONE Successfully appended the option.
578578 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -585,8 +585,8 @@ otError otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uin
585585/**
586586 * This function appends an Observe option.
587587 *
588- * @param[inout ] aMessage A pointer to the CoAP message.
589- * @param[in] aObserve Observe field value.
588+ * @param[in,out ] aMessage A pointer to the CoAP message.
589+ * @param[in] aObserve Observe field value.
590590 *
591591 * @retval OT_ERROR_NONE Successfully appended the option.
592592 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -598,8 +598,8 @@ otError otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve)
598598/**
599599 * This function appends a Uri-Path option.
600600 *
601- * @param[inout ] aMessage A pointer to the CoAP message.
602- * @param[in] aUriPath A pointer to a NULL-terminated string.
601+ * @param[in,out ] aMessage A pointer to the CoAP message.
602+ * @param[in] aUriPath A pointer to a NULL-terminated string.
603603 *
604604 * @retval OT_ERROR_NONE Successfully appended the option.
605605 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -621,10 +621,10 @@ uint16_t otCoapBlockSizeFromExponent(otCoapBlockSzx aSize);
621621/**
622622 * This function appends a Block2 option
623623 *
624- * @param[inout ] aMessage A pointer to the CoAP message.
625- * @param[in] aNum Current block number.
626- * @param[in] aMore Boolean to indicate more blocks are to be sent.
627- * @param[in] aSize Block Size Exponent.
624+ * @param[in,out ] aMessage A pointer to the CoAP message.
625+ * @param[in] aNum Current block number.
626+ * @param[in] aMore Boolean to indicate more blocks are to be sent.
627+ * @param[in] aSize Block Size Exponent.
628628 *
629629 * @retval OT_ERROR_NONE Successfully appended the option.
630630 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -636,10 +636,10 @@ otError otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool
636636/**
637637 * This function appends a Block1 option
638638 *
639- * @param[inout ] aMessage A pointer to the CoAP message.
640- * @param[in] aNum Current block number.
641- * @param[in] aMore Boolean to indicate more blocks are to be sent.
642- * @param[in] aSize Block Size Exponent.
639+ * @param[in,out ] aMessage A pointer to the CoAP message.
640+ * @param[in] aNum Current block number.
641+ * @param[in] aMore Boolean to indicate more blocks are to be sent.
642+ * @param[in] aSize Block Size Exponent.
643643 *
644644 * @retval OT_ERROR_NONE Successfully appended the option.
645645 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -651,8 +651,8 @@ otError otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool
651651/**
652652 * This function appends a Proxy-Uri option.
653653 *
654- * @param[inout ] aMessage A pointer to the CoAP message.
655- * @param[in] aUriPath A pointer to a NULL-terminated string.
654+ * @param[in,out ] aMessage A pointer to the CoAP message.
655+ * @param[in] aUriPath A pointer to a NULL-terminated string.
656656 *
657657 * @retval OT_ERROR_NONE Successfully appended the option.
658658 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -664,8 +664,8 @@ otError otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriP
664664/**
665665 * This function appends a Max-Age option.
666666 *
667- * @param[inout ] aMessage A pointer to the CoAP message.
668- * @param[in] aMaxAge The Max-Age value.
667+ * @param[in,out ] aMessage A pointer to the CoAP message.
668+ * @param[in] aMaxAge The Max-Age value.
669669 *
670670 * @retval OT_ERROR_NONE Successfully appended the option.
671671 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -677,8 +677,8 @@ otError otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge);
677677/**
678678 * This function appends a single Uri-Query option.
679679 *
680- * @param[inout ] aMessage A pointer to the CoAP message.
681- * @param[in] aUriQuery A pointer to NULL-terminated string, which should contain a single key=value pair.
680+ * @param[in,out ] aMessage A pointer to the CoAP message.
681+ * @param[in] aUriQuery A pointer to NULL-terminated string, which should contain a single key=value pair.
682682 *
683683 * @retval OT_ERROR_NONE Successfully appended the option.
684684 * @retval OT_ERROR_INVALID_ARGS The option type is not equal or greater than the last option type.
@@ -689,7 +689,7 @@ otError otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQ
689689/**
690690 * This function adds Payload Marker indicating beginning of the payload to the CoAP header.
691691 *
692- * @param[inout ] aMessage A pointer to the CoAP message.
692+ * @param[in,out ] aMessage A pointer to the CoAP message.
693693 *
694694 * @retval OT_ERROR_NONE Payload Marker successfully added.
695695 * @retval OT_ERROR_NO_BUFS Header Payload Marker exceeds the buffer size.
@@ -720,8 +720,8 @@ otCoapCode otCoapMessageGetCode(const otMessage *aMessage);
720720/**
721721 * This function sets the Code value.
722722 *
723- * @param[inout ] aMessage A pointer to the CoAP message to initialize.
724- * @param[in] aCode CoAP message code.
723+ * @param[in,out ] aMessage A pointer to the CoAP message to initialize.
724+ * @param[in] aCode CoAP message code.
725725 *
726726 */
727727void otCoapMessageSetCode (otMessage * aMessage , otCoapCode aCode );
@@ -769,8 +769,8 @@ const uint8_t *otCoapMessageGetToken(const otMessage *aMessage);
769769/**
770770 * This function initialises an iterator for the options in the given message.
771771 *
772- * @param[inout ] aIterator A pointer to the CoAP message option iterator.
773- * @param[in] aMessage A pointer to the CoAP message.
772+ * @param[in,out ] aIterator A pointer to the CoAP message option iterator.
773+ * @param[in] aMessage A pointer to the CoAP message.
774774 *
775775 * @retval OT_ERROR_NONE Successfully initialised.
776776 * @retval OT_ERROR_PARSE Message state is inconsistent.
@@ -792,7 +792,7 @@ const otCoapOption *otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionItera
792792/**
793793 * This function returns a pointer to the first option.
794794 *
795- * @param[inout ] aIterator A pointer to the CoAP message option iterator.
795+ * @param[in,out ] aIterator A pointer to the CoAP message option iterator.
796796 *
797797 * @returns A pointer to the first option. If no option is present NULL pointer is returned.
798798 *
@@ -813,7 +813,7 @@ const otCoapOption *otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterat
813813/**
814814 * This function returns a pointer to the next option.
815815 *
816- * @param[inout ] aIterator A pointer to the CoAP message option iterator.
816+ * @param[in,out ] aIterator A pointer to the CoAP message option iterator.
817817 *
818818 * @returns A pointer to the next option. If no more options are present NULL pointer is returned.
819819 *
@@ -824,7 +824,7 @@ const otCoapOption *otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIte
824824 * This function fills current option value into @p aValue assuming the current value is an unsigned integer encoded
825825 * according to https://tools.ietf.org/html/rfc7252#section-3.2
826826 *
827- * @param[inout] aIterator A pointer to the CoAP message option iterator.
827+ * @param[in,out] aIterator A pointer to the CoAP message option iterator.
828828 * @param[out] aValue A pointer to an unsigned integer to receive the option value.
829829 *
830830 * @retval OT_ERROR_NONE Successfully filled value.
@@ -838,8 +838,8 @@ otError otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator,
838838/**
839839 * This function fills current option value into @p aValue.
840840 *
841- * @param[inout ] aIterator A pointer to the CoAP message option iterator.
842- * @param[out] aValue A pointer to a buffer to receive the option value.
841+ * @param[in,out ] aIterator A pointer to the CoAP message option iterator.
842+ * @param[out] aValue A pointer to a buffer to receive the option value.
843843 *
844844 * @retval OT_ERROR_NONE Successfully filled value.
845845 * @retval OT_ERROR_NOT_FOUND No current option.
0 commit comments