JetBrains / JetBrains/ExternalAnnotations

Generate external annotations

Open
#174 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
84
Forks
46
Avg merge
6h 55m
Merged PRs (30d)
1

Description

Are there any plans to provide an automated synchronized way to switch between use of annotations.xml and code attributes, possibly choosing annotations source?

Imagine an external repository which is being forked. The source code has no annotations and originally coded without the use of R#. So I put annotations wherever possible, getting all sorts of NRE possible bugs fixed. Now I have a JetBrains.Annotations package dependency in every project and repository maintainer wouldn't accept a PR with that.

A good solution is to ship a xml along with PR, but there's a problem...
ExternalAnnotations.xml is not being generated automatically from annotated code and not quite trivial to build manually.

By adding attributes in code ([NotNull] etc.) these could be automatically added into xml and then shown from these. And then NuGet package reference wouldn't be necessary in the first place as well as attributes themselves in the code.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.