Created by: jmini
PR checklist
-
Read the contribution guidelines. -
Ran the shell script under ./bin/
to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh
and./bin/security/{LANG}-petstore.sh
if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\
. -
Filed the PR against the correct branch: master
,. Default:3.4.x
,4.0.x
master
. -
Copied the technical committee to review the pull request if your PR is targeting a particular programming language. @bbdouglas (2017/07) @JFCote (2017/08) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01)
Description of the PR
Generate javadoc for enum (based on x-enum-descriptions
) for JaxRS, see #1693 for more details.
Tested with:
weather:
type: object
properties:
type:
type: integer
format: int32
enum:
- 1
- 2
- 3
x-enum-descriptions:
- 'Blue sky'
- 'Slightly overcast'
- 'Take an umbrella with you'
x-enum-varnames:
- Sunny
- Cloudy
- Rainy
Produces:
--- a/Weather.java
+++ b/Weather.java
@@ -31,10 +31,19 @@
* Gets or Sets type
*/
public enum TypeEnum {
+ /**
+ * Blue sky
+ */
Sunny(1),
+ /**
+ * Slightly overcast
+ */
Cloudy(2),
+ /**
+ * Take an umbrella with you
+ */
Rainy(3);
private Integer value;