[lmi-commits] [lmi] master 12d1b47 2/4: Improve documentation

[Greg Chicares]

branch: master
commit 12d1b47c2d7807e2a1ccff4ab5c9ae82e3a0a4fe
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Improve documentation
    
    "mostly": In the general case, a virtual page is rendered across several
    physical pages. The special case where a single page suffices is less
    common that it may at first have appeared.
    
    "// Make base class dtor virtual.": This could be read as an author's
    note to himself, meaning "don't forget to make this class's base class's
    dtor virtual." Apparently it means "this class is intended to be derived
    from, so its dtor is virtual", which doesn't really need a comment.
---
 ledger_pdf_generator_wx.cpp | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/ledger_pdf_generator_wx.cpp b/ledger_pdf_generator_wx.cpp
index f96af77..4bf73d8 100644
--- a/ledger_pdf_generator_wx.cpp
+++ b/ledger_pdf_generator_wx.cpp
@@ -658,8 +658,8 @@ class pdf_illustration;
 // Base class for all logical illustration pages.
 //
 // A single logical page may result in multiple physical pages of output, e.g.
-// if it contains a table not fitting on one page, but mostly these page
-// objects correspond to a single physical page of the resulting illustration.
+// if it contains a table not fitting on one page, although it may often
+// correspond to a single physical page of the resulting illustration.
 class page
 {
   public:
@@ -669,7 +669,6 @@ class page
     page(page const&) = delete;
     page& operator=(page const&) = delete;
 
-    // Make base class dtor virtual.
     virtual ~page() = default;
 
     // Associate the illustration object using this page with it.
@@ -727,7 +726,6 @@ class pdf_illustration : protected html_interpolator
         init_variables();
     }
 
-    // Make base class dtor virtual.
     virtual ~pdf_illustration() = default;
 
     // Add a page.