Azure / autorest.java

Extension for AutoRest (https://github.com/Azure/autorest) that generates Java code
MIT License
32 stars 80 forks source link

javadoc, do not generate default javadoc description if description is not defined in tsp/swagger #2782

Open haolingdong-msft opened 1 month ago

haolingdong-msft commented 1 month ago

Link https://github.com/Azure/autorest.java/pull/2776

We generate a dummy description e.g. "The configuration property." in below example if both description and summary are not defined on the model property or client method parameter. It is meaningless and we cannot easily distinguish whether the javadoc is dummy or created by service team. So we would like to remove it.

 /**
+     * Set the configuration property: The configuration property.
     * 
     * @param configuration the configuration value to set.
     * @return the JobData object itself.
     */
    @Generated
    public JobData setConfiguration(String configuration) {
        this.configuration = configuration;
        return this;
    }
weidongxu-microsoft commented 1 month ago

This applies to @param (and in some cases, the @return) as well.