Navigation Menu

Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Handling of descriptions #55

Merged
merged 4 commits into from Nov 5, 2022
Merged

Handling of descriptions #55

merged 4 commits into from Nov 5, 2022

Conversation

britter
Copy link
Member

@britter britter commented Nov 3, 2022

Descriptions are now rendered into the the JavaDoc of getters.

Resolves #52, #53

Add tests for up to date, build cache and configuration cache behavior
of the PluginCodeGeneration task.
@britter britter changed the title bene/issue/52+53 Handling of descriptions Nov 3, 2022
@britter britter self-assigned this Nov 3, 2022
@britter britter linked an issue Nov 3, 2022 that may be closed by this pull request
Copy link
Member

@jjohannes jjohannes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good 👍

We should update the documentation about groups as well (add the description). This can be a follow up.

I tried this on a project and one thing I noticed, which is only indirectly related, is that if you navigate into the code to see the description, you also see all this implementation details clutter (like the injecting constructor). E.g.:


public abstract class Catalina {
    private final org.gradle.api.provider.Provider<String> home;
    @Inject
    public Catalina(ProviderFactory providers, ObjectFactory objects) {
        this.home = providers.gradleProperty("catalina.home").orElse(providers.environmentVariable("CATALINA_HOME"));
    }
    /**
     * Root of the Tomcat installation
     */
    public org.gradle.api.provider.Provider<String> getHome() {
        return this.home;
    }
}

We could consider generating interfaces for the extension and the group and work only with these in the type signatures. And then the JavaDoc would also go only there.

Getters for parameters and group now have JavaDoc comments containing
the stripped description.

Resolves #53
@britter britter merged commit 81fa271 into main Nov 5, 2022
@britter britter deleted the bene/issue/52+53 branch November 5, 2022 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Render descriptions into getters JavaDoc Groups should have a description
2 participants