Fixes in documentation for adopted constants

- Fixed molarMassOfCarbon12 not having proper documentation - Fixed standardAccelerationOfGravity documentation
DrGrafil · Aug 10, 2017 · 1340060 · 1340060
1 parent a5e0dc1
commit 1340060
Show file tree

Hide file tree

Showing 26 changed files with 62 additions and 55 deletions.
diff --git a/NISTConst/c++/NISTConst.hpp b/NISTConst/c++/NISTConst.hpp
@@ -192,10 +192,10 @@
 /// @defgroup Adopted Adopted
 /// @ingroup NISTConst
 
-/// 	@defgroup ConventionalJosephsonConstant Josephson constant 
+/// 	@defgroup ConventionalJosephsonConstant Conventional Josephson constant 
 /// 	@ingroup Adopted
 
-/// 	@defgroup ConventionalvonKlitzingConstant von Klitzing constant 
+/// 	@defgroup ConventionalvonKlitzingConstant Conventional von Klitzing constant 
 /// 	@ingroup Adopted
 
 /// 	@defgroup MolarMassConstant Molar mass constant  
@@ -913,10 +913,10 @@ namespace NISTConst
 	/// @addtogroup MolarMassConstant
 	/// @{
 	const double molarMassConstant =												1e-3;						/**< \f$M_u \ (\frac{kg}{mol})\f$ Molar mass constant in kilograms per mole.*/ 
-	const double molarMassOfCarbon12 =												12e-3;						/**< \f$M({^12C}) \ (\frac{kg}{mol})\f$ Molar mass of carbon-12 in kilograms per mole.*/ 
+	const double molarMassOfCarbon12 =												12e-3;						/**< \f$M({^{12}C}) \ (\frac{kg}{mol})\f$ Molar mass of carbon-12 in kilograms per mole.*/ 
 	#ifdef NISTCONST_UNCERTAINTY
 	const double molarMassConstantUncertainty =										0.0;						/**< \f$M_u \ (\frac{kg}{mol})\f$ Uncertainty in molar mass constant in kilograms per mole. Note should be 0.0 since it is a defined value.*/ 
-	const double molarMassOfCarbon12Uncertainty =									0.0;						/**< \f$M({^12C}) \ (\frac{kg}{mol})\f$ Uncertainty in molar mass of carbon-12 in kilograms per mole. Note should be 0.0 since it is a defined value.*/ 
+	const double molarMassOfCarbon12Uncertainty =									0.0;						/**< \f$M({^{12}C}) \ (\frac{kg}{mol})\f$ Uncertainty in molar mass of carbon-12 in kilograms per mole. Note should be 0.0 since it is a defined value.*/ 
 	#endif  
 	/// @}
 
@@ -1292,9 +1292,9 @@ namespace NISTConst
 
 	/// @addtogroup GravityAcceleration
 	/// @{    
-	const double standardAccelerationOfGravity =									9.80665;					/**< \f$g_n \ (\frac{m}{s^2)\f$ Standard acceleration of gravity in meters per second squared.*/
+	const double standardAccelerationOfGravity =									9.80665;					/**< \f$g_n \ (\frac{m}{s^2})\f$ Standard acceleration of gravity in meters per second squared.*/
 	#ifdef NISTCONST_UNCERTAINTY
-	const double standardAccelerationOfGravityUncertainty =							0.0;						/**< \f$g_n \ (\frac{m}{s^2)\f$ Uncertainty in standard acceleration of gravity in meters per second squared. Note should be 0.0 since it is a defined value.*/
+	const double standardAccelerationOfGravityUncertainty =							0.0;						/**< \f$g_n \ (\frac{m}{s^2})\f$ Uncertainty in standard acceleration of gravity in meters per second squared. Note should be 0.0 since it is a defined value.*/
 	#endif  
 	/// @}
 
@@ -1537,6 +1537,15 @@ StefanBoltzmannConstant = sigma
 common names characteristic impedance of vacuum z0
 e0
 
+molarMassConstant = Mu
+
+standardAccelerationOfGravity = g0
+standardAccelerationOfGravity = standard acceleration due to gravity
+
+standardAtmosphere = atm
+standardAtmosphere = Atmospheric pressure
+standardAtmosphere = barometric pressure
+
 // atomicMassUnitToElectronVolt should do unified version of it
 */
 
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ double MassDefectInu(int const atomicNumber, int const massNumber, double massAt
 
    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 |
@@ -51,7 +51,7 @@ double MassDefectInu(int const atomicNumber, int const massNumber, double massAt
 
 4. The value of _____ is wrong! Can you change it to ...?
 
-   Check either from HERE or HERE before e-mailing us. NISTConst sticks stricktly to the values reported by NIST/CODATA. If NISTConst disagrees with NIST/CODATA we will change the value to be in agreement with NIST/CODATA.
+   Check either from [HERE](https://github.com/Metex/NISTConst/blob/master/CODATA/Table%20of%20NIST%20Constant%20CODATA%202014.txt) or [HERE](https://physics.nist.gov/cuu/Constants/) before e-mailing us. NISTConst sticks stricktly to the values reported by NIST/CODATA. If NISTConst disagrees with NIST/CODATA we will change the value to be in agreement with NIST/CODATA.
 
 ---
 ## Release notes

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___adopted.html b/doc/html/group___adopted.html
@@ -94,9 +94,9 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
 Modules</h2></td></tr>
-<tr class="memitem:group___conventional_josephson_constant"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___conventional_josephson_constant.html">Josephson constant</a></td></tr>
+<tr class="memitem:group___conventional_josephson_constant"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___conventional_josephson_constant.html">Conventional Josephson constant</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:group___conventionalvon_klitzing_constant"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___conventionalvon_klitzing_constant.html">von Klitzing constant</a></td></tr>
+<tr class="memitem:group___conventionalvon_klitzing_constant"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___conventionalvon_klitzing_constant.html">Conventional von Klitzing constant</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:group___molar_mass_constant"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___molar_mass_constant.html">Molar mass constant</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

diff --git a/doc/html/group___adopted.js b/doc/html/group___adopted.js
@@ -1,7 +1,7 @@
 var group___adopted =
 [
-    [ "Josephson constant", "group___conventional_josephson_constant.html", "group___conventional_josephson_constant" ],
-    [ "von Klitzing constant", "group___conventionalvon_klitzing_constant.html", "group___conventionalvon_klitzing_constant" ],
+    [ "Conventional Josephson constant", "group___conventional_josephson_constant.html", "group___conventional_josephson_constant" ],
+    [ "Conventional von Klitzing constant", "group___conventionalvon_klitzing_constant.html", "group___conventionalvon_klitzing_constant" ],
     [ "Molar mass constant", "group___molar_mass_constant.html", "group___molar_mass_constant" ],
     [ "Gravity acceleration", "group___gravity_acceleration.html", "group___gravity_acceleration" ],
     [ "Standard atmosphere", "group___standard_atmosphere.html", "group___standard_atmosphere" ],

diff --git a/doc/html/group___conventional_josephson_constant.html b/doc/html/group___conventional_josephson_constant.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.13"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>NISTConst: Josephson constant</title>
+<title>NISTConst: Conventional Josephson constant</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -88,7 +88,7 @@
   <div class="summary">
 <a href="#var-members">Variables</a>  </div>
   <div class="headertitle">
-<div class="title">Josephson constant<div class="ingroups"><a class="el" href="group___n_i_s_t_const.html">NIST Constants</a> &raquo; <a class="el" href="group___adopted.html">Adopted</a></div></div>  </div>
+<div class="title">Conventional Josephson constant<div class="ingroups"><a class="el" href="group___n_i_s_t_const.html">NIST Constants</a> &raquo; <a class="el" href="group___adopted.html">Adopted</a></div></div>  </div>
 </div><!--header-->
 <div class="contents">
 <table class="memberdecls">

diff --git a/doc/html/group___conventionalvon_klitzing_constant.html b/doc/html/group___conventionalvon_klitzing_constant.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.13"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>NISTConst: von Klitzing constant</title>
+<title>NISTConst: Conventional von Klitzing constant</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -88,7 +88,7 @@
   <div class="summary">
 <a href="#var-members">Variables</a>  </div>
   <div class="headertitle">
-<div class="title">von Klitzing constant<div class="ingroups"><a class="el" href="group___n_i_s_t_const.html">NIST Constants</a> &raquo; <a class="el" href="group___adopted.html">Adopted</a></div></div>  </div>
+<div class="title">Conventional von Klitzing constant<div class="ingroups"><a class="el" href="group___n_i_s_t_const.html">NIST Constants</a> &raquo; <a class="el" href="group___adopted.html">Adopted</a></div></div>  </div>
 </div><!--header-->
 <div class="contents">
 <table class="memberdecls">

diff --git a/doc/html/group___gravity_acceleration.html b/doc/html/group___gravity_acceleration.html
@@ -112,7 +112,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad5bc5f7f030bc2c467a8430
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(g_n \ (\frac{m}{s^2)\) Standard acceleration of gravity in meters per second squared. </p>
+<p>\(g_n \ (\frac{m}{s^2})\) Standard acceleration of gravity in meters per second squared. </p>
 
 </div>
 </div>
@@ -127,7 +127,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaabc6df92c25677a5b767445
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(g_n \ (\frac{m}{s^2)\) Uncertainty in standard acceleration of gravity in meters per second squared. Note should be 0.0 since it is a defined value. </p>
+<p>\(g_n \ (\frac{m}{s^2})\) Uncertainty in standard acceleration of gravity in meters per second squared. Note should be 0.0 since it is a defined value. </p>
 
 </div>
 </div>

diff --git a/doc/html/group___molar_mass_constant.html b/doc/html/group___molar_mass_constant.html
@@ -146,7 +146,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab1aae3b38f21cb9a15fdc82
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(M({^12C}) \ (\frac{kg}{mol})\) Molar mass of carbon-12 in kilograms per mole. </p>
+<p>\(M({^{12}C}) \ (\frac{kg}{mol})\) Molar mass of carbon-12 in kilograms per mole. </p>
 
 </div>
 </div>
@@ -161,7 +161,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae2fea17985c3e8877e1baab
         </tr>
       </table>
 </div><div class="memdoc">
-<p>\(M({^12C}) \ (\frac{kg}{mol})\) Uncertainty in molar mass of carbon-12 in kilograms per mole. Note should be 0.0 since it is a defined value. </p>
+<p>\(M({^{12}C}) \ (\frac{kg}{mol})\) Uncertainty in molar mass of carbon-12 in kilograms per mole. Note should be 0.0 since it is a defined value. </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,8 @@
 <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.0 </dd></dl>
-<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Add radd to all gyromagnetic ratio </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>
 </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

diff --git a/doc/html/modules.html b/doc/html/modules.html
@@ -145,8 +145,8 @@
 <tr id="row_0_3_11_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___stefan_boltzmann_constant.html" target="_self">Stefan-Boltzmann constant</a></td><td class="desc"></td></tr>
 <tr id="row_0_3_12_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___wien_displacement.html" target="_self">Wien displacement law constant</a></td><td class="desc"></td></tr>
 <tr id="row_0_4_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_4_" class="arrow" onclick="toggleFolder('0_4_')">&#9660;</span><a class="el" href="group___adopted.html" target="_self">Adopted</a></td><td class="desc"></td></tr>
-<tr id="row_0_4_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___conventional_josephson_constant.html" target="_self">Josephson constant</a></td><td class="desc"></td></tr>
-<tr id="row_0_4_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___conventionalvon_klitzing_constant.html" target="_self">von Klitzing constant</a></td><td class="desc"></td></tr>
+<tr id="row_0_4_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___conventional_josephson_constant.html" target="_self">Conventional Josephson constant</a></td><td class="desc"></td></tr>
+<tr id="row_0_4_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___conventionalvon_klitzing_constant.html" target="_self">Conventional von Klitzing constant</a></td><td class="desc"></td></tr>
 <tr id="row_0_4_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___molar_mass_constant.html" target="_self">Molar mass constant</a></td><td class="desc"></td></tr>
 <tr id="row_0_4_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___gravity_acceleration.html" target="_self">Gravity acceleration</a></td><td class="desc"></td></tr>
 <tr id="row_0_4_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___standard_atmosphere.html" target="_self">Standard atmosphere</a></td><td class="desc"></td></tr>

diff --git a/doc/html/search/all_14.js b/doc/html/search/all_14.js
@@ -1,6 +1,5 @@
 var searchData=
 [
-  ['von_20klitzing_20constant',['von Klitzing constant',['../group___conventionalvon_klitzing_constant.html',1,'']]],
   ['vonklitzingconstant',['vonKlitzingConstant',['../group__von_klitzing_constant.html#ga664441cab64a6a8feda702f6354c1e7f',1,'NISTConst::vonKlitzingConstant()'],['../group__von_klitzing_constant.html',1,'(Global Namespace)']]],
   ['vonklitzingconstantuncertainty',['vonKlitzingConstantUncertainty',['../group__von_klitzing_constant.html#ga8fa7b05f4ab4958f9bed81f592304e49',1,'NISTConst']]]
 ];
diff --git a/doc/html/search/all_2.js b/doc/html/search/all_2.js
diff --git a/doc/html/search/all_9.js b/doc/html/search/all_9.js
@@ -1,6 +1,5 @@
 var searchData=
 [
-  ['josephson_20constant',['Josephson constant',['../group___conventional_josephson_constant.html',1,'']]],
   ['josephsonconstant',['JosephsonConstant',['../group___josephson_constant.html#gae9f3553a6a6c5eed3df61ad33277cab8',1,'NISTConst::JosephsonConstant()'],['../group___josephson_constant.html',1,'(Global Namespace)']]],
   ['josephsonconstantuncertainty',['JosephsonConstantUncertainty',['../group___josephson_constant.html#gaa10eadf7c1811f94c5b5725ad300a099',1,'NISTConst']]],
   ['joule',['Joule',['../group___joule.html',1,'']]],

diff --git a/doc/html/search/groups_14.js b/doc/html/search/groups_14.js
@@ -1,5 +1,4 @@
 var searchData=
 [
-  ['von_20klitzing_20constant',['von Klitzing constant',['../group___conventionalvon_klitzing_constant.html',1,'']]],
   ['von_20klitzing_20constant',['von Klitzing constant',['../group__von_klitzing_constant.html',1,'']]]
 ];
diff --git a/doc/html/search/groups_2.js b/doc/html/search/groups_2.js
@@ -2,6 +2,8 @@ var searchData=
 [
   ['compton_20wavelength',['Compton Wavelength',['../group___compton_wavelength.html',1,'']]],
   ['conductance_20quantum',['Conductance quantum',['../group___conductance_quantum.html',1,'']]],
+  ['conventional_20josephson_20constant',['Conventional Josephson constant',['../group___conventional_josephson_constant.html',1,'']]],
+  ['conventional_20von_20klitzing_20constant',['Conventional von Klitzing constant',['../group___conventionalvon_klitzing_constant.html',1,'']]],
   ['conversion_20factors',['Conversion factors',['../group___conversion_factors.html',1,'']]],
   ['copper',['Copper',['../group___copper.html',1,'']]]
 ];
diff --git a/doc/html/search/groups_9.js b/doc/html/search/groups_9.js
@@ -1,6 +1,5 @@
 var searchData=
 [
-  ['josephson_20constant',['Josephson constant',['../group___conventional_josephson_constant.html',1,'']]],
   ['josephson_20constant',['Josephson constant',['../group___josephson_constant.html',1,'']]],
   ['joule',['Joule',['../group___joule.html',1,'']]]
 ];
diff --git a/doc/html/todo.html b/doc/html/todo.html
@@ -91,7 +91,7 @@
 <div class="contents">
 <div class="textblock"><dl class="reflist">
 <dt><a class="anchor" id="_todo000001"></a>Module <a class="el" href="group___n_i_s_t_const.html">NISTConst</a>  </dt>
-<dd>Add radd to all gyromagnetic ratio </dd>
+<dd>Add rad to all gyromagnetic ratio </dd>
 </dl>
 </div></div><!-- contents -->
 </div><!-- doc-content -->

diff --git a/doc/latex/group___adopted.tex b/doc/latex/group___adopted.tex
@@ -3,9 +3,9 @@
 \subsection*{Modules}
 \begin{DoxyCompactItemize}
 \item 
-\hyperlink{group___conventional_josephson_constant}{Josephson constant}
+\hyperlink{group___conventional_josephson_constant}{Conventional Josephson constant}
 \item 
-\hyperlink{group___conventionalvon_klitzing_constant}{von Klitzing constant}
+\hyperlink{group___conventionalvon_klitzing_constant}{Conventional von Klitzing constant}
 \item 
 \hyperlink{group___molar_mass_constant}{Molar mass constant}
 \item