[lmi-commits] [4827] Improve documentation

[Greg Chicares]

Revision: 4827
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=4827
Author:   chicares
Date:     2010-04-02 15:03:32 +0000 (Fri, 02 Apr 2010)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/product_data.cpp
    lmi/trunk/product_data.hpp

Property Changed:
----------------
    lmi/trunk/product_data.cpp
    lmi/trunk/product_data.hpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2010-04-02 13:30:20 UTC (rev 4826)
+++ lmi/trunk/ChangeLog 2010-04-02 15:03:32 UTC (rev 4827)
@@ -24757,3 +24757,9 @@
   product_data.hpp
 Remove deprecated member functions of class product_data.
 
+20100402T1503Z <address@hidden> [761]
+
+  product_data.cpp
+  product_data.hpp
+Improve documentation.
+

Modified: lmi/trunk/product_data.cpp
===================================================================
--- lmi/trunk/product_data.cpp  2010-04-02 13:30:20 UTC (rev 4826)
+++ lmi/trunk/product_data.cpp  2010-04-02 15:03:32 UTC (rev 4827)
@@ -51,12 +51,18 @@
     ascribe_members();
 }
 
-product_data::product_data(std::string const& filename)
+/// Construct from product name.
+///
+/// The argument is a string (typically Input::ProductName) such as
+/// 'sample'. The appropriate extension and path are added here to
+/// produce a filepath.
+
+product_data::product_data(std::string const& product_name)
 {
     ascribe_members();
 
-    fs::path path(filename);
-    LMI_ASSERT(filename == path.leaf());
+    fs::path path(product_name);
+    LMI_ASSERT(product_name == path.leaf());
     path = fs::change_extension(path, ".policy");
     load(AddDataDir(path.string()));
 }
@@ -65,6 +71,8 @@
 {
 }
 
+/// Enregister certain data members for access via any_member<>[].
+
 void product_data::ascribe_members()
 {
     ascribe("DatabaseFilename"              , &product_data::DatabaseFilename  
            );
@@ -232,7 +240,7 @@
 /// Create a product file for the 'sample' product.
 ///
 /// Only the most crucial members are explicitly initialized. For the
-/// rest, default (empty) strings are good enough.
+/// rest, default (empty) strings are good enough for 'sample'.
 
 void product_data::WritePolFiles()
 {


Property changes on: lmi/trunk/product_data.cpp
___________________________________________________________________
Deleted: svn:executable
   - *

Modified: lmi/trunk/product_data.hpp
===================================================================
--- lmi/trunk/product_data.hpp  2010-04-02 13:30:20 UTC (rev 4826)
+++ lmi/trunk/product_data.hpp  2010-04-02 15:03:32 UTC (rev 4827)
@@ -51,7 +51,7 @@
     friend class PolicyDocument;
 
   public:
-    explicit product_data(std::string const& filename);
+    explicit product_data(std::string const& product_name);
     ~product_data();
 
     // Legacy functions to support creating product files programmatically.


Property changes on: lmi/trunk/product_data.hpp
___________________________________________________________________
Deleted: svn:executable
   - *