[lmi-commits] [5540] Revise comments

[Greg Chicares]

Revision: 5540
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5540
Author:   chicares
Date:     2012-08-09 09:37:13 +0000 (Thu, 09 Aug 2012)
Log Message:
-----------
Revise comments

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/main_cgi.cpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2012-08-09 09:19:35 UTC (rev 5539)
+++ lmi/trunk/ChangeLog 2012-08-09 09:37:13 UTC (rev 5540)
@@ -30567,3 +30567,13 @@
   yare_input.hpp
 Rename various input fields.
 
+20120809T0919Z <address@hidden> [570]
+
+  main_cgi.cpp
+Reformat.
+
+20120809T0937Z <address@hidden> [568]
+
+  main_cgi.cpp
+Revise comments.
+

Modified: lmi/trunk/main_cgi.cpp
===================================================================
--- lmi/trunk/main_cgi.cpp      2012-08-09 09:19:35 UTC (rev 5539)
+++ lmi/trunk/main_cgi.cpp      2012-08-09 09:37:13 UTC (rev 5540)
@@ -1,4 +1,4 @@
-// Common gateway interface using gnu cgicc.
+// Common gateway interface using gnu cgicc: a simplistic demo.
 //
 // Copyright (C) 1998, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 
2010, 2011, 2012 Gregory W. Chicares.
 //
@@ -19,6 +19,8 @@
 // email: <address@hidden>
 // snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 
+// $Id$
+
 // This is a derived work based on Stephen F. Booth's
 //   cgicc-3.1.4/demo/test.cpp
 // which bears copyright notice
@@ -31,8 +33,6 @@
 // other reasons evident in the repository or explained in 'ChangeLog'.
 // Any defect should not reflect on Stephen F. Booth's reputation.
 
-// $Id$
-
 #ifdef __BORLANDC__
 #   include "pchfile.hpp"
 #   pragma hdrstop
@@ -43,19 +43,19 @@
 #include "illustrator.hpp"
 #include "input.hpp"
 #include "main_common.hpp"
-#include "mc_enum_type_enums.hpp" // mcenum_emission
+#include "mc_enum_type_enums.hpp"       // mcenum_emission
 #include "miscellany.hpp"
 #include "path_utility.hpp"
-#include "platform_dependent.hpp" // putenv() [GWC]
+#include "platform_dependent.hpp"       // putenv() [GWC]
 #include "timer.hpp"
 #include "value_cast.hpp"
 
 #include <cgicc/Cgicc.h>
 #include <cgicc/CgiEnvironment.h>
-#include <cgicc/CgiUtils.h>       // gLogFile
+#include <cgicc/CgiUtils.h>             // gLogFile
 #include <cgicc/HTMLClasses.h>
 #ifdef USING_CURRENT_CGICC
-#   include <cgicc/HTTPHTMLHeader.h> // cgicc-3.2.3
+#   include <cgicc/HTTPHTMLHeader.h>    // cgicc-3.2.3
 #else // USING_CURRENT_CGICC not defined.
 #   include <cgicc/HTTPHeaders.h>
 #endif // USING_CURRENT_CGICC not defined.
@@ -65,7 +65,7 @@
 #include <fstream>
 #include <ios>
 #include <iostream>
-#include <istream>                // std::ws
+#include <istream>                      // std::ws
 #include <ostream>
 #include <sstream>
 #include <string>
@@ -86,7 +86,7 @@
 void ShowIllusOutput(Input const&);
 void ShowCensusOutput(Input const&, std::string const&, bool);
 
-// TODO ?? gnu getopt should be used here.
+// SOMEDAY !! It would be nicer to use gnu getopt here.
 int try_main(int argc, char* argv[])
 {
   try {
@@ -131,7 +131,6 @@
         "&SolveExpenseGeneralAccountBasis=Current"
         "&SpecifiedAmount=1000000"
         "&DeathBenefitOption=a"
-//        "&sRetDBOpt=A"
         "&Payment=0"
         "&PaymentMode=annual"
         "&Dumpin=0"
@@ -140,7 +139,6 @@
         "&1035ExchangeBasis=0"
         "&GeneralAccountRate=.055"
         "&GeneralAccountRateType=Credited rate"
-//        "&SeparateAccountRateType=Gross rate" // not used yet
         "&LoanRate=.055"
         "&LoanRateType=Fixed loan rate"
         "&Comments="
@@ -491,6 +489,7 @@
     input["SolveToWhich"]                    = "Year";
     input["UseCurrentDeclaredRate"]          = "No";
 
+    // Read input values.
     input["ProductName"]                     = GetValue(data, "ProductName"    
                );
     input["IssueAge"]                        = GetValue(data, "IssueAge"       
                );
     input["RetirementAge"]                   = GetValue(data, "RetirementAge"  
                );
@@ -506,17 +505,16 @@
     input["SolveTargetCashSurrenderValue"]   = GetValue(data, 
"SolveTargetCashSurrenderValue"  );
     input["SolveTargetYear"]                 = GetValue(data, 
"SolveTargetYear"                );
     input["SolveExpenseGeneralAccountBasis"] = GetValue(data, 
"SolveExpenseGeneralAccountBasis");
-    input["SpecifiedAmount"]                 = GetValue(data, 
"SpecifiedAmount"                ); // rename
-    input["DeathBenefitOption"]              = GetValue(data, 
"DeathBenefitOption"             ); // rename
+    input["SpecifiedAmount"]                 = GetValue(data, 
"SpecifiedAmount"                );
+    input["DeathBenefitOption"]              = GetValue(data, 
"DeathBenefitOption"             );
     input["Payment"]                         = GetValue(data, "Payment"        
                );
     input["PaymentMode"]                     = GetValue(data, "PaymentMode"    
                );
     input["Dumpin"]                          = GetValue(data, "Dumpin"         
                );
     input["Internal1035ExchangeAmount"]      = GetValue(data, 
"1035ExchangeAmount"             );
     input["Internal1035ExchangeFromMec"]     = GetValue(data, 
"1035ExchangeIsMec"              );
     input["Internal1035ExchangeTaxBasis"]    = GetValue(data, 
"1035ExchangeBasis"              );
-    input["GeneralAccountRate"]              = GetValue(data, 
"GeneralAccountRate"             ); // rename
+    input["GeneralAccountRate"]              = GetValue(data, 
"GeneralAccountRate"             );
     input["GeneralAccountRateType"]          = GetValue(data, 
"GeneralAccountRateType"         );
-//    input["SeparateAccountRateType"]         = GetValue(data, 
"SeparateAccountRateType"        ); // not used yet
     input["LoanRate"]                        = GetValue(data, "LoanRate"       
                );
     input["LoanRateType"]                    = GetValue(data, "LoanRateType"   
                );
 
@@ -674,8 +672,8 @@
         << "<BR>\n"
         ;
 
-    // TODO ?? This is terribly inefficient: we already did all the
-    // calculations for each life in order to get the composite.
+    // SOMEDAY !! Inefficient: we already did all the calculations for
+    // each life in order to get the composite.
     if(show_each_life)
         {
         for(i = lives.begin(); i != lives.end(); ++i)