Index: trunk/FACT++/scripts/doc/Local.js
===================================================================
--- trunk/FACT++/scripts/doc/Local.js (revision 18819)
+++ trunk/FACT++/scripts/doc/Local.js (revision 18829)
@@ -18,12 +18,30 @@
* Zenith angle in degree (Zenith=0deg)
*
+ * @param {Date} [time]
+ * Time for which the coordinates are valid.
+ * The order of time and observatory is arbitrary.
+ *
+ * @param {String} [observatory]
+ * Observatory location for which the coordinates are valid.
+ * The order of time and observatory is arbitrary.
+ *
+ *
* @param {Number} azimuth
* Azimuth angle in degree (North=0deg, East=90deg)
*
* @example
+ * var date = new Date("2012-10-25 16:30 GMT"); // Date in UTC
* var local = new Local(12, 45);
- * var sky = local.toSky();
+ * var local = new Local(12, 45, date);
+ * var local = new Local(12, 45, "ORM");
+ * var local = new Local(12, 45, "SPM", date);
+ * var local = new Local(12, 45, date, "HAWC");
+ * var sky = local.toSky();
+ * var sky = local.toSky(date);
+ * var sky = local.toSky("ORM");
+ * var sky = local.toSky("HAWC", date);
+ * var sky = local.toSky(date, "SPM");
*
- * @author Thomas Bretz
+ * @author Thomas Bretz
*
*/
@@ -68,9 +86,19 @@
*
* @param {Date} [time=new Date()]
- * Reference time for the conversion
+ * Time for which the coordinates will be tranfromed.
+ * The order of time and observatory is arbitrary.
+ * If none is given, the value given in the constructor is used.
+ * If none was given there, the default is used.
+ *
+ * @param {String} [observatory='ORM']
+ * Observatory location as defined in nova.h as a string for which
+ * the coordinate conversion is done.
+ * The order of time and observatory is arbitrary.
+ * If none is given, the value given in the constructor is used.
+ * If none was given there, the default is used.
*
* @returns {Sky}
- * A Sky object with the converted coordinates and
- * the corresponding time.
+ * A Sky object with the converted coordinates plus a
+ * a correspnding object local of type {Local}.
*/
this.toSky = function() { /* [native code] */ }
Index: trunk/FACT++/scripts/doc/Moon.js
===================================================================
--- trunk/FACT++/scripts/doc/Moon.js (revision 18819)
+++ trunk/FACT++/scripts/doc/Moon.js (revision 18829)
@@ -22,8 +22,11 @@
*
* @example
+ * var date = new Date("2012-10-25 16:30 GMT"); // Date in UTC
+ * var moon = new Moon(date);
* var moon = new Moon();
* var local = moon.toLocal();
+ * var local = moon.toLocal("HAWC");
*
- * @author Thomas Bretz
+ * @author Thomas Bretz
*/
function Moon(time)
@@ -61,7 +64,11 @@
* The conversion is done using libnova's ln_get_hrz_from_equ.
*
+ * @param {String} [observatory='ORM']
+ * Observatory location as defined in nova.h as a string. The default
+ * is the FACT site ('ORM').
+ *
* @returns {Local}
* A Local object with the converted coordinates and
- * the corresponding time.
+ * the corresponding time and observatory.
*/
this.toLocal = function() { /* [native code] */ }
@@ -100,4 +107,10 @@
* is converted to UTC and the times are calculated such that the
* Date (yy/mm/dd) is identical for all returned values.
+ * The order of time and observatory is arbitrary.
+ *
+ * @param {String} [observatory='ORM']
+ * Observatory location as defined in nova.h as a string. The default
+ * is the FACT site ('ORM'). The order of time and observatory is
+ * arbitrary.
*
* @type {Object}
@@ -105,6 +118,7 @@
* @returns
* An object with the following properties is returned: time {Date}
- * the provided time; rise, transit, set {Date} times of rise, set and
- * transit; isUp {Boolean} whether the moon is above or below horizon
+ * the provided time; observatory {Date} the provided observatory location;
+ * rise, transit, set {Date} times of rise, set and transit;
+ * isUp {Boolean} whether the moon is above or below horizon
* at the provided time. If the moon does not rise or set, the properties
* rise, transit and set will be undefined.
@@ -112,5 +126,8 @@
* @example
* var date = new Date("2012-10-25 16:30 GMT"); // Date in UTC
+ * console.out(JSON.stringify(Moon.horizon());
* console.out(JSON.stringify(Moon.horizon(date));
+ * console.out(JSON.stringify(Moon.horizon(date, "SPM"));
+ * console.out(JSON.stringify(Moon.horizon("ORM, date);
*/
Moon.horizon = function() { /* [native code] */ }
Index: trunk/FACT++/scripts/doc/Sky.js
===================================================================
--- trunk/FACT++/scripts/doc/Sky.js (revision 18819)
+++ trunk/FACT++/scripts/doc/Sky.js (revision 18829)
@@ -24,6 +24,11 @@
* var sky = new Sky(12, 45);
* var local = sky.toLocal();
+ * var date = new Date("2012-10-25 16:30 GMT"); // Date in UTC
+ * var local = sky.toLocal(date);
+ * var local = sky.toLocal("ORM");
+ * var local = sky.toLocal(date, "HAWC");
+ * var local = sky.toLocal("SPM", date);
*
- * @author Thomas Bretz
+ * @author Thomas Bretz
*
*/
@@ -62,11 +67,17 @@
*
* @param {Date} [time=new Date()]
- * Reference time for the converstion.
+ * Time for which the coordinates will be tranfromed.
+ * The order of time and observatory is arbitrary.
+ *
+ * @param {String} [observatory='ORM']
+ * Observatory location as defined in nova.h as a string for which
+ * the coordinate conversion is done The default is the
+ * FACT site ('ORM'). The order of time and observatory is arbitrary.
*
* @type Local
*
* @returns
- * A Local object with the converted coordinates and
- * the conversion time.
+ * A Local object with the converted coordinates,
+ * the conversion time and the observatory location.
*/
this.toLocal = function() { /* [native code] */ }
Index: trunk/FACT++/scripts/doc/Sun.js
===================================================================
--- trunk/FACT++/scripts/doc/Sun.js (revision 18819)
+++ trunk/FACT++/scripts/doc/Sun.js (revision 18829)
@@ -10,5 +10,5 @@
* Namespace for functions returning astrometry information about the Sun.
*
- * @author Thomas Bretz
+ * @author Thomas Bretz
*/
var Sun = { };
@@ -33,8 +33,14 @@
* the Sun's disk at horizon is chosen (~-0.8deg).
*
- * @param {Date} [time=new Date()]
+* @param {Date} [time=new Date()]
* Date for which the times should be calculated. Note that the date
* is converted to UTC and the times are calculated such that the
* Date (yy/mm/dd) is identical for all returned values.
+ * The order of time and observatory is arbitrary.
+ *
+ * @param {String} [observatory='ORM']
+ * Observatory location as defined in nova.h as a string. The default
+ * is the FACT site ('ORM'). The order of time and observatory is
+ * arbitrary.
*
* @type {Object}
@@ -55,4 +61,7 @@
* console.out(JSON.stringify(Sun.horizon("astro"));
* console.out(JSON.stringify(Sun.horizon(-12, date); // nautical
+ * console.out(JSON.stringify(Sun.horizon(-12, "SPM");
+ * console.out(JSON.stringify(Sun.horizon(-12, "HAWC", date);
+ * console.out(JSON.stringify(Sun.horizon(-12, date, "ORM");
*/
Sun.horizon = function() { /* [native code] */ }