Merge pull request #465 from gnustep/documentation_changes

Add documentation

Headers/Foundation/NSUnit.h

@@ -32,14 +32,18 @@
 extern "C" {
 #endif
 
-// Unit converter
+/**
+ * Unit converter
+ */
 GS_EXPORT_CLASS
 @interface NSUnitConverter : NSObject
 - (double) baseUnitValueFromValue: (double)value;
 - (double) valueFromBaseUnitValue: (double)baseUnitValue;
 @end
 
-// Linea converter... for things like C <-> F conversion...
+/**
+ * Linear converter... for things like C to F conversion...
+ */
 GS_EXPORT_CLASS
 @interface NSUnitConverterLinear : NSUnitConverter <NSCoding>
 {
@@ -53,7 +57,9 @@ GS_EXPORT_CLASS
 - (double) constant;
 @end
 
-// Units...  abstract...
+/**
+ * Units...  abstract...
+ */
 GS_EXPORT_CLASS
 @interface NSUnit : NSObject <NSCopying, NSCoding>
 {
@@ -66,7 +72,9 @@ GS_EXPORT_CLASS
 
 @end
 
-// Dimension using units....
+/**
+ * Dimension using units....
+ */
 GS_EXPORT_CLASS
 @interface NSDimension : NSUnit <NSCoding>
 {
@@ -81,22 +89,22 @@ GS_EXPORT_CLASS
 @end
 
 // Predefined....
+/**
+ * Base unit - metersPerSecondSquared
+ */
 GS_EXPORT_CLASS
 @interface NSUnitAcceleration : NSDimension
-/*
- Base unit - metersPerSecondSquared
- */
 
 + (NSUnitAcceleration *) metersPerSecondSquared;
 + (NSUnitAcceleration *) gravity;
 
 @end
 
+/**
+ * Base unit - degrees
+ */
 GS_EXPORT_CLASS
 @interface NSUnitAngle : NSDimension
-/*
- Base unit - degrees
- */
 
 + (NSUnitAngle *) degrees;
 + (NSUnitAngle *) arcMinutes;
@@ -107,11 +115,11 @@ GS_EXPORT_CLASS
 
 @end
 
+/**
+ * Base unit - squareMeters
+ */
 GS_EXPORT_CLASS
 @interface NSUnitArea : NSDimension
-/*
- Base unit - squareMeters
- */
 
 + (NSUnitArea *) squareMegameters;
 + (NSUnitArea *) squareKilometers;
@@ -130,306 +138,858 @@ GS_EXPORT_CLASS
 
 @end
 
+/**
+ * Units of concentration.  Base unit - gramsPerLiter.
+ */
 GS_EXPORT_CLASS
 @interface NSUnitConcentrationMass : NSDimension
-/*
- Base unit - gramsPerLiter
- */
 
+/**
+ * Concentration units in grams per liter.
+ */
 + (NSUnitConcentrationMass *) gramsPerLiter;
+
+/**
+ * Concentration units in milligrams per deciliter.
+ */
 + (NSUnitConcentrationMass *) milligramsPerDeciliter;
 
+/**
+ * Concentration units in grams per mole.
+ */
 + (NSUnitConcentrationMass *) millimolesPerLiterWithGramsPerMole: (double)gramsPerMole;
 
 @end
 
+/**
+ * Units of dispersion.  Base unit - partsPerMillion
+ */
 GS_EXPORT_CLASS
 @interface NSUnitDispersion : NSDimension
-/*
+
- Base unit - partsPerMillion
+/**
+ * Units of dispersion in parts per million.
  */
 + (NSUnitDispersion *) partsPerMillion;
 
 @end
 
+/**
+ * Units of duration.  Base unit - seconds
+ */
 GS_EXPORT_CLASS
 @interface NSUnitDuration : NSDimension
-/*
- Base unit - seconds
- */
 
+/**
+ * Units of duration in seconds.
+ */
 + (NSUnitDuration *) seconds;
+
+/**
+ * Units of duration in minutes.
+ */
 + (NSUnitDuration *) minutes;
+
+/**
+ * Units of duration in hours.
+ */
 + (NSUnitDuration *) hours;
 
 @end
 
+/**
+ * Units of electric charge.  Base unit - coulombs
+ */
 GS_EXPORT_CLASS
 @interface NSUnitElectricCharge : NSDimension
-/*
- Base unit - coulombs
- */
 
+/**
+ * The units of eletric charge in coulombs.
+ */
 + (NSUnitElectricCharge *) coulombs;
+
+/**
+ * The units of eletric charge in megaampere hours.
+ */
 + (NSUnitElectricCharge *) megaampereHours;
+
+/**
+ * The units of eletric charge in kiloampere hours.
+ */
 + (NSUnitElectricCharge *) kiloampereHours;
+
+/**
+ * The units of eletric charge in ampere hours.
+ */
 + (NSUnitElectricCharge *) ampereHours;
+
+/**
+ * The units of eletric charge in milliampere hours.
+ */
 + (NSUnitElectricCharge *) milliampereHours;
+
+/**
+ * The units of eletric charge in microampere hours.
+ */
 + (NSUnitElectricCharge *) microampereHours;
 
 @end
 
+/**
+ * Units of electric current.  Base unit - amperes
+ */
 GS_EXPORT_CLASS
 @interface NSUnitElectricCurrent : NSDimension
-/*
- Base unit - amperes
- */
 
+/**
+ * The units of eletric current in megaamperes.
+ */
 + (NSUnitElectricCurrent *) megaamperes;
+
+/**
+ * The units of eletric current in kiloamperes.
+ */
 + (NSUnitElectricCurrent *) kiloamperes;
+
+/**
+ * The units of eletric current in amperes.
+ */
 + (NSUnitElectricCurrent *) amperes;
+
+/**
+ * The units of eletric current in milliamperes.
+ */
 + (NSUnitElectricCurrent *) milliamperes;
+
+/**
+ * The units of eletric current in microamperes.
+ */
 + (NSUnitElectricCurrent *) microamperes;
 
 @end
 
+/**
+ * Units of electric potential.  Base unit - volts
+ */
 GS_EXPORT_CLASS
 @interface NSUnitElectricPotentialDifference : NSDimension
-/*
- Base unit - volts
- */
 
+/**
+ * The units of eletric potential in megavolts.
+ */
 + (NSUnitElectricPotentialDifference *) megavolts;
+
+/**
+ * The units of eletric potential in kilovolts.
+ */
 + (NSUnitElectricPotentialDifference *) kilovolts;
+
+/**
+ * The units of eletric potential in volts.
+ */
 + (NSUnitElectricPotentialDifference *) volts;
+
+/**
+ * The units of eletric potential in millivolts.
+ */
 + (NSUnitElectricPotentialDifference *) millivolts;
+
+/**
+ * The units of eletric potential in microvolts.
+ */
 + (NSUnitElectricPotentialDifference *) microvolts;
 
 @end
 
+/**
+ * Units of electric resistance. Base unit - ohms
+ */
 GS_EXPORT_CLASS
 @interface NSUnitElectricResistance : NSDimension
-/*
- Base unit - ohms
- */
 
+/**
+ * The units of eletric resistance in megaohms.
+ */
 + (NSUnitElectricResistance *) megaohms;
+
+/**
+ * The units of eletric resistance in kiloohms.
+ */
 + (NSUnitElectricResistance *) kiloohms;
+
+/**
+ * The units of eletric resistance in ohms.
+ */
 + (NSUnitElectricResistance *) ohms;
+
+/**
+ * The units of eletric resistance in milliohms.
+ */
 + (NSUnitElectricResistance *) milliohms;
+
+/**
+ * The units of eletric resistance in microohms.
+ */
 + (NSUnitElectricResistance *) microohms;
 
 @end
 
+/**
+ * Units of Energy.  Base unit - joules
+ */
 GS_EXPORT_CLASS
 @interface NSUnitEnergy : NSDimension
-/*
- Base unit - joules
- */
 
+/**
+ * The units of energy in kilojoules.
+ */
 + (NSUnitEnergy *) kilojoules;
+
+/**
+ * The units of energy in joules.
+ */
 + (NSUnitEnergy *) joules;
+
+/**
+ * The units of energy in kilocalories.
+ */
 + (NSUnitEnergy *) kilocalories;
+
+/**
+ * The units of energy in calories.
+ */
 + (NSUnitEnergy *) calories;
+
+/**
+ * The units of energy in kilawatt hours.
+ */
 + (NSUnitEnergy *) kilowattHours;
 
 @end
 
+/**
+ * Units of frequency.  Base unit - hertz
+ */
 GS_EXPORT_CLASS
 @interface NSUnitFrequency : NSDimension
-/*
- Base unit - hertz
- */
 
+/**
+ * The units of frequency in terahertz.
+ */
 + (NSUnitFrequency *) terahertz;
+
+/**
+ * The units of frequency in gigahertz.
+ */
 + (NSUnitFrequency *) gigahertz;
+
+/**
+ * The units of frequency in megahertz.
+ */
 + (NSUnitFrequency *) megahertz;
+
+/**
+ * The units of frequency in kilohertz.
+ */
 + (NSUnitFrequency *) kilohertz;
+
+/**
+ * The units of frequency in hertz.
+ */
 + (NSUnitFrequency *) hertz;
+
+/**
+ * The units of frequency in millihertz.
+ */
 + (NSUnitFrequency *) millihertz;
+
+/**
+ * The units of frequency in microhertz.
+ */
 + (NSUnitFrequency *) microhertz;
+
+/**
+ * The units of frequency in nanohertz.
+ */
 + (NSUnitFrequency *) nanohertz;
 
 @end
 
+/**
+ * Units of fuel efficiency.  Base unit - litersPer100Kilometers
+ */
 GS_EXPORT_CLASS
 @interface NSUnitFuelEfficiency : NSDimension
-/*
- Base unit - litersPer100Kilometers
- */
 
+/**
+ * The units of fuel efficiency in liters per 100 kilometers.
+ */
 + (NSUnitFuelEfficiency *) litersPer100Kilometers;
+
+/**
+ * The units of fuel efficiency in miles per imperial gallon.
+ */
 + (NSUnitFuelEfficiency *) milesPerImperialGallon;
+
+/**
+ * The units of fuel efficiency in miles per gallon.
+ */
 + (NSUnitFuelEfficiency *) milesPerGallon;
 
 @end
 
+/**
+ * Units of length. Base unit - meters
+ */
 GS_EXPORT_CLASS
 @interface NSUnitLength : NSDimension
-/*
- Base unit - meters
- */
 
+/**
+ * The units of length in megameters.
+ */
 + (NSUnitLength *) megameters;
+
+/**
+ * The units of length in kilometers.
+ */
 + (NSUnitLength *) kilometers;
+
+/**
+ * The units of length in hectometers.
+ */
 + (NSUnitLength *) hectometers;
+
+/**
+ * The units of length in decameters.
+ */
 + (NSUnitLength *) decameters;
+
+/**
+ * The units of length in meters.
+ */
 + (NSUnitLength *) meters;
+
+/**
+ * The units of length in decimeters.
+ */
 + (NSUnitLength *) decimeters;
+
+/**
+ * The units of length in centimeters.
+ */
 + (NSUnitLength *) centimeters;
+
+/**
+ * The units of length in millimeters.
+ */
 + (NSUnitLength *) millimeters;
+
+/**
+ * The units of length in micrometers.
+ */
 + (NSUnitLength *) micrometers;
+
+/**
+ * The units of length in nanometers.
+ */
 + (NSUnitLength *) nanometers;
+
+/**
+ * The units of length in picometers.
+ */
 + (NSUnitLength *) picometers;
+
+/**
+ * The units of length in inches.
+ */
 + (NSUnitLength *) inches;
+
+/**
+ * The units of length in feet.
+ */
 + (NSUnitLength *) feet;
+
+/**
+ * The units of length in yards.
+ */
 + (NSUnitLength *) yards;
+
+/**
+ * The units of length in miles.
+ */
 + (NSUnitLength *) miles;
+
+/**
+ * The units of length in scandanavian miles.
+ */
 + (NSUnitLength *) scandinavianMiles;
+
+/**
+ * The units of length in light years.
+ */
 + (NSUnitLength *) lightyears;
+
+/**
+ * The units of length in nautical miles.
+ */
 + (NSUnitLength *) nauticalMiles;
+
+/**
+ * The units of length in fathoms.
+ */
 + (NSUnitLength *) fathoms;
+
+/**
+ * The units of length in furlongs.
+ */
 + (NSUnitLength *) furlongs;
+
+/**
+ * The units of length in astronomical units.
+ */
 + (NSUnitLength *) astronomicalUnits;
+
+/**
+ * The units of length in parsecs.
+ */
 + (NSUnitLength *) parsecs;
 
 @end
 
+/**
+ * Units of illumination.  Base unit - lux
+ */
 GS_EXPORT_CLASS
 @interface NSUnitIlluminance : NSDimension
-/*
- Base unit - lux
- */
 
+/**
+ * The units of illuminance in lux.
+ */
 + (NSUnitIlluminance *) lux;
 
 @end
 
+/**
+ * Units of mass. Base unit - kilograms
+ */
 GS_EXPORT_CLASS
 @interface NSUnitMass : NSDimension
-/*
- Base unit - kilograms
- */
 
+/**
+ * The mass units in kilograms.
+ */
 + (NSUnitMass *) kilograms;
+
+/**
+ * The mass units in grams.
+ */
 + (NSUnitMass *) grams;
+
+/**
+ * The mass units in decigrams.
+ */
 + (NSUnitMass *) decigrams;
+
+/**
+ * The mass units in centigrams.
+ */
 + (NSUnitMass *) centigrams;
+
+/**
+ * The mass units in milligrams.
+ */
 + (NSUnitMass *) milligrams;
+
+/**
+ * The mass units in micrograms.
+ */
 + (NSUnitMass *) micrograms;
+
+/**
+ * The mass units in nanograms.
+ */
 + (NSUnitMass *) nanograms;
+
+/**
+ * The mass units in picograms.
+ */
 + (NSUnitMass *) picograms;
+
+/**
+ * The mass units in ounces.
+ */
 + (NSUnitMass *) ounces;
+
+/**
+ * The mass units in pounds.
+ */
 + (NSUnitMass *) pounds;
+
+/**
+ * The mass units in stones.
+ */
 + (NSUnitMass *) stones;
+
+/**
+ * The mass units in metric tons.
+ */
 + (NSUnitMass *) metricTons;
+
+/**
+ * The mass units in short tons.
+ */
 + (NSUnitMass *) shortTons;
+
+/**
+ * The mass units in carats.
+ */
 + (NSUnitMass *) carats;
+
+/**
+ * The mass units in ounces troy.
+ */
 + (NSUnitMass *) ouncesTroy;
+
+/**
+ * The mass units in slugs.
+ */
 + (NSUnitMass *) slugs;
 
 @end
 
+/**
+ * Used to represent power.  Base unit - watts
+ */
 GS_EXPORT_CLASS
 @interface NSUnitPower : NSDimension
-/*
- Base unit - watts
- */
 
+/**
+ * The power units in terawatts.
+ */
 + (NSUnitPower *) terawatts;
+
+/**
+ * The power units in gigawatts.
+ */
 + (NSUnitPower *) gigawatts;
+
+/**
+ * The power units in megawatts.
+ */
 + (NSUnitPower *) megawatts;
+
+/**
+ * The power units in kilowatts.
+ */
 + (NSUnitPower *) kilowatts;
+
+/**
+ * The power units in watts.
+ */
 + (NSUnitPower *) watts;
+
+/**
+ * The power units in milliwatts.
+ */
 + (NSUnitPower *) milliwatts;
+
+/**
+ * The power units in microwatts.
+ */
 + (NSUnitPower *) microwatts;
+
+/**
+ * The power units in nanowatts.
+ */
 + (NSUnitPower *) nanowatts;
+
+/**
+ * The power units in picowatts.
+ */
 + (NSUnitPower *) picowatts;
+
+/**
+ * The power units in femtowatts.
+ */
 + (NSUnitPower *) femtowatts;
+
+/**
+ * The power units in horsepower.
+ */
 + (NSUnitPower *) horsepower;
 
 @end
 
+/**
+ * Used to represent pressure. Base unit - newtonsPerMetersSquared (equivalent to 1 pascal)
+ */
 GS_EXPORT_CLASS
 @interface NSUnitPressure : NSDimension
-/*
- Base unit - newtonsPerMetersSquared (equivalent to 1 pascal)
- */
 
+/**
+ * The newtons per meters squared unit of pressure.
+ */
 + (NSUnitPressure *) newtonsPerMetersSquared;
+
+/**
+ * The gigapascals unit of pressure.
+ */
 + (NSUnitPressure *) gigapascals;
+
+/**
+ * The megapascals unit of pressure.
+ */
 + (NSUnitPressure *) megapascals;
+
+/**
+ * The kilopascals unit of pressure.
+ */
 + (NSUnitPressure *) kilopascals;
+
+/**
+ * The hetcopascals unit of pressure.
+ */
 + (NSUnitPressure *) hectopascals;
+
+/**
+ * The inches of mercury unit of pressure.
+ */
 + (NSUnitPressure *) inchesOfMercury;
+
+/**
+ * The bars unit of pressure.
+ */
 + (NSUnitPressure *) bars;
+
+/**
+ * The millibars unit of pressure.
+ */
 + (NSUnitPressure *) millibars;
+
+/**
+ * The millimeters of mercury of pressure.
+ */
 + (NSUnitPressure *) millimetersOfMercury;
+
+/**
+ * The pounds of per square inch of pressure.
+ */
 + (NSUnitPressure *) poundsForcePerSquareInch;
 
 @end
 
+/**
+ * Used to represent speed. Base unit is meters per second.
+ */
 GS_EXPORT_CLASS
 @interface NSUnitSpeed : NSDimension
-/*
- Base unit - metersPerSecond
- */
 
+/**
+ * The meters per second measurement of speed.
+ */
 + (NSUnitSpeed *) metersPerSecond;
+
+/**
+ * The kilometers per hour measurement of speed.
+ */
 + (NSUnitSpeed *) kilometersPerHour;
+
+/**
+ * The miles per hour measurement of speed.
+ */
 + (NSUnitSpeed *) milesPerHour;
+
+/**
+ * The knots measurement of speed.
+ */
 + (NSUnitSpeed *) knots;
 
 @end
 
+/**
+ * Used to represent temperature quantities.
+ * The base unit of this class is kelvin.
+ */
 GS_EXPORT_CLASS
 @interface NSUnitTemperature : NSDimension
-/*
+
- Base unit - kelvin
+/**
+ * The kelvin unit of temperature.
  */
 + (NSUnitTemperature *) kelvin;
-+ (NSUnitTemperature *) celsius; 
-+ (NSUnitTemperature *) fahrenheit;
 
+/**
+ * The kelvin unit of celsius.
+ */
++ (NSUnitTemperature *) celsius;
+
+/**
+ * The kelvin unit of fahenheit.
+ */
++ (NSUnitTemperature *) fahrenheit;
 
 @end
 
+/**
+ * Typically this is used to represent specific quantities.
+ * The base unit of this class is liters.
+ */
 GS_EXPORT_CLASS
 @interface NSUnitVolume : NSDimension
-/*
- Base unit - liters
- */
 
+/**
+ * The megaliters unit of volume.
+ */
 + (NSUnitVolume *) megaliters;
+
+/**
+ * The kiloliters unit of volume.
+ */
 + (NSUnitVolume *) kiloliters;
+
+/**
+ * The liters unit of volume.
+ */
 + (NSUnitVolume *) liters;
+
+/**
+ * The deciliters unit of volume.
+ */
 + (NSUnitVolume *) deciliters;
+
+/**
+ * The centiliters unit of volume.
+ */
 + (NSUnitVolume *) centiliters;
+
+/**
+ * The milliliters unit of volume.
+ */
 + (NSUnitVolume *) milliliters;
+
+/**
+ * The cubic kilometers unit of volume.
+ */
 + (NSUnitVolume *) cubicKilometers;
+
+/**
+ * The cubic meters unit of volume.
+ */
 + (NSUnitVolume *) cubicMeters;
+
+/**
+ * The cubic decimeters unit of volume.
+ */
 + (NSUnitVolume *) cubicDecimeters;
+
+/**
+ * The cubic centimeteres unit of volume.
+ */
 + (NSUnitVolume *) cubicCentimeters;
+
+/**
+ * The cubic millimeters unit of volume.
+ */
 + (NSUnitVolume *) cubicMillimeters;
+
+/**
+ * The cubic inches unit of volume.
+ */
 + (NSUnitVolume *) cubicInches;
+
+/**
+ * The cubic feet unit of volume.
+ */
 + (NSUnitVolume *) cubicFeet;
+
+/**
+ * The cubic yards unit of volume.
+ */
 + (NSUnitVolume *) cubicYards;
+
+/**
+ * The cubic miles unit of volume.
+ */
 + (NSUnitVolume *) cubicMiles;
+
+/**
+ * The acre feet unit of volume.
+ */
 + (NSUnitVolume *) acreFeet;
+
+/**
+ * The bushels unit of volume.
+ */
 + (NSUnitVolume *) bushels;
+
+/**
+ * The teaspoons unit of volume.
+ */
 + (NSUnitVolume *) teaspoons;
+
+/**
+ * The tablespoons unit of volume.
+ */
 + (NSUnitVolume *) tablespoons;
+
+/**
+ * The fluid ounces unit of volume.
+ */
 + (NSUnitVolume *) fluidOunces;
+
+/**
+ * The cups unit of volume.
+ */
 + (NSUnitVolume *) cups;
+
+/**
+ * The pints unit of volume.
+ */
 + (NSUnitVolume *) pints;
+
+/**
+ * The quarts unit of volume.
+ */
 + (NSUnitVolume *) quarts;
+
+/**
+ * The gallons unit of volume.
+ */
 + (NSUnitVolume *) gallons;
+
+/**
+ * The imperial teaspoons unit of volume.
+ */
 + (NSUnitVolume *) imperialTeaspoons;
+
+/**
+ * The imperial tablespoons unit of volume.
+ */
 + (NSUnitVolume *) imperialTablespoons;
+
+/**
+ * The imperial fluid ounces unit of volume.
+ */
 + (NSUnitVolume *) imperialFluidOunces;
+
+/**
+ * The imperial pints unit of volume.
+ */
 + (NSUnitVolume *) imperialPints;
+
+/**
+ * The imperial quarts unit of volume.
+ */
 + (NSUnitVolume *) imperialQuarts;
+
+/**
+ * The imperial gallons unit of volume.
+ */
 + (NSUnitVolume *) imperialGallons;
+
+/**
+ * The metric cups unit of volume.
+ */
 + (NSUnitVolume *) metricCups;
 
 @end
@@ -441,4 +1001,3 @@ GS_EXPORT_CLASS
 #endif	/* GS_API_MACOSX */
 
 #endif	/* _NSUnit_h_GNUSTEP_BASE_INCLUDE */
-