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

Fixing MHQ's Javadoc Build #3115

Merged
merged 2 commits into from
Feb 19, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
3 changes: 1 addition & 2 deletions MekHQ/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -591,8 +591,7 @@ publishing {
artifactId = "mekhq${mmBranchTag}"
from components.java
artifact sourcesJar
// Javadoc is full of errors
// artifact javadocJar
artifact javadocJar

pom {
name = "MekHQ"
Expand Down
2 changes: 1 addition & 1 deletion MekHQ/src/mekhq/Action.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Action.java
*
* Copyright (c) 2019 Vicente Cartas Espinel <vicente.cartas at outlook.com>. All rights reserved.
* Copyright (c) 2019 Vicente Cartas Espinel (vicente.cartas at outlook.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down
2 changes: 1 addition & 1 deletion MekHQ/src/mekhq/MekHQ.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* MekHQ.java
*
* Copyright (c) 2009 - Jay Lawson <jaylawson39 at yahoo.com>. All Rights Reserved.
* Copyright (c) 2009 - Jay Lawson (jaylawson39 at yahoo.com). All Rights Reserved.
* Copyright (c) 2020-2022 - The MegaMek Team. All Rights Reserved.
*
* This file is part of MekHQ.
Expand Down
2 changes: 1 addition & 1 deletion MekHQ/src/mekhq/Utilities.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Utilities.java
*
* Copyright (c) 2009 Jay Lawson <jaylawson39 at yahoo.com>. All rights reserved.
* Copyright (c) 2009 Jay Lawson (jaylawson39 at yahoo.com). All rights reserved.
* Copyright (c) 2019 The MekHQ Team.
*
* This file is part of MekHQ.
Expand Down
8 changes: 4 additions & 4 deletions MekHQ/src/mekhq/campaign/Campaign.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Campaign.java
*
* Copyright (c) 2009 Jay Lawson <jaylawson39 at yahoo.com>. All rights reserved.
* Copyright (c) 2009 Jay Lawson (jaylawson39 at yahoo.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down Expand Up @@ -1592,7 +1592,7 @@ public Collection<Person> getPersonnel() {

/**
* Provides a filtered list of personnel including only active Persons.
* @return List<Person>
* @return a {@link Person} <code>List</code> containing all active personnel
*/
public List<Person> getActivePersonnel() {
List<Person> activePersonnel = new ArrayList<>();
Expand Down Expand Up @@ -2128,7 +2128,7 @@ public TargetRoll getTargetFor(Person medWork, Person doctor) {
/**
* Gets a list of applicable logistics personnel, or an empty list
* if acquisitions automatically succeed.
* @return A {@see List} of personnel who can perform logistical actions.
* @return A <code>List</code> of {@link Person} who can perform logistical actions.
*/
public List<Person> getLogisticsPersonnel() {
String skill = getCampaignOptions().getAcquisitionSkill();
Expand Down Expand Up @@ -2393,7 +2393,7 @@ public boolean canAcquireParts(@Nullable Person person) {
* Checks whether the campaign can pay for a given <code>IAcquisitionWork</code> item. This will check
* both whether the campaign is required to pay for a given type of acquisition by the options and
* if so whether it has enough money to afford it.
* @param acquisition - An <code>IAcquisitionWork<code> object
* @param acquisition - An <code>IAcquisitionWork</code> object
* @return true if the campaign can pay for the acquisition; false if it cannot.
*/
public boolean canPayFor(IAcquisitionWork acquisition) {
Expand Down
2 changes: 1 addition & 1 deletion MekHQ/src/mekhq/campaign/CampaignOptions.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009 - Jay Lawson <jaylawson39 at yahoo.com>. All Rights Reserved.
* Copyright (c) 2009 - Jay Lawson (jaylawson39 at yahoo.com). All Rights Reserved.
* Copyright (c) 2020-2021 - The MegaMek Team. All Rights Reserved.
*
* This file is part of MekHQ.
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/CurrentLocation.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* CurrentLocation.java
*
* Copyright (c) 2011 Jay Lawson <jaylawson39 at yahoo.com>. All rights reserved.
* Copyright (c) 2011 Jay Lawson (jaylawson39 at yahoo.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down Expand Up @@ -43,7 +43,7 @@
* where we want to let a force be in different locations, this will
* make it easier to keep track of everything
*
* @author Jay Lawson <jaylawson39 at yahoo.com>
* @author Jay Lawson (jaylawson39 at yahoo.com)
*/
public class CurrentLocation {
private PlanetarySystem currentSystem;
Expand Down
10 changes: 5 additions & 5 deletions MekHQ/src/mekhq/campaign/ExtraData.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@
* <p>
* - creating keys
* <pre>
* ExtraData.Key<Integer> INTKEY = new ExtraData.IntKey("int_key");
* ExtraData.Key<Double> DOUBLEKEY = new ExtraData.DoubleKey("double_key");
* ExtraData.Key<DateTime> DATEKEY = new ExtraData.DateKey("current date");
* ExtraData.Key<Boolean> BOOLEANKEY = new ExtraData.BooleanKey("realy?");
* ExtraData.Key<String> PLAIN_OLD_BORING_KEY = new ExtraData.StringKey("stuff");
* ExtraData.Key&lt;Integer&gt; INTKEY = new ExtraData.IntKey("int_key");
* ExtraData.Key&lt;Double&gt; DOUBLEKEY = new ExtraData.DoubleKey("double_key");
* ExtraData.Key&lt;DateTime&gt; DATEKEY = new ExtraData.DateKey("current date");
* ExtraData.Key&lt;Boolean&gt; BOOLEANKEY = new ExtraData.BooleanKey("realy?");
* ExtraData.Key&lt;String&gt; PLAIN_OLD_BORING_KEY = new ExtraData.StringKey("stuff");
* </pre>
* - setting and getting data
* <pre>
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/JumpPath.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* JumpPath,java
*
* Copyright (c) 2011 Jay Lawson <jaylawson39 at yahoo.com>. All rights reserved.
* Copyright (c) 2011 Jay Lawson (jaylawson39 at yahoo.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down Expand Up @@ -38,7 +38,7 @@
* this object will need to spit out a list of planet names and then reconstruct
* the planets from that.
*
* @author Jay Lawson <jaylawson39 at yahoo.com>
* @author Jay Lawson (jaylawson39 at yahoo.com)
*/
public class JumpPath {
private List<PlanetarySystem> path;
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/Kill.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Kill.java
*
* Copyright (c) 2011 Jay Lawson <jaylawson39 at yahoo.com>. All rights reserved.
* Copyright (c) 2011 Jay Lawson (jaylawson39 at yahoo.com). All rights reserved.
* Copyright (c) 2020 - The MegaMek Team. All Rights Reserved.
*
* This file is part of MekHQ.
Expand Down Expand Up @@ -34,7 +34,7 @@
/**
* A kill record
*
* @author Jay Lawson <jaylawson39 at yahoo.com>
* @author Jay Lawson (jaylawson39 at yahoo.com)
*/
public class Kill {
private UUID pilotId;
Expand Down
2 changes: 1 addition & 1 deletion MekHQ/src/mekhq/campaign/RandomSkillPreferences.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* RandomSkillPreferences.java
*
* Copyright (c) 2009 Jay Lawson <jaylawson39 at yahoo.com>. All rights reserved.
* Copyright (c) 2009 Jay Lawson (jaylawson39 at yahoo.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/ResolveScenarioTracker.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* ResolveScenarioTracker.java
*
* Copyright (c) 2009 Jay Lawson <jaylawson39 at yahoo.com>. All rights reserved.
* Copyright (c) 2009 Jay Lawson (jaylawson39 at yahoo.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down Expand Up @@ -53,7 +53,7 @@
* This object will be the main workhorse for the scenario
* resolution wizard. It will keep track of information and be
* fed back and forth between the various wizards
* @author Jay Lawson <jaylawson39 at yahoo.com>
* @author Jay Lawson (jaylawson39 at yahoo.com)
*/
public class ResolveScenarioTracker {
Map<UUID, Entity> entities;
Expand Down
4 changes: 1 addition & 3 deletions MekHQ/src/mekhq/campaign/event/OrganizationChangedEvent.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,15 @@
* You should have received a copy of the GNU General Public License
* along with MekHQ. If not, see <http://www.gnu.org/licenses/>.
*/

package mekhq.campaign.event;

import megamek.common.event.MMEvent;
import mekhq.campaign.force.Force;
import mekhq.campaign.unit.Unit;

/**
* Triggered when the TO&E structure changes by adding, removing, or moving a force or adding or removing
* Triggered when the TO&amp;E structure changes by adding, removing, or moving a force or adding or removing
* a unit.
*
*/
public class OrganizationChangedEvent extends MMEvent {

Expand Down
16 changes: 2 additions & 14 deletions MekHQ/src/mekhq/campaign/finances/Accountant.java
Original file line number Diff line number Diff line change
Expand Up @@ -152,20 +152,8 @@ public Money getMonthlyAmmo() {
}

/**
* Calculate the total value of units in the TO&E. This serves as the basis for contract payments in the StellarOps
* Beta.
*
* @return
*/
public Money getForceValue() {
return getForceValue(false);
}

/**
* Calculate the total value of units in the TO&E. This serves as the basis for contract payments in the StellarOps
* Beta.
*
* @return
* @return the total value of units in the TO&amp;E. This serves as the basis for contract payments
* in the StellarOps Beta.
*/
public Money getForceValue(boolean noInfantry) {
Money value = Money.zero();
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/finances/Asset.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Asset.java
*
* Copyright (c) 2009 - Jay Lawson <jaylawson39 at yahoo.com>. All Rights Reserved.
* Copyright (c) 2009 - Jay Lawson (jaylawson39 at yahoo.com). All Rights Reserved.
* Copyright (c) 2021 - The MegaMek Team. All Rights Reserved.
*
* This file is part of MekHQ.
Expand Down Expand Up @@ -33,7 +33,7 @@
* An Asset is a non-core (i.e. not part of the core company) investment that a user can use to
* generate income on a schedule. It can also be used increase loan collateral and thus get bigger
* loans.
* @author Jay Lawson <jaylawson39 at yahoo.com>
* @author Jay Lawson (jaylawson39 at yahoo.com)
* @author Justin "Windchild" Bowen (modern version)
*/
public class Asset {
Expand Down
6 changes: 2 additions & 4 deletions MekHQ/src/mekhq/campaign/finances/Currency.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Currency.java
*
* Copyright (c) 2019 Vicente Cartas Espinel <vicente.cartas at outlook.com>. All rights reserved.
* Copyright (c) 2019 Vicente Cartas Espinel (vicente.cartas at outlook.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand All @@ -18,7 +18,6 @@
* You should have received a copy of the GNU General Public License
* along with MekHQ. If not, see <http://www.gnu.org/licenses/>.
*/

package mekhq.campaign.finances;

import org.joda.money.CurrencyUnit;
Expand All @@ -27,8 +26,7 @@
* This class represents a currency that will be associated
* with monetary amounts.
*
* @author Vicente Cartas Espinel <vicente.cartas at outlook.com>
*
* @author Vicente Cartas Espinel (vicente.cartas at outlook.com)
*/
public class Currency {
private CurrencyUnit wrapped;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* CurrencyDataLookupWriter.java
*
* Copyright (c) 2019 Vicente Cartas Espinel <vicente.cartas at outlook.com>. All rights reserved.
* Copyright (c) 2019 Vicente Cartas Espinel (vicente.cartas at outlook.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down Expand Up @@ -32,7 +32,7 @@
* This is the writer used to write extra currency data based
* on the currency code.
*
* @author Vicente Cartas Espinel <vicente.cartas at outlook.com>
* @author Vicente Cartas Espinel (vicente.cartas at outlook.com)
*/
class CurrencyDataLookupWriter implements MoneyPrinter {
private Map<String, String> currencyExtraData;
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/finances/CurrencyManager.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* CurrencyManager.java
*
* Copyright (c) 2019 Vicente Cartas Espinel <vicente.cartas at outlook.com>. All rights reserved.
* Copyright (c) 2019 Vicente Cartas Espinel (vicente.cartas at outlook.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down Expand Up @@ -47,7 +47,7 @@
*
* There should be only one instance of this class.
*
* @author Vicente Cartas Espinel <vicente.cartas at outlook.com>
* @author Vicente Cartas Espinel (vicente.cartas at outlook.com)
*/
public class CurrencyManager extends CurrencyUnitDataProvider {
private static final CurrencyManager instance = new CurrencyManager();
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/finances/Finances.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009 - Jay Lawson <jaylawson39 at yahoo.com>. All rights reserved.
* Copyright (c) 2009 - Jay Lawson (jaylawson39 at yahoo.com). All rights reserved.
* Copyright (c) 2020 - The MegaMek Team. All rights reserved.
*
* This file is part of MekHQ.
Expand Down Expand Up @@ -53,7 +53,7 @@
import java.util.stream.Collectors;

/**
* @author Jay Lawson <jaylawson39 at yahoo.com>
* @author Jay Lawson (jaylawson39 at yahoo.com)
*/
public class Finances {
private final transient ResourceBundle resourceMap = ResourceBundle.getBundle("mekhq.resources.Finances",
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/finances/Loan.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Loan.java
*
* Copyright (c) 2009 - Jay Lawson <jaylawson39 at yahoo.com>. All Rights Reserved.
* Copyright (c) 2009 - Jay Lawson (jaylawson39 at yahoo.com). All Rights Reserved.
* Copyright (c) 2020-2021 - The MegaMek Team. All Rights Reserved.
*
* This file is part of MekHQ.
Expand Down Expand Up @@ -38,7 +38,7 @@
/**
* TODO : Update loan baseline based on latest Campaign Operations Rules
* TODO : Move MADE_UP_INSTITUTIONS to data
* @author Jay Lawson <jaylawson39 at yahoo.com>
* @author Jay Lawson (jaylawson39 at yahoo.com)
*/
public class Loan {
//region Variable Declarations
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/finances/Money.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Money.java
*
* Copyright (c) 2019 - Vicente Cartas Espinel <vicente.cartas at outlook.com>. All Rights Reserved.
* Copyright (c) 2019 - Vicente Cartas Espinel (vicente.cartas at outlook.com). All Rights Reserved.
* Copyright (c) 2020-2021 - The MegaMek Team. All Rights Reserved.
*
* This file is part of MekHQ.
Expand Down Expand Up @@ -32,7 +32,7 @@
* This class represents an quantity of money and its associated
* currency.
*
* @author Vicente Cartas Espinel <vicente.cartas at outlook.com>
* @author Vicente Cartas Espinel (vicente.cartas at outlook.com)
*/
public class Money implements Comparable<Money> {
private BigMoney wrapped;
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/finances/Transaction.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Transaction.java
*
* Copyright (c) 2009 - Jay Lawson <jaylawson39 at yahoo.com>. All Rights Reserved.
* Copyright (c) 2009 - Jay Lawson (jaylawson39 at yahoo.com). All Rights Reserved.
* Copyright (c) 2020-2021 - The MegaMek Team. All Rights Reserved.
*
* This file is part of MekHQ.
Expand Down Expand Up @@ -33,7 +33,7 @@
import java.util.Objects;

/**
* @author Jay Lawson <jaylawson39 at yahoo.com>
* @author Jay Lawson (jaylawson39 at yahoo.com)
*/
public class Transaction {
//region Variable Declarations
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/campaign/finances/XmlMoneyParser.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* XmlMoneyParser.java
*
* Copyright (c) 2019 Vicente Cartas Espinel <vicente.cartas at outlook.com>. All rights reserved.
* Copyright (c) 2019 Vicente Cartas Espinel (vicente.cartas at outlook.com). All rights reserved.
*
* This file is part of MekHQ.
*
Expand Down Expand Up @@ -31,7 +31,7 @@
* This is the parser used to read money amounts from strings that came from
* XML data files.
*
* @author Vicente Cartas Espinel <vicente.cartas at outlook.com>
* @author Vicente Cartas Espinel (vicente.cartas at outlook.com)
*/
class XmlMoneyParser implements MoneyParser {
@Override
Expand Down
Loading