Class paths in comments

ie3-institute · Feb 5, 2024 · b716f3d · b716f3d
1 parent 665ea83
commit b716f3d
Show file tree

Hide file tree

Showing 28 changed files with 39 additions and 39 deletions.
diff --git a/shared/src/main/scala/edu/ie3/quants/electro/Capacitance.scala b/shared/src/main/scala/edu/ie3/quants/electro/Capacitance.scala
@@ -15,7 +15,7 @@ import edu.ie3.quants._
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.Farads]]
+ * @param value value in [[edu.ie3.quants.electro.Farads]]
  */
 final class Capacitance private (val value: Double, val unit: CapacitanceUnit)
   extends Quantity[Capacitance] {

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/Conductivity.scala b/shared/src/main/scala/edu/ie3/quants/electro/Conductivity.scala
@@ -16,7 +16,7 @@ import edu.ie3.quants.space.Length
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.SiemensPerMeter]]
+ * @param value value in [[edu.ie3.quants.electro.SiemensPerMeter]]
  */
 final class Conductivity private (val value: Double, val unit: ConductivityUnit)
   extends Quantity[Conductivity] {

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/ElectricCurrent.scala b/shared/src/main/scala/edu/ie3/quants/electro/ElectricCurrent.scala
@@ -19,7 +19,7 @@ import edu.ie3.quants.time.{ Seconds, TimeDerivative }
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value the amount of charge in [[squants.electro.Amperes]]'s
+ * @param value the amount of charge in [[edu.ie3.quants.electro.Amperes]]'s
  */
 final class ElectricCurrent private (val value: Double, val unit: ElectricCurrentUnit)
   extends Quantity[ElectricCurrent]
@@ -52,7 +52,7 @@ object ElectricCurrent extends Dimension[ElectricCurrent] with BaseDimension {
 }
 
 /**
- * Base trait for units of [[squants.electro.ElectricCurrent]]
+ * Base trait for units of [[edu.ie3.quants.electro.ElectricCurrent]]
  */
 trait ElectricCurrentUnit extends UnitOfMeasure[ElectricCurrent] with UnitConverter {
   def apply[A](n: A)(implicit num: Numeric[A]) = ElectricCurrent(n, this)

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/ElectricPotential.scala b/shared/src/main/scala/edu/ie3/quants/electro/ElectricPotential.scala
@@ -17,7 +17,7 @@ import edu.ie3.quants.time.{ Seconds, TimeDerivative }
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.Volts]]
+ * @param value value in [[edu.ie3.quants.electro.Volts]]
  */
 final class ElectricPotential private (val value: Double, val unit: ElectricPotentialUnit)
   extends Quantity[ElectricPotential]

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/ElectricalConductance.scala b/shared/src/main/scala/edu/ie3/quants/electro/ElectricalConductance.scala
@@ -15,7 +15,7 @@ import edu.ie3.quants._
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.Siemens]]
+ * @param value value in [[edu.ie3.quants.electro.Siemens]]
  */
 final class ElectricalConductance private (val value: Double, val unit: ElectricalConductanceUnit)
   extends Quantity[ElectricalConductance] {

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/ElectricalResistance.scala b/shared/src/main/scala/edu/ie3/quants/electro/ElectricalResistance.scala
@@ -15,7 +15,7 @@ import edu.ie3.quants._
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.Ohms]]
+ * @param value value in [[edu.ie3.quants.electro.Ohms]]
  */
 final class ElectricalResistance private (val value: Double, val unit: ElectricalResistanceUnit)
   extends Quantity[ElectricalResistance] {

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/Inductance.scala b/shared/src/main/scala/edu/ie3/quants/electro/Inductance.scala
@@ -15,7 +15,7 @@ import edu.ie3.quants._
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.Henry]]
+ * @param value value in [[edu.ie3.quants.electro.Henry]]
  */
 final class Inductance private (val value: Double, val unit: InductanceUnit)
   extends Quantity[Inductance] {

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/MagneticFlux.scala b/shared/src/main/scala/edu/ie3/quants/electro/MagneticFlux.scala
@@ -17,7 +17,7 @@ import edu.ie3.quants.time.TimeIntegral
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.Webers]]
+ * @param value value in [[edu.ie3.quants.electro.Webers]]
  */
 final class MagneticFlux private (val value: Double, val unit: MagneticFluxUnit)
   extends Quantity[MagneticFlux]

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/MagneticFluxDensity.scala b/shared/src/main/scala/edu/ie3/quants/electro/MagneticFluxDensity.scala
@@ -15,7 +15,7 @@ import edu.ie3.quants._
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.Teslas]]
+ * @param value value in [[edu.ie3.quants.electro.Teslas]]
  */
 final class MagneticFluxDensity private (val value: Double, val unit: MagneticFluxDensityUnit)
   extends Quantity[MagneticFluxDensity] {

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/Permeability.scala b/shared/src/main/scala/edu/ie3/quants/electro/Permeability.scala
@@ -20,7 +20,7 @@ import edu.ie3.quants.motion.Newtons
  * @author  cquiroz
  * @since   1.4
  *
- * @param value value in [[squants.electro.HenriesPerMeter]]
+ * @param value value in [[edu.ie3.quants.electro.HenriesPerMeter]]
  */
 final class Permeability private (val value: Double, val unit: PermeabilityUnit)
   extends Quantity[Permeability] {

diff --git a/shared/src/main/scala/edu/ie3/quants/electro/Resistivity.scala b/shared/src/main/scala/edu/ie3/quants/electro/Resistivity.scala
@@ -15,7 +15,7 @@ import edu.ie3.quants._
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.electro.OhmMeters]]
+ * @param value value in [[edu.ie3.quants.electro.OhmMeters]]
  */
 final class Resistivity private (val value: Double, val unit: ResistivityUnit)
   extends Quantity[Resistivity] {

diff --git a/shared/src/main/scala/edu/ie3/quants/energy/Energy.scala b/shared/src/main/scala/edu/ie3/quants/energy/Energy.scala
@@ -24,7 +24,7 @@ import edu.ie3.quants.radio.{ Irradiance, ParticleFlux, WattsPerSquareMeter }
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.energy.WattHours]]
+ * @param value value in [[edu.ie3.quants.energy.WattHours]]
  */
 final class Energy private (val value: Double, val unit: EnergyUnit)
   extends Quantity[Energy]
