search

spotify / dataenum

Algebraic data types in Java.
Apache License 2.0
166 stars 16 forks source link

Improve Javadoc in generated classes #30

Closed pettermahlen closed 5 years ago

pettermahlen commented 5 years ago

This PR does the following:

  1. Adds a link to the original _dataenum definition as a top-level comment in the generated source.
  2. Adds a link from each case factory method to the case definition in the source _dataenum.
  3. If a case definition has javadoc comments, it copies these comments to the case factory method.

It also makes some changes to dependencies and Travis config in order to keep up with developments in JDKs.

codecov[bot] commented 5 years ago

Codecov Report

Merging #30 into master will increase coverage by 1.53%. The diff coverage is 100%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master      #30      +/-   ##
============================================
+ Coverage     94.41%   95.94%   +1.53%     
- Complexity      218      222       +4     
============================================
  Files            23       23              
  Lines           662      666       +4     
  Branches        100      102       +2     
============================================
+ Hits            625      639      +14     
+ Misses           30       20      -10     
  Partials          7        7
Impacted Files Coverage Δ Complexity Δ
...spotify/dataenum/processor/parser/ValueParser.java 100% <100%> (+2.12%) 15 <0> (+1) :arrow_up:
...ava/com/spotify/dataenum/processor/data/Value.java 88.88% <100%> (+3.17%) 4 <2> (+1) :arrow_up:
...taenum/processor/generator/value/ValueMethods.java 100% <100%> (ø) 13 <0> (+1) :arrow_up:
...enum/processor/generator/spec/SpecTypeFactory.java 100% <100%> (+2.7%) 3 <0> (ø) :arrow_down:
...m/spotify/dataenum/processor/data/OutputValue.java 100% <100%> (ø) 12 <1> (+1) :arrow_up:
...m/processor/generator/data/OutputValueFactory.java 92.15% <100%> (+1.77%) 19 <0> (ø) :arrow_down:
...um/processor/generator/value/ValueTypeFactory.java 98.94% <0%> (+0.52%) 56% <0%> (ø) :arrow_down:
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 62bb14e...2e89dda. Read the comment docs.