Skip to content

Add Oracle Doc Comments Style Guide coverage infrastructure #19800

@gianmarcoschifone

Description

@gianmarcoschifone

Summary

This issue proposes adding infrastructure to support coverage tracking for the Oracle Documentation Comments Style Guide. Similar to the existing Sun style, Google style and Openjdk coverage, we would create a parallel structure for Doc Comments conventions.

Motivation

Checkstyle currently lacks a dedicated configuration and coverage documentation for the Documentation Comments Style Guide. A dedicated configuration would make it easier for the community to enforce these guidelines.

Currently, Checkstyle provides:

  • sun_checks.xml - Configuration for Sun Code Conventions
  • google_checks.xml - Configuration for Google Java Style Guide
  • openjdk_checks.xml - Configuration for Openjdk Java Style Guide

Proposed Implementation

1. New Configuration File

  • doc_comments_checks.xml - Checkstyle configuration based on Documentation Comments guidelines

2. Documentation Page

  • doc_comments_style.xml - Coverage documentation page showing which checks map to Documentation Comments guidelines
  • Add a cached version of Documentation Comments Style Guide

3. Test Infrastructure

  • CheckUtil.java - Add getConfigDocCommentsStyleModules() method
  • XdocsPagesTest.java - Add validation for the new style
  • AbstractDocCommentsModuleTestSupport.java - Base class for future integration tests

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions