Fixes in documentation for X-rays

- Added rad units to all gyromagnetic ratios for clarity
DrGrafil · Aug 10, 2017 · 5f9d813 · 5f9d813
1 parent 1340060
commit 5f9d813
Show file tree

Hide file tree

Showing 24 changed files with 2,175 additions and 2,187 deletions.
diff --git a/NISTConst/c++/NISTConst.hpp b/NISTConst/c++/NISTConst.hpp
diff --git a/README.md b/README.md
@@ -39,14 +39,12 @@ double MassDefectInu(int const atomicNumber, int const massNumber, double massAt
 3. Why does wikipedia and google disagree with some of your values?
 
    It is because NISTConst values are frozen to the values present in 2014 CODATA while google and wikipedia are able to pick values from any source. An example of this is for the mass of the proton. As of 8/8/17:
-
-   | Proton Mass | Source |
+| Proton Mass | Source |
 | --- | --- |
 | 1.007276466879 u | NISTConst from NIST/CODATA 2014 |
 | 1.007276466879 u | Wikipedia |
 | 1.007276466812 u | Google |
 | 1.007276466583 u | Latest value from ["High-Precision Measurement of the Proton’s Atomic Mass"](https://doi.org/10.1103/PhysRevLett.119.033001) |
-
    The latest value will probably be adopted by both google and wikipedia in the near future.
 
 4. The value of _____ is wrong! Can you change it to ...?
@@ -59,6 +57,7 @@ double MassDefectInu(int const atomicNumber, int const massNumber, double massAt
 ### [NISTConst 0.7.7](https://github.com/Metex/NISTConst/releases/latest)
 #### Features:
 - Completed documentation.
+- Readme file that isnt one line.
 
 #### Improvements:
 - Added units in documentation to all atomic units.
@@ -68,17 +67,17 @@ double MassDefectInu(int const atomicNumber, int const massNumber, double massAt
 - Brining tau particle and triton notation inline with other particles.
 - Renamed PlanckMassInGeV to PlanckMassInGeVpercSquared.
 - Replaced lambdabar with lambda/2pi in documentation.
+- Added radians to units for gyromagnetic ratios.
 
 #### Fixes:
 - Fixed issue when compiling with NISTCONST_UNCERTAINTY defined.  
-- Fixed uncertainty constant names for: electronVolt
-- Fixed error in name of NewtonianConstantOfGravitationOverhbarc
-- Fixed misspelling of tesla in few places
+- Fixed uncertainty constant names for: electronVolt.
+- Fixed error in name of NewtonianConstantOfGravitationOverhbarc.
+- Fixed misspelling of tesla in few places.
+
 ---
 
 ### [NISTConst 0.7.0](https://github.com/Metex/NISTConst/tree/0.7.0)
 #### Features:
 - All NIST constants and uncertainties are now included.  
-- Passes compile check.
-
----
+- Passes compile check.
diff --git a/doc/html/_n_i_s_t_const_8hpp_source.html b/doc/html/_n_i_s_t_const_8hpp_source.html
diff --git a/doc/html/group___electron.html b/doc/html/group___electron.html
@@ -370,7 +370,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7c738b9078ca0308ee45d3b
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma_e \ (\frac{Hz}{T})\) Electron gyromagnetic ratio in hertz per tesla. </p>
+<p>\(\gamma_e \ (\frac{rad\ Hz}{T})\) Electron gyromagnetic ratio in hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -385,7 +385,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga67e6ebbd2c2d8043cbdb099
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma_e}{2\pi} \ (\frac{MHz}{T})\) Electron gyromagnetic ratio over 2 pi in megahertz per tesla. </p>
+<p>\(\frac{\gamma_e}{2\pi} \ (\frac{rad\ MHz}{T})\) Electron gyromagnetic ratio over 2 pi in megahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -400,7 +400,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga12a5f7854d899e2c2d63770
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma_e}{2\pi} \ (\frac{MHz}{T})\) Uncertainty in electron gyromagnetic ratio over 2 pi in megahertz per tesla. </p>
+<p>\(\frac{\gamma_e}{2\pi} \ (\frac{rad\ MHz}{T})\) Uncertainty in electron gyromagnetic ratio over 2 pi in megahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -415,7 +415,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaca70ad0d6ddcb9cd3f29880
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma_e \ (\frac{Hz}{T})\) Uncertainty in electron gyromagnetic ratio in hertz per tesla. </p>
+<p>\(\gamma_e \ (\frac{rad\ Hz}{T})\) Uncertainty in electron gyromagnetic ratio in hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>

diff --git a/doc/html/group___helion.html b/doc/html/group___helion.html
@@ -510,7 +510,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf3b7dabd6de7a263aba7102
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma&#39;_{^3\textrm{He}} \ (\frac{rad Hz}{T})\) Shielded helion gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\gamma&#39;_{^3\textrm{He}} \ (\frac{rad\ Hz}{T})\) Shielded helion gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -525,7 +525,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaed43f2ab9c5e89c6dda577a
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma&#39;_{^3\textrm{He}}}{2 \pi} \ (\frac{rad MHz}{T})\) Shielded helion gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\frac{\gamma&#39;_{^3\textrm{He}}}{2 \pi} \ (\frac{rad\ MHz}{T})\) Shielded helion gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -540,7 +540,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga500ba901d47044d1bab3fb7
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma&#39;_{^3\textrm{He}}}{2 \pi} \ (\frac{rad MHz}{T})\) Uncertainty in shielded helion gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\frac{\gamma&#39;_{^3\textrm{He}}}{2 \pi} \ (\frac{rad\ MHz}{T})\) Uncertainty in shielded helion gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -555,7 +555,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2f3b1faa760be34cc238054
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma&#39;_{^3\textrm{He}} \ (\frac{rad Hz}{T})\) Uncertainty in shielded helion gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\gamma&#39;_{^3\textrm{He}} \ (\frac{rad\ Hz}{T})\) Uncertainty in shielded helion gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>

