This module provides an annotation processor that can write Op YAML, based on Op descriptions written purely in Javadoc!
To enable Op YAML generation in your build process, add the following to your pom.xml:
<properties>
<scijava.ops.parse>true</scijava.ops.parse>
</properties>NOTE: Until this repository is moved out of the SciJava Incubator and the following is added to pom-scijava, the following must also be added to your POM:
<build>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>org.scijava</groupId>
<artifactId>scijava-ops-indexer</artifactId>
<version>${project.version}</version>
</path>
</annotationProcessorPaths>
<fork>true</fork>
<showWarnings>true</showWarnings>
<compilerArgs>
<arg>-Ascijava.ops.parse="${scijava.ops.parse}"</arg>
<arg>-Ascijava.ops.opVersion="${project.version}"</arg>
</compilerArgs>
</configuration>
</plugin>
</plugins>
</build>To add a tag to any AnnotatedElement as an Op, one can simply insert the following tag into its Javadoc:
@implNote op names='<comma-separated list of names>'For example, if you insert the @implNote op tag into the following static method
/**
* Some example Op
*
* @param d1 the first {@link Double}
* @param d2 the second {@link Double}
* @return the sum
* @author Gabriel Selzer
* @implNote op names='math.add'
*/
public static Double add(final Double d1, final Double d2) {
return d1 + d2;
}This annotation processor might create the following file ops.yaml within the JAR build by Maven:
- op:
names: [math.add]
description: |2
Some example Op
source: javaMethod:/com.example.foo.Bar.add%28java.lang.Double%2Cjava.lang.Double%29
priority: 0.0
version: 1.2.3
parameters:
- parameter type: INPUT
name: d1
description: |
the first {@link Double}
type: java.lang.Double
- parameter type: INPUT
name: d2
description: |
the second {@link Double}
type: java.lang.Double
- parameter type: OUTPUT
name: output
description: |
the sum
type: java.lang.Double
authors:
- |
Gabriel Selzer
tags: {}This YAML file can then be ingested by the SciJava Ops Engine (add link), and your Ops will automatically become available in any environment including your JAR!