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

Javadoc fix: add literal in mail addresses #76

Merged
merged 4 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class CommonFile {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class Core {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class CorePool {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public class CsvMpiStatistics implements MpiStatistics {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public class CsvMpiStatisticsFactory implements MpiStatisticsFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
@AutoService(Tool.class)
public class ExportTasksStatisticsTool implements Tool {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import java.util.List;

/**
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public class JniMpiNativeServices implements MpiNativeServices {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public class MpiComputationManager implements ComputationManager {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class MpiComputationResourcesStatus implements ComputationResourcesStatus {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import java.util.concurrent.TimeUnit;

/**
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public class MpiExecutorContext {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public class MpiJob {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import java.util.concurrent.CompletableFuture;

/**
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public interface MpiJobScheduler {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import java.util.zip.GZIPInputStream;

/**
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class MpiJobSchedulerImpl implements MpiJobScheduler {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public final class MpiMaster {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import java.util.List;

/**
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public interface MpiNativeServices {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class MpiRank {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class MpiResources {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public interface MpiStatistics extends AutoCloseable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public interface MpiStatisticsFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class MpiTask {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import java.nio.file.Path;

/**
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public final class MpiToolUtil {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public class NoMpiStatistics implements MpiStatistics {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
public class NoMpiStatisticsFactory implements MpiStatisticsFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class ProfiledExecutionListener implements ExecutionListener {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class CorePoolTest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

/**
*
* @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
* @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
*/
class MpiComputationManagerTest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import static org.junit.jupiter.api.Assertions.assertTrue;

/**
* @author Yichen TANG <yichen.tang at rte-france.com>
* @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
*/
public abstract class AbstractIntegrationTests {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.nio.file.Path;

/**
* @author Yichen TANG <yichen.tang at rte-france.com>
* @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
*/
abstract class AbstractReturnOKExecutionHandler extends AbstractExecutionHandler<String> {
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
import static org.junit.jupiter.api.Assertions.assertTrue;

/**
* @author Yichen TANG <yichen.tang at rte-france.com>
* @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
*/
@Disabled("Slurm integration tests must be run locally.")
class SlurmCancelExecutionTest extends AbstractIntegrationTests {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
import static org.junit.jupiter.api.Assertions.fail;

/**
* @author Yichen TANG <yichen.tang at rte-france.com>
* @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
*/
@Disabled("Slurm integration tests must be run locally.")
class SlurmInvalidExecutionTest extends AbstractIntegrationTests {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
import static org.junit.jupiter.api.Assertions.*;

/**
* @author Yichen TANG <yichen.tang at rte-france.com>
* @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
*/
@Disabled("Slurm integration tests must be run locally.")
@TestMethodOrder(MethodName.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import static org.junit.jupiter.api.Assertions.*;

/**
* @author Yichen TANG <yichen.tang at rte-france.com>
* @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
*/
@Disabled("Slurm integration tests must be run locally.")
class SlurmOtherCaseTest extends AbstractIntegrationTests {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import java.util.Objects;

/**
* @author Yichen Tang <yichen.tang at rte-france.com>
* @author Yichen Tang {@literal <yichen.tang at rte-france.com>}
*/
abstract class AbstractSlurmCmd<T> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import java.util.Objects;

/**
* @author Yichen Tang <yichen.tang at rte-france.com>
* @author Yichen Tang {@literal <yichen.tang at rte-france.com>}
*/
public abstract class AbstractSlurmCmdResult implements SlurmCmdResult {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* Abstract base class for jobs monitors, in charge of monitoring the status
* of submitted jobs.
*
* @author Sylvain Leclerc <sylvain.leclerc at rte-france.com>
* @author Sylvain Leclerc {@literal <sylvain.leclerc at rte-france.com>}
*/
public abstract class AbstractSlurmJobMonitor implements Runnable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import static com.powsybl.computation.slurm.SlurmConstants.BATCH_EXT;

/**
* @author Yichen TANG <yichen.tang at rte-france.com>
* @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
*/
public abstract class AbstractTask implements SlurmTask {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
/**
* Simple interface to execute shell commands, 1 at a time.
*
* @author Sylvain Leclerc <sylvain.leclerc at rte-france.com>
* @author Sylvain Leclerc {@literal <sylvain.leclerc at rte-france.com>}
*/
public interface CommandExecutor extends AutoCloseable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* The results of the execution of a shell command:
* the exit code, and standard output and standard error as strings.
*
* @author Sylvain Leclerc <sylvain.leclerc at rte-france.com>
* @author Sylvain Leclerc {@literal <sylvain.leclerc at rte-france.com>}
*/
public record CommandResult(int exitCode, String stdOut, String stdErr) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import static java.util.Objects.requireNonNull;

/**
* @author Sylvain Leclerc <sylvain.leclerc at rte-france.com>
* @author Sylvain Leclerc {@literal <sylvain.leclerc at rte-france.com>}
*/
final class CommandUtils {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import java.util.concurrent.TimeUnit;

/**
* @author Sylvain Leclerc <sylvain.leclerc at rte-france.com>
* @author Sylvain Leclerc {@literal <sylvain.leclerc at rte-france.com>}
*/
class ConcurrentSshCommandRunner extends CommandRunner {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/**
* A job monitor which relies on the creation of "flag" files at the end of submitted jobs.
*
* @author Yichen Tang <yichen.tang at rte-france.com>
* @author Yichen Tang {@literal <yichen.tang at rte-france.com>}
*/
class FlagFilesMonitor extends AbstractSlurmJobMonitor {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* A {@link SlurmTask} which submits commands as job arrays when possible,
* in particular for commands with execution count > 1.
*
* @author Yichen TANG <yichen.tang at rte-france.com>
* @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
*/
class JobArraySlurmTask extends AbstractTask {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* Executes shell commands using the local OS.
*
* @author Sylvain Leclerc <sylvain.leclerc at rte-france.com>
* @author Sylvain Leclerc {@literal <sylvain.leclerc at rte-france.com>}
*/
class LocalCommandExecutor implements CommandExecutor {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* An individual job submitted to slurm, an which completion or failure
* needs to be monitored.
*
* @author Sylvain Leclerc <sylvain.leclerc at rte-france.com>
* @author Sylvain Leclerc {@literal <sylvain.leclerc at rte-france.com>}
*/
public interface MonitoredJob {

Expand Down
Loading