diff --git a/doc/html/group___n_i_s_t_const.html b/doc/html/group___n_i_s_t_const.html
@@ -114,8 +114,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <dl class="section author"><dt>Author</dt><dd>Elliot Grafil (Metex) </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>8/9/17 </dd></dl>
-<dl class="section version"><dt>Version</dt><dd>0.7.7 </dd></dl>
-<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Add rad to all gyromagnetic ratio </dd></dl>
+<dl class="section version"><dt>Version</dt><dd>8.0.0 </dd></dl>
 </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

diff --git a/doc/html/group___neutron.html b/doc/html/group___neutron.html
@@ -354,7 +354,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa36e892cf37340a9122574e
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma_n \ (\frac{rad Hz}{T})\) Neutron gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\gamma_n \ (\frac{rad\ Hz}{T})\) Neutron gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -369,7 +369,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga66ce4219c0fa9d7e9050e5b
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma_n}{2\pi} \ (\frac{rad MHz}{T})\) Neutron gyromagnetic ratio over 2 pi in radian megahertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\frac{\gamma_n}{2\pi} \ (\frac{rad\ MHz}{T})\) Neutron gyromagnetic ratio over 2 pi in radian megahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -384,7 +384,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga428e1a7239cc03c9e202ac1
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma_n}{2\pi} \ (\frac{rad MHz}{T})\) Uncertainty in neutron gyromagnetic ratio over 2 pi in radian megahertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\frac{\gamma_n}{2\pi} \ (\frac{rad\ MHz}{T})\) Uncertainty in neutron gyromagnetic ratio over 2 pi in radian megahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -399,7 +399,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4f48bb36482cdd64b95e17e
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma_n \ (\frac{rad Hz}{T})\) Uncertainty in neutron gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\gamma_n \ (\frac{rad\ Hz}{T})\) Uncertainty in neutron gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>

diff --git a/doc/html/group___proton.html b/doc/html/group___proton.html
@@ -362,7 +362,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5e708f58aaae8033705f05b
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma_p \ (\frac{rad Hz}{T})\) Proton gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\gamma_p \ (\frac{rad\ Hz}{T})\) Proton gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -377,7 +377,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga54ecf0d1090a1b2c9f7b301
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma_p}{2\pi} \ (\frac{rad MHz}{T})\) Proton gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\frac{\gamma_p}{2\pi} \ (\frac{rad\ MHz}{T})\) Proton gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -392,7 +392,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga107cde2344578ef79ee219b
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma_p}{2\pi} \ (\frac{rad MHz}{T})\) Uncertainty in proton gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\frac{\gamma_p}{2\pi} \ (\frac{rad\ MHz}{T})\) Uncertainty in proton gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -407,7 +407,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa71b7de7eab3c78be5f0fa7
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma_p \ (\frac{rad Hz}{T})\) Uncertainty in proton gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\gamma_p \ (\frac{rad\ Hz}{T})\) Uncertainty in proton gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -842,7 +842,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2affce442da8b445cce1c58
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma&#39;_p \ (\frac{rad Hz}{T})\) Shielded proton gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\gamma&#39;_p \ (\frac{rad\ Hz}{T})\) Shielded proton gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -857,7 +857,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5b2d223ede8fc141af04cef
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma&#39;_p}{2 \pi} \ (\frac{rad MHz}{T})\) Shielded proton gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\frac{\gamma&#39;_p}{2 \pi} \ (\frac{rad\ MHz}{T})\) Shielded proton gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -872,7 +872,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8a726ae1ce4a083a50cd2bb
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\frac{\gamma&#39;_p}{2 \pi} \ (\frac{rad MHz}{T})\) Uncertainty in shielded proton gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\frac{\gamma&#39;_p}{2 \pi} \ (\frac{rad\ MHz}{T})\) Uncertainty in shielded proton gyromagnetic ratio over 2 pi in radian megaahertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>
@@ -887,7 +887,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae603375639410bab3920a82
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(\gamma&#39;_p \ (\frac{rad Hz}{T})\) Uncertainty in shielded proton gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
+<p>\(\gamma&#39;_p \ (\frac{rad\ Hz}{T})\) Uncertainty in shielded proton gyromagnetic ratio in radian hertz per tesla. Note that the units of radians are added for clarity. </p>
 
 </div>
 </div>

diff --git a/doc/html/menudata.js b/doc/html/menudata.js
@@ -1,6 +1,5 @@
 var menudata={children:[
 {text:"Main Page",url:"index.html"},
-{text:"Related Pages",url:"pages.html"},
 {text:"Modules",url:"modules.html"},
 {text:"Files",url:"files.html",children:[
 {text:"File List",url:"files.html"}]}]}
diff --git a/doc/html/navtreedata.js b/doc/html/navtreedata.js
@@ -1,7 +1,6 @@
 var NAVTREE =
 [
   [ "NISTConst", "index.html", [
-    [ "Todo List", "todo.html", null ],
     [ "Modules", "modules.html", "modules" ],
     [ "Files", null, [
       [ "File List", "files.html", "files" ]