From 14797251a1fff141455ecc85da5c28bbc9bfa1c4 Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Fri, 4 Mar 2022 13:12:20 -0800 Subject: [PATCH] Revert "Fix documentation to align with code. (#15872)" (#15881) This reverts commit a9741c6502e5592f57b8a03dfbd4d33a7130b51b. --- .github/workflows/darwin.yaml | 13 +++++++++++-- src/app/EventManagement.h | 2 +- src/app/MessageDef/EventPathIB.h | 2 +- .../DeviceAttestationVerifier.h | 2 +- 4 files changed, 14 insertions(+), 5 deletions(-) diff --git a/.github/workflows/darwin.yaml b/.github/workflows/darwin.yaml index e1534c0dbf2895..b5f0d661aa95d1 100644 --- a/.github/workflows/darwin.yaml +++ b/.github/workflows/darwin.yaml @@ -77,10 +77,19 @@ jobs: # enable it for various reasons. Keep whatever Xcode settings # for OTHER_CFLAGS exist by using ${inherited}. # + # Disable -Wdocumentation because so much of our doxygen is so + # broken. See https://github.com/project-chip/connectedhomeip/issues/6734 + # + # Disable -Wconditional-uninitialized because the generated IM TLV + # code hits this all over the place. + # # Disable -Wmacro-redefined because CHIP_DEVICE_CONFIG_ENABLE_MDNS # seems to be unconditionally defined in CHIPDeviceBuildConfig.h, # which is apparently being included after CHIPDeviceConfig.h. - run: xcodebuild -target "CHIP" -sdk macosx OTHER_CFLAGS='${inherited} -Werror -Wno-macro-redefined' + # + # Disable -Wdeprecated-declarations because we use deprecated + # things like PairTestDeviceWithoutSecurity. + run: xcodebuild -target "CHIP" -sdk macosx OTHER_CFLAGS='${inherited} -Werror -Wno-documentation -Wno-conditional-uninitialized -Wno-macro-redefined -Wno-deprecated-declarations' working-directory: src/darwin/Framework - name: Clean Build run: xcodebuild clean @@ -109,7 +118,7 @@ jobs: run: | mkdir -p /tmp/darwin/framework-tests ../../../out/debug/chip-all-clusters-app > >(tee /tmp/darwin/framework-tests/all-cluster-app.log) 2> >(tee /tmp/darwin/framework-tests/all-cluster-app-err.log >&2) & - xcodebuild test -target "CHIP" -scheme "CHIP Framework Tests" -sdk macosx OTHER_CFLAGS='${inherited} -Werror -Wno-incomplete-umbrella' > >(tee /tmp/darwin/framework-tests/darwin-tests.log) 2> >(tee /tmp/darwin/framework-tests/darwin-tests-err.log >&2) + xcodebuild test -target "CHIP" -scheme "CHIP Framework Tests" -sdk macosx OTHER_CFLAGS='${inherited} -Werror -Wno-documentation -Wno-conditional-uninitialized -Wno-incomplete-umbrella' > >(tee /tmp/darwin/framework-tests/darwin-tests.log) 2> >(tee /tmp/darwin/framework-tests/darwin-tests-err.log >&2) working-directory: src/darwin/Framework - name: Uploading log files uses: actions/upload-artifact@v2 diff --git a/src/app/EventManagement.h b/src/app/EventManagement.h index 07b900ca0f375c..1257255e58f5d7 100644 --- a/src/app/EventManagement.h +++ b/src/app/EventManagement.h @@ -326,7 +326,7 @@ class EventManagement * completion, the event number of the next one we plan to fetch. * * @param[out] aEventCount The number of fetched event - * @param[in] aSubjectDescriptor Subject descriptor for current read handler + * @param[in] aFabricIndex fabric index for current read handler * @retval #CHIP_END_OF_TLV The function has reached the end of the * available log entries at the specified * priority level diff --git a/src/app/MessageDef/EventPathIB.h b/src/app/MessageDef/EventPathIB.h index e1a77532d460e7..a11a7d22518836 100644 --- a/src/app/MessageDef/EventPathIB.h +++ b/src/app/MessageDef/EventPathIB.h @@ -119,7 +119,7 @@ class Parser : public ListParser /** * @brief Fill the fields in apPath from the parser, the path in the parser should be a concrete path. * - * @param [in] apPath A pointer to the path to fill in. + * @param [in] apEvent A pointer to apEvent * * @return #CHIP_NO_ERROR on success * #CHIP_ERROR_IM_MALFORMED_EVENT_PATH if the path from the reader is not a valid concrere event path. diff --git a/src/credentials/attestation_verifier/DeviceAttestationVerifier.h b/src/credentials/attestation_verifier/DeviceAttestationVerifier.h index 038559882dd427..5fc0831f2976a5 100644 --- a/src/credentials/attestation_verifier/DeviceAttestationVerifier.h +++ b/src/credentials/attestation_verifier/DeviceAttestationVerifier.h @@ -222,7 +222,7 @@ class DeviceAttestationVerifier /** * @brief Verify an attestation information payload against a DAC/PAI chain. * - * @param[in] info All of the information required to verify the attestation. + * @param[in] attestationInfo All of the information required to verify the attestation. * @param[in] onCompletion Callback handler to provide Attestation Information Verification result to the caller of * VerifyAttestationInformation() */