Doc edits

Author: attipaci

.gitignore

@@ -19,3 +19,4 @@ README-headless.md
 README-orig.md
 TODO
 VERSION
+RELEASE-HOWTO.md

README.md

@@ -27,6 +27,7 @@ SuperNOVAS is entirely free to use without licensing restrictions.  Its source c
 standard, and hence should be suitable for old and new platforms alike. It is light-weight and easy to use, with full 
 support for the IAU 2000/2006 standards for sub-microarcsecond position calculations.
 
+This document has been updated for the `v1.1` release.
 
 
 ## Table of Contents
@@ -374,7 +375,7 @@ UT1 - UTC time difference (a.k.a. DUT1), and the current leap seconds.
  int dut1 = ...;
 ``` 
 
-Now we can set a standard UNIX time, for example, using the current time:
+Now we can set the time of observation, for example, using the current UNIX time:
 
 ```c
  novas_timescale t_obs;	        // Structure that will define astrometric time

include/eph_manager.h

@@ -8,6 +8,8 @@
  *  Astronomical Applications Dept.
  *  Washington, DC
  *  <a href="http://www.usno.navy.mil/USNO/astronomical-applications">http://www.usno.navy.mil/USNO/astronomical-applications</a>
+ *
+ * @sa solsys1.c
  */
 
 #ifndef _EPHMAN_

include/novas.h

@@ -4,7 +4,7 @@
  * @author G. Kaplan and A. Kovacs
  * @version 1.1.0
  *
- *  SuperNOVAS astrometry softwate based on the Naval Observatory Vector Astrometry Software (NOVAS).
+ *  SuperNOVAS astrometry software based on the Naval Observatory Vector Astrometry Software (NOVAS).
  *  It has been modified to fix outstanding issues and to make it easier to use.
  *
  *

include/solarsystem.h

@@ -21,6 +21,11 @@
  *  Astronomical Applications Dept.
  *  Washington, DC
  *  <a href="http://www.usno.navy.mil/USNO/astronomical-applications">http://www.usno.navy.mil/USNO/astronomical-applications</a>
+ *
+ *  @sa solsys1.c
+ *  @sa solsys2.c
+ *  @sa solsys3.c
+ *  @sa solsys-ephem.c
  */
 
 #ifndef _SOLSYS_

src/cio_file.c

@@ -1,13 +1,18 @@
-/*
- Naval Observatory Vector Astrometry Software (NOVAS)
- C Edition, Version 3.1
-
- cio_file.c: Produces binary file of RA values for CIO
-
- U. S. Naval Observatory
- Astronomical Applications Dept.
- Washington, DC
- http://www.usno.navy.mil/USNO/astronomical-applications
+/**
+ * @author G. Kaplan and A. Kovacs
+ *
+ *  SuperNOVAS tool to Produces binary data file of RA values for CIO. The resulting binary file
+ *  is platform-dependent. As of SuperNOVAS version 1.1, one may use the ASCII file, which is used
+ *  as an input to this too, directly with SuperNOVAS. As such, there is no longer the need to
+ *  produce the platform-dependent binary, and the use of the ASCII CIO locator file is now
+ *  preferred for reasons of portability.
+ *
+ *  Based on the NOVAS C Edition, Version 3.1,  U. S. Naval Observatory
+ *  Astronomical Applications Dept.
+ *  Washington, DC
+ *   <a href="http://www.usno.navy.mil/USNO/astronomical-applications">http://www.usno.navy.mil/USNO/astronomical-applications</a>
+ *
+ *  @sa set_cio_locator_file()
  */
 
 #include <stdio.h>

src/frames.c

@@ -5,10 +5,12 @@
  * @author Attila Kovacs
  * @since 1.1
  *
- *  Routines for higher-level and efficient repeat coordinate transformations using observer frames.
- *  Observer frames represent an observer location at a specific astronomical time (instant), which
- *  can be re-used again and again to calculate or transform positions of celestial sources in a
- *  a range of astronomical coordinate systems.
+ *  SuperNOVAS routines for higher-level and efficient repeat coordinate transformations using
+ *  observer frames. Observer frames represent an observer location at a specific astronomical
+ *  time (instant), which can be re-used again and again to calculate or transform positions of
+ *  celestial sources in a a range of astronomical coordinate systems.
+ *
+ *  @sa timescale.c
  */
 
 /// \cond PRIVATE

src/novas.c

@@ -2,9 +2,9 @@
  * @file
  *
  * @author G. Kaplan and A. Kovacs
- * @version 1.0.1
+ * @version 1.1.0
  *
- *  SuperNOVAS astrometry softwate based on the Naval Observatory Vector Astrometry Software (NOVAS).
+ *  SuperNOVAS astrometry software based on the Naval Observatory Vector Astrometry Software (NOVAS).
  *  It has been modified to fix outstanding issues and to make it easier to use.
  *
  *  Based on the NOVAS C Edition, Version 3.1,  U. S. Naval Observatory

