Skip to content

Commit

Permalink
added javadoc for properties to be used to understand the settings. A…
Browse files Browse the repository at this point in the history
…lso in description and tags
  • Loading branch information
davidparry committed Sep 30, 2024
1 parent 7d0e682 commit 7026e69
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
4 changes: 2 additions & 2 deletions cover-agent-plugin/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ gradlePlugin {
id = 'ai.qodo.plugin.cover-agent'
implementationClass = 'ai.qodo.cover.plugin.CoverAgentPlugin'
displayName = 'Cover Agent Plugin'
description = 'A plugin to use Cover Agent in Gradle.'
tags = ['cover-agent', 'code-quality', 'unit-testing']
description = 'A plugin to use Cover Agent in Gradle. https://github.com/Codium-ai/cover-agent?tab=readme-ov-file#installation-and-usage'
tags.addAll('cover-agent', 'code-quality', 'unit-testing')

}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import org.gradle.api.provider.Property;

public abstract class CoverAgentExtension {

private final Property<String> apiKey;
private final Property<String> wanDBApiKey;
private final Property<Integer> iterations;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,51 @@ private void init(Project project) {
}


/**
* This is your API key for OpenAI to access their api.
* @return String api key for OpenAI to use in calling the LLM.
*/
@Optional
@Input
public Property<String> getApiKey() {
return apiKey;
}

/**
* Not currently implemented, placeholder for future support.
* @return
*/
@Optional
@Input
public Property<String> getWanDBApiKey() {
return wanDBApiKey;
}

/**
* This is the path to the CoverAgent binary specific to your OS
*
* @return path to the binary example (/Users/davidparry/code/github/base/cover-agent/dist/cover-agent)
*/
@Optional
@Input
public Property<String> getCoverAgentBinaryPath() {
return coverAgentBinaryPath;
}

/**
* This is how many calls to allow using your API keyAI to OpenAI per Test/Source files found.
* @return number of times to call the LLM
*/
@Optional
@Input
public Property<Integer> getIterations() {
return iterations;
}

/**
* The target code coverage you want to obtain
* @return whole number for percentage example 25 for 25% coverage
*/
@Optional
@Input
public Property<Integer> getCoverage() {
Expand Down

0 comments on commit 7026e69

Please sign in to comment.