Skip to content

Commit

Permalink
Fix Javadoc warnings regarding author's email address (#66)
Browse files Browse the repository at this point in the history
* Add literal annotation in author's email address
* Add missing author mentions

---------

Signed-off-by: Sophie Frasnedo <[email protected]>
  • Loading branch information
So-Fras authored Apr 18, 2024
1 parent a4f69bd commit bc625da
Show file tree
Hide file tree
Showing 56 changed files with 71 additions and 59 deletions.
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>}
*/
public class OpenReacConfig {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import static com.powsybl.ampl.converter.AmplConstants.DEFAULT_VARIANT_INDEX;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
* OpenReac: a reactive opf to set target tension of the generators.
* Enumeration to link resources ampl models to java code.
* It allows to get the list of InputStream of the ampl model resources.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import java.util.concurrent.CompletableFuture;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public final class OpenReacRunner {

Expand Down
2 changes: 1 addition & 1 deletion open-reac/src/main/java/com/powsybl/openreac/Reports.java
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import com.powsybl.openreac.parameters.input.algo.OpenReacOptimisationObjective;

/**
* @author Joris Mancini <joris.mancini_externe at rte-france.com>
* @author Joris Mancini {@literal <joris.mancini_externe at rte-france.com>}
*/
public final class Reports {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
/**
* Throw this error when the interface between ampl and java is not correct.
* This is an internal OpenReac error. It is not the user fault.
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class IncompatibleModelException extends PowsyblException {
public IncompatibleModelException(String message) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import com.powsybl.commons.PowsyblException;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class InvalidParametersException extends PowsyblException {
public InvalidParametersException(String message) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import java.util.Objects;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public final class AmplIOUtils {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* However, when adding new inputs (outputs) to OpenReac, one must add {@link AmplInputFile} ({@link AmplOutputFile})
* here through {@link OpenReacAmplIOFiles#getInputParameters} ({@link OpenReacAmplIOFiles#getOutputParameters})
*
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class OpenReacAmplIOFiles implements AmplParameters {

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

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public abstract class AbstractElementsInput implements AmplInputFile {

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

/**
* @author Pierre Arvy <pierre.arvy at artelys.com>
* @author Pierre Arvy {@literal <pierre.arvy at artelys.com>}
*/
public class ConfiguredBusesWithReactiveSlack extends AbstractElementsInput {
public static final String PARAM_BUSES_FILE_NAME = "param_buses_with_reactive_slack.txt";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import java.util.List;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*
* List of generators that are not regulating voltage.
* timestep num bus id
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
/**
* This class stores all inputs parameters specific to the OpenReac optimizer.
*
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Pierre Arvy <pierre.arvy at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
* @author Pierre Arvy {@literal <pierre.arvy at artelys.com>}
*/
public class OpenReacParameters {

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

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*
* List of shunts which section that can be modified by OpenReac.
* timestep num bus id
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import java.util.List;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*
* List of transformers of which tap position can be modified by OpenReac.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
import java.util.Objects;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class VoltageLevelLimitsOverrideInput implements AmplInputFile {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
/**
* Class to store an override of a voltage level voltage limits.
*
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Pierre Arvy <pierre.arvy at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
* @author Pierre Arvy {@literal <pierre.arvy at artelys.com>}
*/
public class VoltageLimitOverride {

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

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class AlgorithmInput implements AmplInputFile {
private static final String ALGORITHM_INPUT_FILE = "param_algo.txt";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
package com.powsybl.openreac.parameters.input.algo;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public interface OpenReacAlgoParam {

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
package com.powsybl.openreac.parameters.input.algo;

/**
* @author Pierre Arvy <pierre.arvy at artelys.com>
* @author Pierre Arvy {@literal <pierre.arvy at artelys.com>}
*/
public enum OpenReacAmplLogLevel {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import com.powsybl.openreac.parameters.input.OpenReacParameters;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public enum OpenReacOptimisationObjective {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
package com.powsybl.openreac.parameters.input.algo;

/**
* @author Pierre Arvy <pierre.arvy at artelys.com>
* @author Pierre Arvy {@literal <pierre.arvy at artelys.com>}
*/
public enum OpenReacSolverLogLevel {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
package com.powsybl.openreac.parameters.input.algo;

/**
* @author Pierre Arvy <pierre.arvy at artelys.com>
* @author Pierre Arvy {@literal <pierre.arvy at artelys.com>}
*/
public enum ReactiveSlackBusesMode {
CONFIGURED("CONFIGURED"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import java.io.IOException;

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

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,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 OpenReacParametersDeserializer extends StdDeserializer<OpenReacParameters> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import java.io.IOException;

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import com.powsybl.openreac.parameters.input.algo.OpenReacAlgoParam;

/**
* @author Hugo Marcellin <hugo.marcelin at rte-france.com>
* @author Hugo Marcellin {@literal <hugo.marcelin at rte-france.com>}
*/

public class OpenReactJsonModule extends SimpleModule {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import java.io.IOException;

/**
* @author Hugo Marcellin <hugo.marcelin at rte-france.com>
* @author Hugo Marcellin {@literal <hugo.marcelin at rte-france.com>}
*/

public class VoltageLimitOverrideDeserializer extends StdDeserializer<VoltageLimitOverride> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.io.IOException;

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

public class VoltageLimitOverrideSerializer extends StdSerializer<VoltageLimitOverride> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import java.util.regex.Pattern;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public abstract class AbstractNoThrowOutput implements NoThrowAmplOutput {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* Interface for output ampl files, which changes the behavior of errors during file reading.
* <p>
* Removes the contract of {@link AmplOutputFile} to throw IOException.
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public interface NoThrowAmplOutput extends AmplOutputFile {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* OpenReac user interface to get results information.
*
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class OpenReacResult {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
package com.powsybl.openreac.parameters.output;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public enum OpenReacStatus {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import java.util.Objects;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
* Reactive slacks in load convention.
*/
public class ReactiveSlackOutput extends AbstractNoThrowOutput {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.*;

/**
* @author Pierre Arvy <pierre.arvy at artelys.com>
* @author Pierre Arvy {@literal <pierre.arvy at artelys.com>}
*/
public class VoltageProfileOutput extends AbstractNoThrowOutput {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* Abstract class that reads output from ampl and generates network modifications
*
* @param <T> The type of modification read in the output file
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public abstract class AbstractNetworkOutput<T extends NetworkModification> extends AbstractNoThrowOutput {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import com.powsybl.iidm.network.Network;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class GeneratorNetworkOutput extends AbstractNetworkOutput<GeneratorModification> {
private static final String ELEMENT = "generators";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

/**
* Data class to store all outputs resulting of NetworkModification.
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class NetworkModifications {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import com.powsybl.iidm.network.ShuntCompensator;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class ShuntCompensatorNetworkOutput extends AbstractNetworkOutput<ShuntCompensatorModification> {
private static final String ELEMENT = "shunts";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import com.powsybl.iidm.network.StaticVarCompensator;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class SvcNetworkOutput extends AbstractNetworkOutput<StaticVarCompensatorModification> {
private static final String ELEMENT = "static_var_compensators";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import com.powsybl.iidm.network.TwoWindingsTransformer;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class TapPositionNetworkOutput extends AbstractNetworkOutput<RatioTapPositionModification> {
private static final String ELEMENT = "rtc";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import com.powsybl.iidm.network.VscConverterStation;

/**
* @author Nicolas Pierre <nicolas.pierre at artelys.com>
* @author Nicolas Pierre {@literal <nicolas.pierre at artelys.com>}
*/
public class VscNetworkOutput extends AbstractNetworkOutput<VscConverterStationModification> {
private static final String ELEMENT = "vsc_converter_stations";
Expand Down
Loading

0 comments on commit bc625da

Please sign in to comment.