testing doxygen comments

XENON1T · Sep 18, 2017 · 9baeb81 · 9baeb81
1 parent 8f0fa75
commit 9baeb81
Show file tree

Hide file tree

Showing 7 changed files with 201 additions and 197 deletions.
diff --git a/docs/XeLikelihoods_8h_source.html b/docs/XeLikelihoods_8h_source.html
@@ -241,9 +241,9 @@
 <div class="ttc" id="classLKParameter_html"><div class="ttname"><a href="classLKParameter.html">LKParameter</a></div><div class="ttdef"><b>Definition:</b> XeStat.h:2991</div></div>
 <div class="ttc" id="classdataHandler_html"><div class="ttname"><a href="classdataHandler.html">dataHandler</a></div><div class="ttdef"><b>Definition:</b> dataHandler.h:35</div></div>
 <div class="ttc" id="classpdfLikelihood_html"><div class="ttname"><a href="classpdfLikelihood.html">pdfLikelihood</a></div><div class="ttdef"><b>Definition:</b> XeLikelihoods.h:20</div></div>
-<div class="ttc" id="classhistoCompare_html"><div class="ttname"><a href="classhistoCompare.html">histoCompare</a></div><div class="ttdef"><b>Definition:</b> XePdfObjects.h:160</div></div>
+<div class="ttc" id="classhistoCompare_html"><div class="ttname"><a href="classhistoCompare.html">histoCompare</a></div><div class="ttdef"><b>Definition:</b> XePdfObjects.h:161</div></div>
 <div class="ttc" id="classProfileLikelihood_html"><div class="ttname"><a href="classProfileLikelihood.html">ProfileLikelihood</a></div><div class="ttdef"><b>Definition:</b> XeStat.h:3463</div></div>
-<div class="ttc" id="classpdfComponent_html"><div class="ttname"><a href="classpdfComponent.html">pdfComponent</a></div><div class="ttdef"><b>Definition:</b> XePdfObjects.h:67</div></div>
+<div class="ttc" id="classpdfComponent_html"><div class="ttname"><a href="classpdfComponent.html">pdfComponent</a></div><div class="ttdef"><b>Definition:</b> XePdfObjects.h:68</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

diff --git a/docs/XePdfObjects_8h_source.html b/docs/XePdfObjects_8h_source.html
diff --git a/docs/annotated.html b/docs/annotated.html
@@ -166,7 +166,7 @@
 <tr id="row_75_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSelectionCutS1.html" target="_self">SelectionCutS1</a></td><td class="desc"></td></tr>
 <tr id="row_76_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSelectionCutUnsmearedS1.html" target="_self">SelectionCutUnsmearedS1</a></td><td class="desc"></td></tr>
 <tr id="row_77_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSensitivityBands.html" target="_self">SensitivityBands</a></td><td class="desc"></td></tr>
-<tr id="row_78_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classshapeSys.html" target="_self">shapeSys</a></td><td class="desc"></td></tr>
+<tr id="row_78_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classshapeSys.html" target="_self">shapeSys</a></td><td class="desc">It represents a Shape Systematic. It inherits from <a class="el" href="classLKParameter.html">LKParameter</a>. Here you can use the <a class="el" href="classLKParameter.html">LKParameter</a> functions to set initial val, min, max and setp </td></tr>
 <tr id="row_79_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSigmaParameter.html" target="_self">SigmaParameter</a></td><td class="desc"></td></tr>
 <tr id="row_80_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSigmaRange.html" target="_self">SigmaRange</a></td><td class="desc"></td></tr>
 <tr id="row_81_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSignalAndBackground.html" target="_self">SignalAndBackground</a></td><td class="desc"></td></tr>

diff --git a/docs/classLKParameter.html b/docs/classLKParameter.html
@@ -105,7 +105,7 @@
 <area href="classXeCore.html" alt="XeCore" shape="rect" coords="0,0,134,24"/>
 <area href="classXeCore.html" alt="XeCore" shape="rect" coords="144,0,278,24"/>
 <area href="classscaleSys.html" alt="scaleSys" shape="rect" coords="252,224,386,248"/>
