Fix #3304: Add check to ensure KDoc presence for non-private members

.github/workflows/static_checks.yml

@@ -122,9 +122,9 @@ jobs:
       - name: Accessibility label Check
         if: always()
         run: |
-          bazel run //scripts:accessibility_label_check -- $(pwd) app/src/main/AndroidManifest.xml
+          bazel run //scripts:accessibility_label_check -- $(pwd) scripts/assets/accessibility_label_exemptions.pb app/src/main/AndroidManifest.xml
 
-      - name: KDoc Check
+      - name: KDoc validity Check
         if: always()
         run: |
-          bazel run //scripts:kdoc_check -- $(pwd)
+          bazel run //scripts:kdoc_validity_check -- $(pwd) scripts/assets/kdoc_validity_exemptions.pb

scripts/BUILD.bazel

@@ -6,7 +6,7 @@ load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_jvm_binary", "kt_jvm_libra
 load(
     "//scripts:script_assets.bzl",
     "generate_accessibility_label_assets_list_from_text_protos",
-    "generate_kdoc_assets_list_from_text_protos",
+    "generate_kdoc_validity_assets_list_from_text_protos",
     "generate_maven_assets_list_from_text_protos",
     "generate_regex_assets_list_from_text_protos",
     "generate_test_file_assets_list_from_text_protos",
@@ -123,13 +123,6 @@ ACCESSIBILITY_LABEL_EXEMPTION_ASSETS = generate_accessibility_label_assets_list_
     accessibility_label_exemptions_name = ["accessibility_label_exemptions"],
 )
 
-kt_jvm_library(
-    name = "accessibility_label_check_assets",
-    testonly = True,
-    data = ACCESSIBILITY_LABEL_EXEMPTION_ASSETS,
-    visibility = [":oppia_script_test_visibility"],
-)
-
 kt_jvm_binary(
     name = "accessibility_label_check",
     testonly = True,
@@ -140,24 +133,17 @@ kt_jvm_binary(
     ],
 )
 