@@ -95,7 +95,7 @@ final class Energy private (val value: Double, val unit: EnergyUnit)
 }
 
 /**
- * Companion object for [[squants.energy.Energy]]
+ * Companion object for [[edu.ie3.quants.energy.Energy]]
  */
 object Energy extends Dimension[Energy] {
   private[energy] def apply[A](n: A, unit: EnergyUnit)(implicit num: Numeric[A]) = new Energy(num.toDouble(n), unit)
@@ -114,7 +114,7 @@ object Energy extends Dimension[Energy] {
 }
 
 /**
- * Base trait for units of [[squants.energy.Energy]]
+ * Base trait for units of [[edu.ie3.quants.energy.Energy]]
  */
 trait EnergyUnit extends UnitOfMeasure[Energy] with UnitConverter {
   def apply[A](n: A)(implicit num: Numeric[A]) = Energy(n, this)

diff --git a/shared/src/main/scala/edu/ie3/quants/energy/EnergyDensity.scala b/shared/src/main/scala/edu/ie3/quants/energy/EnergyDensity.scala
@@ -18,7 +18,7 @@ import edu.ie3.quants.space.CubicMeters
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.energy.WattHours]]
+ * @param value value in [[edu.ie3.quants.energy.WattHours]]
  */
 final class EnergyDensity private (val value: Double, val unit: EnergyDensityUnit)
   extends Quantity[EnergyDensity] {

diff --git a/shared/src/main/scala/edu/ie3/quants/energy/Power.scala b/shared/src/main/scala/edu/ie3/quants/energy/Power.scala
@@ -18,12 +18,12 @@ import edu.ie3.quants.time.{ Hours, TimeDerivative, TimeIntegral }
 /**
  * Represents a quantity of power / load, the rate at which energy produced or used
  *
- * The first time derivative of [[squants.energy.Energy]]
+ * The first time derivative of [[edu.ie3.quants.energy.Energy]]
  *
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.energy.Watts]]
+ * @param value value in [[edu.ie3.quants.energy.Watts]]
  */
 final class Power private (val value: Double, val unit: PowerUnit)
   extends Quantity[Power]
@@ -57,7 +57,7 @@ final class Power private (val value: Double, val unit: PowerUnit)
 }
 
 /**
- * Companion object for [[squants.energy.Power]]
+ * Companion object for [[edu.ie3.quants.energy.Power]]
  */
 object Power extends Dimension[Power] {
   private[energy] def apply[A](n: A, unit: PowerUnit)(implicit num: Numeric[A]) = new Power(num.toDouble(n), unit)

diff --git a/shared/src/main/scala/edu/ie3/quants/energy/PowerDensity.scala b/shared/src/main/scala/edu/ie3/quants/energy/PowerDensity.scala
@@ -17,7 +17,7 @@ import edu.ie3.quants._
  * @author  Nicolas Vinuesa
  * @since   1.4
  *
- * @param value value in [[squants.energy.WattsPerCubicMeter]]
+ * @param value value in [[edu.ie3.quants.energy.WattsPerCubicMeter]]
  */
 final class PowerDensity private (val value: Double, val unit: PowerDensityUnit)
   extends Quantity[PowerDensity] {

diff --git a/shared/src/main/scala/edu/ie3/quants/energy/PowerRamp.scala b/shared/src/main/scala/edu/ie3/quants/energy/PowerRamp.scala
@@ -13,12 +13,12 @@ import edu.ie3.quants.{ Time, _ }
 import edu.ie3.quants.time._
 
 /**
- * Represents the rate of change of [[squants.energy.Power]] over time
+ * Represents the rate of change of [[edu.ie3.quants.energy.Power]] over time
  *
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.energy.WattsPerHour]]
+ * @param value value in [[edu.ie3.quants.energy.WattsPerHour]]
  */
 final class PowerRamp private (val value: Double, val unit: PowerRampUnit)
   extends Quantity[PowerRamp]

diff --git a/shared/src/main/scala/edu/ie3/quants/energy/SpecificEnergy.scala b/shared/src/main/scala/edu/ie3/quants/energy/SpecificEnergy.scala
@@ -15,7 +15,7 @@ import edu.ie3.quants._
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.energy.Grays]]
+ * @param value value in [[edu.ie3.quants.energy.Grays]]
  */
 final class SpecificEnergy private (val value: Double, val unit: SpecificEnergyUnit) extends Quantity[SpecificEnergy] {
 

diff --git a/shared/src/main/scala/edu/ie3/quants/information/Information.scala b/shared/src/main/scala/edu/ie3/quants/information/Information.scala
@@ -17,7 +17,7 @@ import edu.ie3.quants.time.TimeIntegral
  *
  * @author Derek Morr
  * @since 0.6.0
- * @param value value in [[squants.information.Bytes]]
+ * @param value value in [[edu.ie3.quants.information.Bytes]]
  */
 final class Information private (val value: Double, val unit: InformationUnit)
   extends Quantity[Information]

diff --git a/shared/src/main/scala/edu/ie3/quants/market/Money.scala b/shared/src/main/scala/edu/ie3/quants/market/Money.scala
@@ -148,7 +148,7 @@ final class Money private (val amount: BigDecimal)(val currency: Currency)
   override def *(that: Double): Money = times(that)
 
   /**
-   * Multiplies this money by that [[squants.market.CurrencyExchangeRate]] and returns the equal value in the other currency.
+   * Multiplies this money by that [[edu.ie3.quants.market.CurrencyExchangeRate]] and returns the equal value in the other currency.
    *
    * Delegates to CurrencyExchangeRate * Money
    *
@@ -329,7 +329,7 @@ final class Money private (val amount: BigDecimal)(val currency: Currency)
   def <=#(that: Money)(implicit moneyContext: MoneyContext) = moneyCompare(that) <= 0
 
   /**
-   * Combines with that Money to create an [[squants.market.CurrencyExchangeRate]]
+   * Combines with that Money to create an [[edu.ie3.quants.market.CurrencyExchangeRate]]
    *
    * Exchange Rates on the same currency are not supported
    *

diff --git a/shared/src/main/scala/edu/ie3/quants/market/Price.scala b/shared/src/main/scala/edu/ie3/quants/market/Price.scala
@@ -14,8 +14,8 @@ import edu.ie3.quants._
 /**
  * Represents a price
  *
- * A price is an [[squants.Ratio]] between a quantity of [[squants.market.Money]]
- * and some other [[squants.Quantity]]
+ * A price is an [[edu.ie3.quants.Ratio]] between a quantity of [[edu.ie3.quants.market.Money]]
+ * and some other [[edu.ie3.quants.Quantity]]
  *
  * @author  garyKeorkunian
  * @since   0.1

diff --git a/shared/src/main/scala/edu/ie3/quants/market/package.scala b/shared/src/main/scala/edu/ie3/quants/market/package.scala
@@ -13,11 +13,11 @@ package edu.ie3.quants
  *
  * Market Types are similar but not quite the same as other quantities in the library.
  *
- * The primary type, [[squants.market.Money]], is derived from Quantity, and its Units of Measure are Currencies.
+ * The primary type, [[edu.ie3.quants.market.Money]], is derived from Quantity, and its Units of Measure are Currencies.
  * However, because the conversion multipliers between units can not be predefined, many of the behaviors have been
  * overridden and augmented to realize correct behavior.
  *
- * [[squants.market.Price]]s represent a Ratio between Money and some other Quantity.  Prices can be created from
+ * [[edu.ie3.quants.market.Price]]s represent a Ratio between Money and some other Quantity.  Prices can be created from
  * ratios of Money and a Quantity
  * {{{
  *   val money: Money = USD(10)
@@ -34,10 +34,10 @@ package edu.ie3.quants
  *   val quote: Length = price * budget
  * }}}
  *
- * [[squants.market.CurrencyExchangeRate]]s represent conversion rates between currencies.
+ * [[edu.ie3.quants.market.CurrencyExchangeRate]]s represent conversion rates between currencies.
  * Use them to explicitly convert Money values in one currency to values in another.
  *
- * [[squants.market.MoneyContext]] provide the implicit context necessary to perform cross-currency operations
+ * [[edu.ie3.quants.market.MoneyContext]] provide the implicit context necessary to perform cross-currency operations
  * on Money values with conversions automatically applied.
  *
  * Some binary math operations will work on Moneys of like Currency with no MoneyContext in scope.

diff --git a/shared/src/main/scala/edu/ie3/quants/motion/Acceleration.scala b/shared/src/main/scala/edu/ie3/quants/motion/Acceleration.scala
@@ -71,7 +71,7 @@ object Acceleration extends Dimension[Acceleration] {
 }
 
 /**
- * Base trait for units of [[squants.motion.Acceleration]]
+ * Base trait for units of [[edu.ie3.quants.motion.Acceleration]]
  *
  * @author  garyKeorkunian
  * @since   0.1

diff --git a/shared/src/main/scala/edu/ie3/quants/space/Angle.scala b/shared/src/main/scala/edu/ie3/quants/space/Angle.scala
@@ -17,7 +17,7 @@ import edu.ie3.quants.time.{ Time, TimeIntegral }
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.space.Radians]]
+ * @param value value in [[edu.ie3.quants.space.Radians]]
  */
 final class Angle private (val value: Double, val unit: AngleUnit)
   extends Quantity[Angle] with TimeIntegral[AngularVelocity] {

diff --git a/shared/src/main/scala/edu/ie3/quants/space/Area.scala b/shared/src/main/scala/edu/ie3/quants/space/Area.scala
@@ -22,7 +22,7 @@ import edu.ie3.quants.time.Time
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.space.SquareMeters]]
+ * @param value value in [[edu.ie3.quants.space.SquareMeters]]
  */
 final class Area private (val value: Double, val unit: AreaUnit)
   extends Quantity[Area] {

diff --git a/shared/src/main/scala/edu/ie3/quants/space/Length.scala b/shared/src/main/scala/edu/ie3/quants/space/Length.scala
@@ -117,7 +117,7 @@ object Length extends Dimension[Length] with BaseDimension {
 }
 
 /**
- * Base trait for units of [[squants.space.Length]]
+ * Base trait for units of [[edu.ie3.quants.space.Length]]
  */
 trait LengthUnit extends UnitOfMeasure[Length] with UnitConverter {
   def apply[A](n: A)(implicit num: Numeric[A]) = Length(n, this)

diff --git a/shared/src/main/scala/edu/ie3/quants/space/SolidAngle.scala b/shared/src/main/scala/edu/ie3/quants/space/SolidAngle.scala
@@ -18,7 +18,7 @@ import edu.ie3.quants.radio.RadiantIntensity
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value value in [[squants.space.SquaredRadians]]
+ * @param value value in [[edu.ie3.quants.space.SquaredRadians]]
  */
 final class SolidAngle private (val value: Double, val unit: SolidAngleUnit)
   extends Quantity[SolidAngle] {

diff --git a/shared/src/main/scala/edu/ie3/quants/thermal/Temperature.scala b/shared/src/main/scala/edu/ie3/quants/thermal/Temperature.scala
@@ -166,7 +166,7 @@ object Temperature extends Dimension[Temperature] with BaseDimension {
 }
 
 /**
- * Base trait for units of [[squants.thermal.Temperature]]
+ * Base trait for units of [[edu.ie3.quants.thermal.Temperature]]
  */
 sealed trait TemperatureScale extends UnitOfMeasure[Temperature] {
   def self: TemperatureScale

diff --git a/shared/src/main/scala/edu/ie3/quants/thermal/ThermalCapacity.scala b/shared/src/main/scala/edu/ie3/quants/thermal/ThermalCapacity.scala
@@ -20,7 +20,7 @@ import edu.ie3.quants.energy.{ Energy, Joules }
  * @author  garyKeorkunian
  * @since   0.1
  *
- * @param value the value in [[squants.thermal.JoulesPerKelvin]]
+ * @param value the value in [[edu.ie3.quants.thermal.JoulesPerKelvin]]
  */
 final class ThermalCapacity private (val value: Double, val unit: ThermalCapacityUnit)
   extends Quantity[ThermalCapacity] {