Skip to content

Switch license header to a multiline comment instead of JavaDoc #2412

Closed
@shakuzen

Description

@shakuzen
Member

I noticed when browsing the JavaDocs site for Micrometer that package descriptions were populated with the license header. Also, license header in .java files is a JavaDoc syntax comment, which the IDE warns about. We should probably change them to all be non-JavaDoc multi-line comments instead. Then we can make meaningful package descriptions for reasons like micrometer-metrics/micrometer-docs#147 (comment) and avoid the IDE warning about JavaDoc comments above imports.

Activity

added this to the 1.3.17 milestone on Jan 20, 2021
modified the milestones: 1.3.17, 1.3.18 on Feb 16, 2021
modified the milestones: 1.3.18, 1.3.x on Mar 16, 2021
modified the milestones: 1.3.x, 1.5.x on Jun 22, 2021
modified the milestones: 1.5.x, 1.6.x on Aug 12, 2021
modified the milestones: 1.6.x, 1.7.x on Nov 10, 2021

14 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

      Development

      Participants

      @jonatan-ivanov@shakuzen

      Issue actions

        Switch license header to a multiline comment instead of JavaDoc · Issue #2412 · micrometer-metrics/micrometer