-KDOC_EXEMPTION_ASSETS = generate_kdoc_assets_list_from_text_protos(
-    name = "kdoc_exemption_assets",
-    kdoc_exemptions_name = ["kdoc_exemptions"],
-)
-
-kt_jvm_library(
-    name = "kdoc_check_assets",
-    testonly = True,
-    data = KDOC_EXEMPTION_ASSETS,
-    visibility = [":oppia_script_test_visibility"],
+KDOC_VALIDITY_EXEMPTION_ASSETS = generate_kdoc_validity_assets_list_from_text_protos(
+    name = "kdoc_validity_exemption_assets",
+    kdoc_validity_exemptions_name = ["kdoc_validity_exemptions"],
 )
 
 kt_jvm_binary(
-    name = "kdoc_check",
+    name = "kdoc_validity_check",
     testonly = True,
-    data = KDOC_EXEMPTION_ASSETS,
-    main_class = "org.oppia.android.scripts.kdoc.KDocCheckKt",
+    data = KDOC_VALIDITY_EXEMPTION_ASSETS,
+    main_class = "org.oppia.android.scripts.docs.KDocValidityCheckKt",
     runtime_deps = [
-        "//scripts/src/java/org/oppia/android/scripts/kdoc:kdoc_check_lib",
+        "//scripts/src/java/org/oppia/android/scripts/docs:kdoc_validity_check_lib",
     ],
 )

scripts/assets/kdoc_exemptions.textproto → scripts/assets/kdoc_validity_exemptions.textproto

@@ -409,7 +409,6 @@ exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/testing/Image
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/testing/InputInteractionViewTestActivityTest.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/testing/NavigationDrawerActivityDebugTest.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/testing/NavigationDrawerActivityProdTest.kt"
-exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/testing/PlatformParameterIntegrationTest.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/testing/TestFontScaleConfigurationUtilActivityTest.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/testing/TopicTestActivityForStoryTest.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/topic/TopicActivityTest.kt"
@@ -424,6 +423,8 @@ exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/topic/revisio
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/topic/revisioncard/RevisionCardFragmentTest.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/utility/DragViewAction.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/utility/DrawableMatcher.kt"
+exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/utility/EspressoTestsMatchers.kt"
+exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/utility/EspressoTestsMatchers.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/utility/OrientationChangeAction.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/utility/RatioExtensionsTest.kt"
 exempted_file_path: "app/src/sharedTest/java/org/oppia/android/app/utility/TabMatcher.kt"
@@ -441,6 +442,7 @@ exempted_file_path: "app/src/test/java/org/oppia/android/app/story/StoryActivity
 exempted_file_path: "app/src/test/java/org/oppia/android/app/testing/CompletedStoryListSpanTest.kt"
 exempted_file_path: "app/src/test/java/org/oppia/android/app/testing/HomeSpanTest.kt"
 exempted_file_path: "app/src/test/java/org/oppia/android/app/testing/OngoingTopicListSpanTest.kt"
+exempted_file_path: "app/src/test/java/org/oppia/android/app/testing/PlatformParameterIntegrationTest.kt"
 exempted_file_path: "app/src/test/java/org/oppia/android/app/testing/ProfileChooserSpanTest.kt"
 exempted_file_path: "app/src/test/java/org/oppia/android/app/testing/ProfileProgressSpanCount.kt"
 exempted_file_path: "app/src/test/java/org/oppia/android/app/testing/RecentlyPlayedSpanTest.kt"
@@ -453,6 +455,7 @@ exempted_file_path: "app/src/test/java/org/oppia/android/app/topic/info/TopicInf
 exempted_file_path: "app/src/test/java/org/oppia/android/app/topic/lessons/TopicLessonsFragmentLocalTest.kt"
 exempted_file_path: "app/src/test/java/org/oppia/android/app/topic/questionplayer/QuestionPlayerActivityLocalTest.kt"
 exempted_file_path: "app/src/test/java/org/oppia/android/app/topic/revisioncard/RevisionCardActivityLocalTest.kt"
+exempted_file_path: "data/src/main/java/org/oppia/android/data/backends/gae/NetworkSettings.kt"
 exempted_file_path: "data/src/main/java/org/oppia/android/data/backends/gae/api/ClassroomService.kt"
 exempted_file_path: "data/src/main/java/org/oppia/android/data/backends/gae/api/ConceptCardService.kt"
 exempted_file_path: "data/src/main/java/org/oppia/android/data/backends/gae/api/ExplorationService.kt"
@@ -502,6 +505,7 @@ exempted_file_path: "domain/src/main/java/org/oppia/android/domain/util/JsonAsse
 exempted_file_path: "domain/src/test/java/org/oppia/android/domain/audio/AudioPlayerControllerTest.kt"
 exempted_file_path: "domain/src/test/java/org/oppia/android/domain/audio/CellularAudioDialogControllerTest.kt"
 exempted_file_path: "domain/src/test/java/org/oppia/android/domain/classify/AnswerClassificationControllerTest.kt"
+exempted_file_path: "domain/src/test/java/org/oppia/android/domain/classify/InteractionObjectTestBuilder.kt"
 exempted_file_path: "domain/src/test/java/org/oppia/android/domain/classify/rules/dragAndDropSortInput/DragDropSortInputHasElementXAtPositionYRuleClassifierProviderTest.kt"
 exempted_file_path: "domain/src/test/java/org/oppia/android/domain/classify/rules/dragAndDropSortInput/DragDropSortInputHasElementXBeforeElementYRuleClassifierProviderTest.kt"
 exempted_file_path: "domain/src/test/java/org/oppia/android/domain/classify/rules/dragAndDropSortInput/DragDropSortInputIsEqualToOrderingClassifierProviderTest.kt"

scripts/script_assets.bzl

@@ -47,15 +47,15 @@ def generate_test_file_assets_list_from_text_protos(
 
     Args:
         name: str. The name of this generation instance. This will be a prefix for derived targets.
-        test_file_exemptions_name: list of str. The list of test file exemptions file names.
+        test_file_exemptions_name: list of str. The list of test file exemptions file name.
 
     Returns:
         list of str. The list of new proto binary asset files that were generated.
     """
     return generate_proto_binary_assets(
         name = name,
         names = test_file_exemptions_name,
-        proto_dep_name = "test_file_exemptions",
+        proto_dep_name = "script_exemptions",
         proto_type_name = "TestFileExemptions",
         name_prefix = name,
         asset_dir = "assets",
@@ -97,40 +97,40 @@ def generate_accessibility_label_assets_list_from_text_protos(
     Args:
         name: str. The name of this generation instance. This will be a prefix for derived targets.
         accessibility_label_exemptions_name: list of str. The list of accessibility label exemptions
-         file names.
+         file name.
 
     Returns:
         list of str. The list of new proto binary asset files that were generated.
     """
     return generate_proto_binary_assets(
         name = name,
         names = accessibility_label_exemptions_name,
-        proto_dep_name = "accessibility_label_exemptions",
+        proto_dep_name = "script_exemptions",
         proto_type_name = "AccessibilityLabelExemptions",
         name_prefix = name,
         asset_dir = "assets",
         proto_dep_bazel_target_prefix = "//scripts/src/java/org/oppia/android/scripts/proto",
         proto_package = "proto",
     )
 
-def generate_kdoc_assets_list_from_text_protos(
+def generate_kdoc_validity_assets_list_from_text_protos(
         name,
-        kdoc_exemptions_name):
+        kdoc_validity_exemptions_name):
     """
-    Converts multiple lists of text proto assets to binary.
+    Converts a single list of text proto assets to binary.
 
     Args:
         name: str. The name of this generation instance. This will be a prefix for derived targets.
-        kdoc_exemptions_name: list of str. The list of kdoc exemptions file names.
+        kdoc_validity_exemptions_name: list of str. The list of kdoc validity exemptions file name.
 
     Returns:
         list of str. The list of new proto binary asset files that were generated.
     """
     return generate_proto_binary_assets(
         name = name,
-        names = kdoc_exemptions_name,
-        proto_dep_name = "kdoc_exemptions",
-        proto_type_name = "KDocExemptions",
+        names = kdoc_validity_exemptions_name,
+        proto_dep_name = "script_exemptions",
+        proto_type_name = "KDocValidityExemptions",
         name_prefix = name,
         asset_dir = "assets",
         proto_dep_bazel_target_prefix = "//scripts/src/java/org/oppia/android/scripts/proto",

scripts/src/java/org/oppia/android/scripts/kdoc/BUILD.bazel → scripts/src/java/org/oppia/android/scripts/docs/BUILD.bazel

@@ -1,18 +1,17 @@
 """
-Libraries corresponding to kdoc presence check, that ensures all public members (except overrides)
-must have a corresponding KDoc.
+Libraries corresponding docs validity check, that ensures the documentations are valid.
 """
 
 load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_jvm_library")
 
 kt_jvm_library(
-    name = "kdoc_check_lib",
+    name = "kdoc_validity_check_lib",
     testonly = True,
-    srcs = ["KDocCheck.kt"],
+    srcs = ["KDocValidityCheck.kt"],
     visibility = ["//scripts:oppia_script_binary_visibility"],
     deps = [
         "//scripts/src/java/org/oppia/android/scripts/common:repository_file",
-        "//scripts/src/java/org/oppia/android/scripts/proto:kdoc_exemptions_java_proto_lite",
+        "//scripts/src/java/org/oppia/android/scripts/proto:script_exemptions_java_proto_lite",
         "//third_party:org_jetbrains_kotlin_kotlin-compiler-embeddable",
     ],
 )