Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

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

Open
haolingdong-msft opened this issue May 23, 2024 · 1 comment
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. DPG

Comments

@haolingdong-msft
Copy link
Member

haolingdong-msft commented May 23, 2024

Link #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;
    }
@haolingdong-msft haolingdong-msft changed the title javadoc, do not generate default javadoc description if it is not defined in tsp/swagger javadoc, do not generate default javadoc description if description is not defined in tsp/swagger May 23, 2024
@weidongxu-microsoft
Copy link
Member

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

@weidongxu-microsoft weidongxu-microsoft added Client This issue points to a problem in the data-plane of the library. DPG labels May 23, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Client This issue points to a problem in the data-plane of the library. DPG
Projects
None yet
Development

No branches or pull requests

2 participants