diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c index d6d9f5dfe8..5d310f2013 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c @@ -33,7 +33,7 @@ EFIAPI LinkNode ( IN AML_OBJECT_NODE * Node, IN AML_NODE_HEADER * ParentNode, - IN AML_OBJECT_NODE ** NewObjectNode + OUT AML_OBJECT_NODE ** NewObjectNode ) { EFI_STATUS Status; @@ -71,7 +71,7 @@ LinkNode ( @param[in] OemId 6-character string OEM identifier. @param[in] OemTableId 8-character string OEM table identifier. @param[in] OemRevision OEM revision number. - @param[out] DefinitionBlockTerm The ASL Term handle representing a + @param[out] NewRootNode Pointer to the root node representing a Definition Block. @retval EFI_SUCCESS Success. diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c index 9e7a508e60..d40a27410d 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c @@ -40,7 +40,7 @@ EFIAPI LinkRdNode ( IN AML_DATA_NODE * RdNode, IN AML_OBJECT_NODE * ParentNode, - IN AML_DATA_NODE ** NewRdNode + OUT AML_DATA_NODE ** NewRdNode ) { EFI_STATUS Status; diff --git a/DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c b/DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c index dc37374890..30d31572d3 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/NameSpace/AmlNameSpace.c @@ -674,7 +674,7 @@ AmlAddPrefix ( @retval EFI_SUCCESS The function completed successfully. @retval EFI_INVALID_PARAMETER Invalid parameter. -*/ +**/ STATIC EFI_STATUS EFIAPI diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c index c25ee22dc7..b9403efe3c 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlFieldListParser.c @@ -41,7 +41,7 @@ @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI @@ -177,7 +177,7 @@ AmlParseFieldElement ( @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c index bc98d950b5..4797fa11ed 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c @@ -1320,7 +1320,7 @@ AmlCreateMethodInvocationNode ( // DefExternal := ExternalOp NameString ObjectType ArgumentCount // ExternalOp := 0x15 // ObjectType := ByteData - // ArgumentCount := ByteData (0 – 7) + // ArgumentCount := ByteData (0 - 7) // Read the ArgumentCount. ArgCountNode = (AML_DATA_NODE*)FixedArgs[EAmlParseIndexTerm2]; @@ -1334,7 +1334,7 @@ AmlCreateMethodInvocationNode ( // MethodInvocation := MethodInvocationOp NameString ArgumentCount // MethodInvocationOp := Pseudo Opcode for Method Invocation // NameString := Method Name - // ArgumentCount := ByteData (0 – 7) + // ArgumentCount := ByteData (0 - 7) Status = AmlCreateObjectNode ( AmlGetByteEncodingByOpCode (AML_METHOD_INVOC_OP, 0), 0, @@ -1411,7 +1411,7 @@ error_handler: @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ EFI_STATUS EFIAPI AmlGetMethodInvocationArgCount ( diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c index 380ac9bbce..4f6623de02 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c @@ -1134,7 +1134,7 @@ AmlParseVariableArguments ( @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI @@ -1179,7 +1179,7 @@ AmlPopulateRootNode ( @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI @@ -1287,7 +1287,7 @@ AmlPopulateObjectNode ( @retval EFI_BUFFER_TOO_SMALL No space left in the buffer. @retval EFI_INVALID_PARAMETER Invalid parameter. @retval EFI_OUT_OF_RESOURCES Could not allocate memory. -*/ +**/ STATIC EFI_STATUS EFIAPI diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c index 09fb3e7258..0f41c68b28 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlResourceDataParser.c @@ -213,7 +213,7 @@ AmlRdIsResourceDataBuffer ( return TRUE; } - // TODO Might want to check the CRC when available. + // @todo Might want to check the CRC when available. // An end tag resource data element must be the last element of the list. // Thus the function should have already returned. if (AmlRdCompareDescId ( diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c b/DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c index 419e796e50..08ee959475 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Stream/AmlStream.c @@ -52,7 +52,7 @@ AmlStreamInit ( in the ClonedStream. @param [in] Stream Pointer to the stream to clone. - @param [in] ClonedStream Pointer to the stream to initialize. + @param [out] ClonedStream Pointer to the stream to initialize. @retval EFI_SUCCESS The function completed successfully. @retval EFI_INVALID_PARAMETER Invalid parameter. @@ -97,7 +97,7 @@ AmlStreamClone ( @param [in] Stream Pointer to the stream from which a sub-stream is created. - @param [in] SubStream Pointer to the stream to initialize. + @param [out] SubStream Pointer to the stream to initialize. @retval EFI_SUCCESS The function completed successfully. @retval EFI_INVALID_PARAMETER Invalid parameter. diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c index 2c80440a44..3740c0ac7b 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c @@ -464,7 +464,7 @@ AmlNodeCompareOpCode ( @retval TRUE The Node is an integer node. @retval FALSE Otherwise. -*/ +**/ BOOLEAN EFIAPI IsIntegerNode ( @@ -499,7 +499,7 @@ IsIntegerNode ( @retval TRUE The Node is a ZeroOp or OneOp. @retval FALSE Otherwise. -*/ +**/ BOOLEAN EFIAPI IsSpecialIntegerNode ( @@ -556,7 +556,7 @@ AmlIsMethodDefinitionNode ( // DefExternal := ExternalOp NameString ObjectType ArgumentCount // ExternalOp := 0x15 // ObjectType := ByteData - // ArgumentCount := ByteData (0 – 7) + // ArgumentCount := ByteData (0 - 7) ObjectType = (AML_DATA_NODE*)AmlGetFixedArgument ( (AML_OBJECT_NODE*)Node, EAmlParseIndexTerm1 diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c index 65dad95da2..0931e75170 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTree.c @@ -41,7 +41,7 @@ AmlGetParent ( @return The root node of the tree. NULL if error. -*/ +**/ AML_ROOT_NODE * EFIAPI AmlGetRootNode (