Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

Migrate @rename annotations #1120

@lars-reimann

Description

@lars-reimann

Is your feature request related to a problem?

After changes to an API we still want to use most of the @rename annotations. Only when an API element was renamed, too, do we need to check whether the @rename annotation still makes sense.

Desired solution

Migrate @rename annotations from elements of the old API to elements of the new API that are mapped together. This should include

  • classes,
  • functions,
  • parameters.

If the element was renamed in the new API, the annotations should still be migrated but marked as unsure. In the end a new annotations.json file should be created for the new API after the migrate command is run.

Open question: If a function is split into many others, should the @rename annotation even be migrated?

Ideas:

  • @todo annotation
  • Migrate @rename but mark as unsure
  • Remove @rename altogether

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response

Metadata

Metadata

Assignees

Labels

@renameRelated to the @rename annotationenhancement 💡New feature or requestmigrationMigration of annotation to a new API version

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions