[lmi-commits] [5558] Improve documentation

[Greg Chicares]

Revision: 5558
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5558
Author:   chicares
Date:     2012-08-31 12:16:21 +0000 (Fri, 31 Aug 2012)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/cell.rnc
    lmi/trunk/cell.xsd
    lmi/trunk/types.rnc
    lmi/trunk/types.xsd

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2012-08-31 11:57:32 UTC (rev 5557)
+++ lmi/trunk/ChangeLog 2012-08-31 12:16:21 UTC (rev 5558)
@@ -30665,3 +30665,34 @@
   cell.xsd
 Mark fields for which inforce extracts should use default values.
 
+20120831T1057Z <address@hidden> [567]
+
+  input.cpp
+  input.hpp
+Change type of 'InforceDataSource'.
+
+20120831T1104Z <address@hidden> [567]
+
+  input.cpp
+Improve default for 'MaximumNaar'.
+
+20120831T1149Z <address@hidden> [567]
+
+  sample.cns
+  sample.ill
+Update specimen input files to reflect today's earlier changes.
+
+20120831T1157Z <address@hidden> [567]
+
+  cell.rnc
+  cell.xsd
+Update xml schemata to reflect today's earlier changes.
+
+20120831T1216Z <address@hidden> [567]
+
+  cell.rnc
+  cell.xsd
+  types.rnc
+  types.xsd
+Improve documentation.
+

Modified: lmi/trunk/cell.rnc
===================================================================
--- lmi/trunk/cell.rnc  2012-08-31 11:57:32 UTC (rev 5557)
+++ lmi/trunk/cell.rnc  2012-08-31 12:16:21 UTC (rev 5558)
@@ -142,9 +142,9 @@
      element ExtraMonthlyCustodialFee         {numeric_sequence}
     ,## Annual flat extra per thousand of specified amount.
      element FlatExtra                        {numeric_sequence}
-    ,## * As yet unused: cf. 'fund_input_method'.
+    ,## * As yet unused.
      element FundAllocations                  {text}
-    ,## * Fund-allocation override: cf. 'fund_input_method'.
+    ,## * Fund-allocation override.
      element FundChoiceType                   {fund_input_method}
     ,## Insured's gender for insurance purposes.
      element Gender                           {gender}
@@ -356,7 +356,7 @@
     ,## * Insured's retirement age.
      element RetirementAge                    {age_int}
     ,## * Order in which different individuals in a census are
-     ## processed: cf. 'run_order'.
+     ## processed.
      element RunOrder                         {run_order}
     ,## * Maximum salary-based specified amount.
      element SalarySpecifiedAmountCap         {nonnegative_double}
@@ -472,7 +472,7 @@
      element TotalSpecifiedAmount             {nonnegative_double}
     ,## Underwriting class.
      element UnderwritingClass                {class}
-    ,## * Use mean separate-account fee: cf. 'fund_input_method'.
+    ,## * Use mean separate-account fee.
      element UseAverageOfAllFunds             {yes_or_no}
     ,## * Use current declared rate (read from authenticated database)
      ## instead of entering the crediting rate explicitly.

Modified: lmi/trunk/cell.xsd
===================================================================
--- lmi/trunk/cell.xsd  2012-08-31 11:57:32 UTC (rev 5557)
+++ lmi/trunk/cell.xsd  2012-08-31 12:16:21 UTC (rev 5558)
@@ -525,12 +525,12 @@
   </xs:element>
   <xs:element name="FundAllocations" type="xs:string">
     <xs:annotation>
-      <xs:documentation>* As yet unused: cf. 
'fund_input_method'.</xs:documentation>
+      <xs:documentation>* As yet unused.</xs:documentation>
     </xs:annotation>
   </xs:element>
   <xs:element name="FundChoiceType" type="fund_input_method">
     <xs:annotation>
-      <xs:documentation>* Fund-allocation override: cf. 
'fund_input_method'.</xs:documentation>
+      <xs:documentation>* Fund-allocation override.</xs:documentation>
     </xs:annotation>
   </xs:element>
   <xs:element name="Gender" type="gender">
@@ -1000,7 +1000,7 @@
   <xs:element name="RunOrder" type="run_order">
     <xs:annotation>
       <xs:documentation>* Order in which different individuals in a census are
-processed: cf. 'run_order'.</xs:documentation>
+processed.</xs:documentation>
     </xs:annotation>
   </xs:element>
   <xs:element name="SalarySpecifiedAmountCap" type="nonnegative_double">
@@ -1278,7 +1278,7 @@
   </xs:element>
   <xs:element name="UseAverageOfAllFunds" type="yes_or_no">
     <xs:annotation>
-      <xs:documentation>* Use mean separate-account fee: cf. 
'fund_input_method'.</xs:documentation>
+      <xs:documentation>* Use mean separate-account fee.</xs:documentation>
     </xs:annotation>
   </xs:element>
   <xs:element name="UseCurrentDeclaredRate" type="yes_or_no">

Modified: lmi/trunk/types.rnc
===================================================================
--- lmi/trunk/types.rnc 2012-08-31 11:57:32 UTC (rev 5557)
+++ lmi/trunk/types.rnc 2012-08-31 12:16:21 UTC (rev 5558)
@@ -297,14 +297,14 @@
     | "Earlier of increase or unnecessary premium"
     | "GPT adjustment event"
 
-## Inclusive start of a half-open interval, used e.g. for input sequences.
+## Inclusive start of a half-open time interval.
 from_point =
       "Issue"
     | "Year"
     | "Age"
     | "Retirement"
 
-## Exclusive end of a half-open interval used e.g. for input sequences.
+## Exclusive end of a half-open time interval.
 to_point =
       "Retirement"
     | "Year"

Modified: lmi/trunk/types.xsd
===================================================================
--- lmi/trunk/types.xsd 2012-08-31 11:57:32 UTC (rev 5557)
+++ lmi/trunk/types.xsd 2012-08-31 12:16:21 UTC (rev 5558)
@@ -717,7 +717,7 @@
   </xs:simpleType>
   <xs:simpleType name="from_point">
     <xs:annotation>
-      <xs:documentation>Inclusive start of a half-open interval, used e.g. for 
input sequences.</xs:documentation>
+      <xs:documentation>Inclusive start of a half-open time 
interval.</xs:documentation>
     </xs:annotation>
     <xs:restriction base="xs:token">
       <xs:enumeration value="Issue"/>
@@ -728,7 +728,7 @@
   </xs:simpleType>
   <xs:simpleType name="to_point">
     <xs:annotation>
-      <xs:documentation>Exclusive end of a half-open interval used e.g. for 
input sequences.</xs:documentation>
+      <xs:documentation>Exclusive end of a half-open time 
interval.</xs:documentation>
     </xs:annotation>
     <xs:restriction base="xs:token">
       <xs:enumeration value="Retirement"/>