bluelinelabs / bluelinelabs/LoganSquare

@Documented attribute for annotations

Open
#178 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
3.2k
Forks
303
PR merge metrics
No merged PRs in 30d

Description

Can we have `@Documented` attribute for the annotations used by Logan Square.

We generate javadoc for our network layer to take a API snapshot per release of our mobile app. The annotations are not documented and we loose information on attribute name in json.

Raised a similar issue in gson which was addressed quickly =>
https://github.com/google/gson/issues/921
https://github.com/google/gson/issues/922

Let me know if you need more details.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the annotations used by Logan Square and compare the requested behavior with the linked Gson issues. Verify the generated Javadoc and JSON API snapshot retain annotation attribute names; completion means the relevant annotations are documented without losing those names.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, java
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.