Skip to content

Commit

Permalink
docs: fix javadoc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
mjeanroy committed May 4, 2024
1 parent d07eec9 commit b04582f
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* Create a logger that process {@code npm} command output and redirect
* the line to a maven logger with the appropriate log level.
*
* <h3>How is the log level detected?</h3>
* <h2>How is the log level detected?</h2>
*
* The log level is detected using {@code npm} output:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ public final class EngineConfig {
*/
private Map<String, String> requirements;

/**
* Create default config.
*/
public EngineConfig() {
this.strict = false;
this.requirements = new LinkedHashMap<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ public final class IncrementalBuildConfiguration {
*/
private IncrementalBuildGoalConfiguration preClean;

/**
* Create configuration with default settings.
*/
public IncrementalBuildConfiguration() {
this.enabled = true;
this.useDefaultIncludes = true;
Expand Down Expand Up @@ -380,7 +383,7 @@ private List<String> goalIncludes(String goal) {
return configuration == null ? Collections.<String>emptyList() : configuration.getIncludes();
}

public List<String> goalExcludes(String goal) {
private List<String> goalExcludes(String goal) {
IncrementalBuildGoalConfiguration configuration = getGoalConfiguration(goal);
return configuration == null ? Collections.<String>emptyList() : configuration.getExcludes();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ public final class IncrementalBuildGoalConfiguration {
*/
private boolean useDefaultExcludes;

/**
* Create configuration with default settings.
*/
public IncrementalBuildGoalConfiguration() {
this.enabled = true;
this.includes = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,31 @@
*/
public enum LockStrategy {

/**
* Read strategy: acquire a read lock.
*/
READ {
@Override
public Lock getLock(ReadWriteLock rwLock) {
return rwLock.readLock();
}
},

/**
* Write strategy: acquire a write lock.
*/
WRITE {
@Override
public Lock getLock(ReadWriteLock rwLock) {
return rwLock.writeLock();
}
};

/**
* Acquire lock, given "this" strategy.
*
* @param rwLock The lock.
* @return The lock.
*/
public abstract Lock getLock(ReadWriteLock rwLock);
}

0 comments on commit b04582f

Please sign in to comment.