Skip to content

Commit

Permalink
Fix Javadoc across the project
Browse files Browse the repository at this point in the history
Enable failOnWarnings for Javadoc to keep them clean.
  • Loading branch information
kanterov committed Jun 17, 2020
1 parent 5e0a011 commit 8c41f6b
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,18 @@ public static ContainerError create(String code, String message, Kind kind) {

/**
* Returns a simplified code for errors, so that we can provide a glossary of all possible errors.
*
* @return error code
*/
public String getCode() {
return code;
}

/** Returns an abstract error kind for this error. */
/**
* Returns an abstract error kind for this error.
*
* @return error kind
*/
public Kind getKind() {
return kind;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,12 @@ public interface FileSystem {
@MustBeClosed
WritableByteChannel writer(String uri);

/** Returns Manifest for given resource, or null if it doesn't exist. */
/**
* Returns Manifest for given resource, or null if it doesn't exist.
*
* @param uri uri
* @return manifest
*/
@Nullable
Manifest getManifest(String uri);
}
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ class ExecutionNodeCompiler {
/**
* Given a list of flytekit-api nodes, validates them, and determines their sequential execution
* order.
*
* @param nodes nodes
* @param runnableTasks runnable tasks
* @return execution nodes
*/
static List<ExecutionNode> compile(List<Node> nodes, Map<String, RunnableTask> runnableTasks) {
List<ExecutionNode> executableNodes =
Expand Down Expand Up @@ -91,6 +95,9 @@ static ExecutionNode compile(Node node, Map<String, RunnableTask> runnableTasks)
* priority. If two nodes have the same depth, relative order in input list is used. Because of
* that, the implementation is slightly different from what you would normally see for topological
* sorting.
*
* @param nodes nodes
* @return execution nodes
*/
static List<ExecutionNode> sort(List<ExecutionNode> nodes) {
// priority is initial order in the list, node earlier in the list
Expand Down

0 comments on commit 8c41f6b

Please sign in to comment.