-<area href="classshapeSys.html" alt="shapeSys" shape="rect" coords="252,280,386,304"/>
+<area href="classshapeSys.html" title="it represents a Shape Systematic. It inherits from LKParameter. Here you can use the LKParameter func..." alt="shapeSys" shape="rect" coords="252,280,386,304"/>
 <area href="classSigmaParameter.html" alt="SigmaParameter" shape="rect" coords="252,336,386,360"/>
 <area href="classTEfficiencyParameter.html" alt="TEfficiencyParameter" shape="rect" coords="252,392,386,416"/>
 <area href="classTGaussParameter.html" alt="TGaussParameter" shape="rect" coords="252,448,386,472"/>

diff --git a/docs/classshapeSys.html b/docs/classshapeSys.html
@@ -90,6 +90,9 @@
 </div><!--header-->
 <div class="contents">
 
+<p>it represents a Shape Systematic. It inherits from <a class="el" href="classLKParameter.html">LKParameter</a>. Here you can use the <a class="el" href="classLKParameter.html">LKParameter</a> functions to set initial val, min, max and setp  
+ <a href="classshapeSys.html#details">More...</a></p>
+
 <p><code>#include &lt;<a class="el" href="XePdfObjects_8h_source.html">XePdfObjects.h</a>&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for shapeSys:</div>
@@ -743,7 +746,7 @@
 <tr class="separator:a77dd420f3efa9017becd6970480adfd7 inherit pro_static_attribs_classXeObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>Class representing a Shape Systematic, it inherits from <a class="el" href="classLKParameter.html">LKParameter</a>. here you can use the <a class="el" href="classLKParameter.html">LKParameter</a> functions to set initial val, min, max and setp </p>
+<div class="textblock"><p>it represents a Shape Systematic. It inherits from <a class="el" href="classLKParameter.html">LKParameter</a>. Here you can use the <a class="el" href="classLKParameter.html">LKParameter</a> functions to set initial val, min, max and setp </p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="a1816a4031694074a2734f73a57eb93c1"></a>
 <div class="memitem">

diff --git a/docs/hierarchy.html b/docs/hierarchy.html
@@ -197,7 +197,7 @@
 <tr id="row_3_0_9_3_1_4_" style="display:none;"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classS1S2PL.html" target="_self">S1S2PL</a></td><td class="desc"></td></tr>
 <tr id="row_3_0_9_4_" style="display:none;"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_3_0_9_4_" src="ftv2pnode.png" alt="o" width="16" height="22" onclick="toggleFolder('3_0_9_4_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLKParameter.html" target="_self">LKParameter</a></td><td class="desc"></td></tr>
 <tr id="row_3_0_9_4_0_" style="display:none;"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classscaleSys.html" target="_self">scaleSys</a></td><td class="desc"></td></tr>
-<tr id="row_3_0_9_4_1_" style="display:none;"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classshapeSys.html" target="_self">shapeSys</a></td><td class="desc"></td></tr>
+<tr id="row_3_0_9_4_1_" style="display:none;"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classshapeSys.html" target="_self">shapeSys</a></td><td class="desc">It represents a Shape Systematic. It inherits from <a class="el" href="classLKParameter.html">LKParameter</a>. Here you can use the <a class="el" href="classLKParameter.html">LKParameter</a> functions to set initial val, min, max and setp </td></tr>
 <tr id="row_3_0_9_4_2_" style="display:none;"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSigmaParameter.html" target="_self">SigmaParameter</a></td><td class="desc"></td></tr>
 <tr id="row_3_0_9_4_3_" style="display:none;"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classTEfficiencyParameter.html" target="_self">TEfficiencyParameter</a></td><td class="desc"></td></tr>
 <tr id="row_3_0_9_4_4_" style="display:none;"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classTGaussParameter.html" target="_self">TGaussParameter</a></td><td class="desc"></td></tr>

diff --git a/src/XePdfObjects.h b/src/XePdfObjects.h
@@ -17,8 +17,9 @@ using namespace std;
 
 
 /**
- * Class representing a Shape Systematic, it inherits from LKParameter.
- * here you can use the LKParameter functions to set initial val,
+ * \class shapeSys 
+ * \brief it represents a Shape Systematic. 
+ * It inherits from LKParameter. Here you can use the LKParameter functions to set initial val,
  * min, max and setp
 */
 class shapeSys : public LKParameter {