src/novascon.c

@@ -3,12 +3,15 @@
  *
  * @author G. Kaplan and A. Kovacs
  *
- *  SuperNOVAS implementation for numerical constants that were used internally in novas.c. In SuperNOVAS it is no longer needed
- *  by novas.c, and you probably don't want to use it either with your application code.
+ *  SuperNOVAS implementation for numerical constants that were used internally in novas.c. In
+ *  SuperNOVAS it is no longer needed by novas.c, and you probably don't want to use it either
+ *  with your application code.
  *
- *  @deprecated Use your own version for the selection of the constant you need, expressed in whatever units your application
- *              desires. We should not force you to adopt the internally used convention of NOVAS, not to mention the high
- *              chance of namespace conflicts with the super-simplistic naming scheme here. You are better off without this.
+ *  @deprecated Use your own version for the selection of the constant you need, expressed in
+ *              whatever units your application desires. We should not force you to adopt the
+ *              internally used convention of NOVAS, not to mention the high chance of namespace
+ *              conflicts with the super-simplistic naming scheme here. You are better off
+ *              without this.
  *
  *  Based on the NOVAS C Edition, Version 3.1,  U. S. Naval Observatory
  *  Astronomical Applications Dept.

src/readeph0.c

@@ -1,15 +1,15 @@
-/*
- Naval Observatory Vector Astrometry Software (NOVAS)
- C Edition, Version 3.1
-
- readeph0.c: Dummy readeph for use when minor planet ephermeris is unavailable
-
- U. S. Naval Observatory
- Astronomical Applications Dept.
- Washington, DC
- http://www.usno.navy.mil/USNO/astronomical-applications
+/**
+ * @author G. Kaplan and A. Kovacs
+ *
+ *  Dummy readeph() implementation for SuperNOVAS for use when minor planet ephermeris is
+ *  unavailable.
+ *
+ *  Based on the NOVAS C Edition, Version 3.1,  U. S. Naval Observatory
+ *  Astronomical Applications Dept.
+ *  Washington, DC
+ *   <a href="http://www.usno.navy.mil/USNO/astronomical-applications">http://www.usno.navy.mil/USNO/astronomical-applications</a>
+ *
  */
-
 #include <stdlib.h>
 #include <errno.h>
 

src/refract.c

@@ -4,7 +4,11 @@
  * @date Created  on Jun 27, 2024
  * @author Attila Kovacs
  *
- *  A collection of refraction models and utilities to use with novas_app_to_hor() or novas_hor_to_app().
+ *  A collection of refraction models and utilities to use with novas_app_to_hor() or
+ *  novas_hor_to_app().
+ *
+ * @sa novas_app_to_hor()
+ * @sa novas_hor_to_app().
  */
 
 /// \cond PRIVATE

src/solsys-ephem.c

@@ -1,8 +1,8 @@
 /**
  * @file
  *
- * SuperNOVAS major planet ephemeris handler via the same generic ephemeris reader that is configured by set_ephem_provider() prior
- * to calling this routine.
+ * SuperNOVAS major planet ephemeris handler via the same generic ephemeris reader that is
+ * configured by set_ephem_provider() prior to calling this routine.
  *
  * @date Created  on Jan 29, 2024
  * @author Attila Kovacs

src/solsys1.c

@@ -3,10 +3,11 @@
  *
  * @author G. Kaplan and A. Kovacs
  *
- *  SuperNOVAS major planet ephemeris lookup implementation using JPL 1997 ephemeris data, to be used together
- *  with eph_manager.c. A more generic solution is to implement a novas_ephem_provider (e.g. relying on the current
- *  version of the CSPICE library) and set it as the default ephemeris handler via set_ephem_provider(), and then
- *  use solsys-ephem.c instead to use the same implementation for major planets.
+ *  SuperNOVAS major planet ephemeris lookup implementation using JPL 1997 ephemeris data, to be
+ *  used together with eph_manager.c. A more generic solution is to implement a
+ *  novas_ephem_provider (e.g. relying on the current version of the CSPICE library) and set it as
+ *  the default ephemeris handler via set_ephem_provider(), and then use solsys-ephem.c instead to
+ *  use the same implementation for major planets.
  *
  *  Based on the NOVAS C Edition, Version 3.1,  U. S. Naval Observatory
  *  Astronomical Applications Dept.

src/timescale.c

@@ -5,8 +5,10 @@
  * @author Attila Kovacs
  * @since 1.1
  *
- *   A set of routines to make handling of astronomical timescales and conversions between them
- *   easier.
+ *   A set of SuperNOVAS routines to make handling of astronomical timescales and conversions
+ *   among them easier.
+ *
+ * @sa frames.c
  */
 
 /// \cond PRIVATE