[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[lmi-commits] [lmi] master 0ab124d: Prefer C++ terminology
|
From: |
Greg Chicares |
|
Subject: |
[lmi-commits] [lmi] master 0ab124d: Prefer C++ terminology |
|
Date: |
Tue, 4 Sep 2018 22:58:00 -0400 (EDT) |
branch: master
commit 0ab124d7a3787d267c25c131ac4b26c45780fab6
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>
Prefer C++ terminology
"member function" might instead have been used to replace "method",
but "function" seemed clear enough in these changes.
---
database_view_editor.hpp | 2 +-
getopt.cpp | 2 +-
getopt.hpp | 2 +-
html.hpp | 6 +++---
input_sequence_entry.cpp | 4 ++--
ledger_pdf_generator_wx.cpp | 40 +++++++++++++++++-----------------
main_wx_test.cpp | 4 ++--
multidimgrid_any.cpp | 12 +++++------
multidimgrid_any.hpp | 48 ++++++++++++++++++++---------------------
multidimgrid_safe.hpp | 30 +++++++++++++-------------
multidimgrid_tools.cpp | 2 +-
multidimgrid_tools.hpp | 2 +-
rate_table.cpp | 16 +++++++-------
rate_table.hpp | 8 +++----
rate_table_test.cpp | 4 ++--
tier_view_editor.cpp | 2 +-
wx_test_about_version.cpp | 2 +-
wx_test_calculation_summary.cpp | 4 ++--
wx_test_case.hpp | 6 +++---
wx_test_default_update.cpp | 2 +-
wx_test_document.hpp | 8 +++----
wx_test_input_validation.cpp | 2 +-
wx_test_new.hpp | 4 ++--
23 files changed, 106 insertions(+), 106 deletions(-)
diff --git a/database_view_editor.hpp b/database_view_editor.hpp
index f35b89a..359eb6c 100644
--- a/database_view_editor.hpp
+++ b/database_view_editor.hpp
@@ -115,7 +115,7 @@ class DatabaseTableAdapter
/// Modification flag (dirty flag)
bool modified_;
- /// temporary buffer needed by DoGetValue() and DoSetValue() methods
+ /// temporary buffer needed by DoGetValue() and DoSetValue() functions
mutable std::vector<int> indexes_;
DECLARE_NO_COPY_CLASS(DatabaseTableAdapter)
diff --git a/getopt.cpp b/getopt.cpp
index cb3e1ec..eeb94b4 100644
--- a/getopt.cpp
+++ b/getopt.cpp
@@ -611,7 +611,7 @@ GetOpt::operator()()
switch(pfound->has_arg)
{
- // See methods List_Value and List_No_Value
+ // See functions List_Value and List_No_Value
case ALT_ARG:
case LIST_ARG:
nextchar += std::strlen(nextchar);
diff --git a/getopt.hpp b/getopt.hpp
index c7cd55b..0cdbc8d 100644
--- a/getopt.hpp
+++ b/getopt.hpp
@@ -195,7 +195,7 @@ class LMI_SO GetOpt
void exchange(char** argv);
- // Internal methods
+ // Internal functions
void Initialize(std::string const& a_optstring);
int List_Value(int i);
diff --git a/html.hpp b/html.hpp
index fbb2be8..d4ca6a1 100644
--- a/html.hpp
+++ b/html.hpp
@@ -34,7 +34,7 @@
/// Main idea is to avoid generating HTML using raw strings, which is error
/// prone and difficult to read and maintain. One source of errors is
/// forgetting to escape special characters, such as "<" or "&", and html::text
-/// class helps with this by providing from() method doing it automatically.
+/// class helps with this by providing from() function doing it automatically.
///
/// Another one is forgetting to close a tag (or closing a wrong one) and while
/// html::text is too low level to help with this, html::element can be used
@@ -107,7 +107,7 @@ class text
/// Append another text fragment to this one.
///
- /// This method allows chained invocation for appending more than one
+ /// This function allows chained invocation for appending more than one
/// fragment at once.
text& operator+=(text const& t)
@@ -190,7 +190,7 @@ class LMI_SO any_element
/// Represents a normal HTML element which can have content inside it.
///
/// This class uses the so called fluent API model in which calls to its
-/// different methods return the object itself and so can be chained together.
+/// different functions return the object itself and so can be chained
together.
/// For example (assuming an implicit "using namespace html"):
///
/// auto para_with_link =
diff --git a/input_sequence_entry.cpp b/input_sequence_entry.cpp
index 2caf96b..6220f81 100644
--- a/input_sequence_entry.cpp
+++ b/input_sequence_entry.cpp
@@ -249,12 +249,12 @@ class InputSequenceEditor
// out of scope.
int layout_freeze_count_;
- // This method may be called multiple times but if a LayoutOnceGuard
+ // This function may be called multiple times but if a LayoutOnceGuard
// currently exists, it does nothing immediately and just requests a
// layout at a later time.
void redo_layout();
- // This method is only called by LayoutOnceGuard or redo_layout() itself
+ // This function is only called by LayoutOnceGuard or redo_layout() itself
// and really lays out the dialog.
void really_do_layout();
diff --git a/ledger_pdf_generator_wx.cpp b/ledger_pdf_generator_wx.cpp
index a28ff1d..fbfcead 100644
--- a/ledger_pdf_generator_wx.cpp
+++ b/ledger_pdf_generator_wx.cpp
@@ -143,7 +143,7 @@ class html_interpolator
throw std::runtime_error("invalid lookup kind");
}
- // A method which can be used to interpolate an HTML string containing
+ // A function which can be used to interpolate an HTML string containing
// references to the variables defined for this illustration. The general
// syntax is the same as in the global interpolate_string() function, i.e.
// variables are of the form "{{name}}" and section of the form
@@ -355,7 +355,7 @@ class using_illustration_table
// Useful helper for creating the table generator using the columns defined
// by the separate (and simpler to implement) get_table_columns() pure
- // virtual method.
+ // virtual function.
wx_table_generator create_table_generator
(Ledger const& ledger
,pdf_writer_wx& writer
@@ -532,7 +532,7 @@ class scaled_image_cell : public html_cell_for_pdf_output
m_Height = wxRound(image.GetHeight() / scale_factor);
}
- // Override the base class method to actually render the image.
+ // Override the base class function to actually render the image.
void Draw
(wxDC& dc
,int x
@@ -636,7 +636,7 @@ class page
//
// This object is not passed as a ctor argument because it would be
// redundant, instead it is associated with the page when it's added to an
- // illustration. This method is supposed to be called only once and only by
+ // illustration. This function is supposed to be called only once and only
by
// pdf_illustration this page is being added to.
void illustration(pdf_illustration const& illustration)
{
@@ -648,7 +648,7 @@ class page
// Called before rendering any pages to prepare for doing this, e.g. by
// computing the number of pages needed.
//
- // This method must not draw anything on the wxDC, it is provided only for
+ // This function must not draw anything on the wxDC, it is provided only
for
// measurement purposes.
virtual void pre_render
(Ledger const& // ledger
@@ -667,13 +667,13 @@ class page
protected:
// The associated illustration, which will be non-null by the time our
- // virtual methods such as pre_render() and render() are called.
+ // virtual functions such as pre_render() and render() are called.
pdf_illustration const* illustration_ = nullptr;
};
// Base class for the different kinds of illustrations.
//
-// This object contains pages, added to it using its add() method, as well as
+// This object contains pages, added to it using its add() function, as well as
// illustration-global data registered as variables with html_interpolator and
// so available for the pages when expanding the external templates defining
// their contents.
@@ -743,15 +743,15 @@ class pdf_illustration : protected html_interpolator
writer.save();
}
- // Methods to be implemented by the derived classes to indicate which
+ // Functions to be implemented by the derived classes to indicate which
// templates should be used for the upper (above the separating line) and
// the lower parts of the footer. The upper template name may be empty if
// it is not used at all.
//
// Notice that the upper footer template name can be overridden at the page
- // level, the methods here define the default for all illustration pages.
+ // level, the functions here define the default for all illustration pages.
//
- // These methods are used by the pages deriving from page_with_footer.
+ // These functions are used by the pages deriving from page_with_footer.
virtual std::string get_upper_footer_template_name() const = 0;
virtual std::string get_lower_footer_template_name() const = 0;
@@ -1030,7 +1030,7 @@ class page_with_footer : public page
protected:
// Helper for the derived pages to get the vertical position of the footer.
- // Notice that it can only be used after calling our pre_render() method
+ // Notice that it can only be used after calling our pre_render() function
// as this is where it is computed.
int get_footer_top() const
{
@@ -1040,18 +1040,18 @@ class page_with_footer : public page
}
private:
- // Method to be overridden in the base class which should actually return
+ // Function to be overridden in the base class which should actually return
// the page number or equivalent string (e.g. "Appendix").
virtual std::string get_page_number() const = 0;
- // This method forwards to the illustration by default, but can be
+ // This function forwards to the illustration by default, but can be
// overridden to define a page-specific footer if necessary.
virtual std::string get_upper_footer_template_name() const
{
return illustration_->get_upper_footer_template_name();
}
- // This method uses get_page_number() and returns the HTML wrapping it
+ // This function uses get_page_number() and returns the HTML wrapping it
// and other fixed information appearing in the lower part of the footer.
html::text get_footer_lower_html(html_interpolator const&
interpolate_html) const
{
@@ -1149,7 +1149,7 @@ class numbered_page : public page_with_footer
protected:
void next_page(pdf_writer_wx& writer)
{
- // This method may only be called if we had reserved enough physical
+ // This function may only be called if we had reserved enough physical
// pages for these logical pages by overriding
get_extra_pages_needed().
LMI_ASSERT(0 < extra_pages_);
@@ -1160,7 +1160,7 @@ class numbered_page : public page_with_footer
}
private:
- // Derived classes may override this method if they may need more than one
+ // Derived classes may override this function if they may need more than
one
// physical page to show their contents.
virtual int get_extra_pages_needed
(Ledger const& ledger
@@ -1279,7 +1279,7 @@ class numeric_summary_table_cell
m_Height = render_or_measure(0, oe_only_measure);
}
- // Override the base class method to actually render the table.
+ // Override the base class function to actually render the table.
void Draw
(wxDC & dc
,int x
@@ -1751,7 +1751,7 @@ class page_with_tabular_report
return pos_y;
}
- // Override the base class method as the table may overflow onto the next
+ // Override the base class function as the table may overflow onto the next
// page(s).
int get_extra_pages_needed
(Ledger const& ledger
@@ -1925,7 +1925,7 @@ class ill_reg_tabular_detail2_page : public
page_with_tabular_report
// Class for pages showing supplemental report after the fixed template
// contents. It can be either used directly or further derived from, e.g. to
-// override some of its inherited virtual methods such as
+// override some of its inherited virtual functions such as
// get_upper_footer_template_name() as done below.
class standard_supplemental_report : public page_with_tabular_report
{
@@ -2160,7 +2160,7 @@ class pdf_illustration_regular : public pdf_illustration
class page_with_basic_tabular_report : public page_with_tabular_report
{
private:
- // This method must be overridden to return the text of the super-header
+ // This function must be overridden to return the text of the super-header
// used for all pairs of "cash surrender value" and "death benefit"
// columns. The return value is subject to HTML interpolation and so may
// contain {{variables}} and also can be multiline but, if so, it must have
diff --git a/main_wx_test.cpp b/main_wx_test.cpp
index df5ec53..18315c1 100644
--- a/main_wx_test.cpp
+++ b/main_wx_test.cpp
@@ -620,7 +620,7 @@ class SkeletonTest : public Skeleton
}
protected:
- // Override base class virtual method.
+ // Override base class virtual function.
DocManagerEx* CreateDocManager() override;
// wxApp overrides.
@@ -659,7 +659,7 @@ DocManagerEx* SkeletonTest::CreateDocManager()
public:
void FileHistoryLoad(wxConfigBase const&) override
{
- // We could call the base class method here, but it doesn't seem
+ // We could call the base class function here, but it doesn't seem
// useful to do it and doing nothing here makes it more symmetric
// with FileHistorySave().
}
diff --git a/multidimgrid_any.cpp b/multidimgrid_any.cpp
index 47173e1..771560d 100644
--- a/multidimgrid_any.cpp
+++ b/multidimgrid_any.cpp
@@ -39,7 +39,7 @@
#include <algorithm>
#include <sstream>
-/// MultiDimAxisAny methods implementation
+/// MultiDimAxisAny functions implementation
/// --------------------------------------
wxWindow* MultiDimAxisAny::CreateAdjustControl
@@ -73,7 +73,7 @@ void
MultiDimAxisAny::UpdateChoiceControl(MultiDimAxisAnyChoice& choice) const
choice.PopulateChoiceList();
}
-/// MultiDimTableAny methods implementation
+/// MultiDimTableAny functions implementation
/// ---------------------------------------
bool MultiDimTableAny::DoApplyAxisAdjustment
@@ -195,7 +195,7 @@ void MultiDimGridGrid::UponKeyDown(wxKeyEvent& event)
///
/// This class prevents unneeded redrawing of the table to take place.
/// Under the hood it counts the number of contexts calling Table::Update
-/// method. It calls for Table::DoUpdate only when that counter drops to zero,
+/// function. It calls for Table::DoUpdate only when that counter drops to
zero,
/// which means that we are exiting the outermost context which called for
/// an update and it is the place to do it once for all the calls.
@@ -227,7 +227,7 @@ inline
GridRefreshTableDataGuard::~GridRefreshTableDataGuard()
}
}
-/// MultiDimGrid methods implementation
+/// MultiDimGrid functions implementation
/// -----------------------------------
BEGIN_EVENT_TABLE(MultiDimGrid, wxPanel)
@@ -502,7 +502,7 @@ bool MultiDimGrid::RefreshTableAxis()
}
}
- // TODO ?? this method should check for changes in the table
+ // TODO ?? this function should check for changes in the table
// data structure (number of axis, types of axis), and refresh accordingly
if(AutoselectGridAxis())
{
@@ -1339,7 +1339,7 @@ unsigned int MultiDimGrid::EnsureIndexIsPositive(int
row_or_col) const
return static_cast<unsigned int>(row_or_col);
}
-/// MultiDimAxisAnyChoice methods implementation
+/// MultiDimAxisAnyChoice functions implementation
/// --------------------------------------------
BEGIN_EVENT_TABLE(MultiDimAxisAnyChoice, wxChoice)
EVT_CHOICE(wxID_ANY, MultiDimAxisAnyChoice::UponSelectionChange)
diff --git a/multidimgrid_any.hpp b/multidimgrid_any.hpp
index 8168273..78907ad 100644
--- a/multidimgrid_any.hpp
+++ b/multidimgrid_any.hpp
@@ -60,7 +60,7 @@
/// - applying adjustments made by the user through an adjustment control to
/// the MultiDimTable. Triggered by MultiDimGrid::RefreshAxisAdjustment().
/// Both MultiDimGrid::ApplyAxisAdjustment() and
-/// MultiDimGrid::RefreshAxisAdjustment() are two step methods.
+/// MultiDimGrid::RefreshAxisAdjustment() are two step functions.
/// MultiDimGrid::ApplyAxisAdjustment():
/// - apply adjustment from adjustment window to its axis
/// MultiDimAxisAny::ApplyAdjustment()
@@ -83,7 +83,7 @@
///
/// The default implementation of axis choice control is a drop down list of
/// axis values. When a value is chosen the control should trigger
-/// MultiDimGrid::FixAxisValue() method to notify the grid about axis value
+/// MultiDimGrid::FixAxisValue() function to notify the grid about axis value
/// change.
#include "config.hpp"
@@ -149,12 +149,12 @@ class WXDLLIMPEXP_FWD_CORE wxGridBagSizer;
/// manually otherwise).
///
/// UpdateChoiceControl() updates the values in the choice control
-/// of this axis. This method is called when there are changes made to the axis
+/// of this axis. This function is called when there are changes made to the
axis
/// itself. When adjustable axis is changed the MultiDimGrid will call
-/// this method asking the axis to reflect the changes in the choice control.
+/// this function asking the axis to reflect the changes in the choice control.
/// The default implementation does the refresh by simply clearing and
-/// repopulating the choice control. If CreateChoiceControl() method returns
-/// any other custom widget and the axis is adjustable then this method
+/// repopulating the choice control. If CreateChoiceControl() function returns
+/// any other custom widget and the axis is adjustable then this function
/// should be manually overriden.
///
/// CreateAdjustControl() creates a GUI element used to let user to restrain
@@ -163,27 +163,27 @@ class WXDLLIMPEXP_FWD_CORE wxGridBagSizer;
/// A simple example: an integer axis with values in some range, the adjustment
/// control then should be used to restrain shown upper and lower bounds, or
/// maybe to change step size for the axis values shown to the user).
-/// The default version of the method returns NULL indicating that this axis
+/// The default version of the function returns NULL indicating that this axis
/// (and its value range) is immutable.
///
/// ApplyAdjustment() reads and applies an adjustment from adjustment window
-/// of this axis. This method is called when user changes axis value range
+/// of this axis. This function is called when user changes axis value range
/// (via this axis adjustment window). It is a part of action-chain performed
/// by MultiDimGrid upon a user action:
-/// - from adjustment control to axis object (this method)
+/// - from adjustment control to axis object (this function)
/// - from axis object to the data table object
/// (MultiDimTableAny::ApplyAxisAdjustment)
/// - some updates on grid internal widgets to refresh the shown data
-/// The method is responsible for updating the internal axis value range
-/// from the adjustment control. The method returns true if the update
+/// The function is responsible for updating the internal axis value range
+/// from the adjustment control. The function returns true if the update
/// has taken place, false if no changes detected.
///
/// RefreshAdjustment() refreshes the adjustment window of the axis. This
-/// method is called when the axis object is updated from inside the code and
+/// function is called when the axis object is updated from inside the code and
/// the adjustment window needs to be synchronized with its axis current state.
/// It is a part of chain of refreshes made by MultiDimGrid when
/// the underlying data table is changed and axes need to be updated.
-/// This method returns true if the update has taken place, false if everything
+/// This function returns true if the update has taken place, false if
everything
/// was up-to-date.
class MultiDimAxisAny
@@ -212,7 +212,7 @@ class MultiDimAxisAny
MultiDimAxisAny(MultiDimAxisAny const&) = delete;
MultiDimAxisAny& operator=(MultiDimAxisAny const&) = delete;
- /// Name of the axis used throughout the MultiDimGrid methods
+ /// Name of the axis used throughout the MultiDimGrid functions
std::string const name_;
};
@@ -243,11 +243,11 @@ inline std::string const& MultiDimAxisAny::GetName() const
/// GetAxesAny() returns the axes objects for that table. It could be called
/// multiple times - once for every MultiDimGrid using this table as its data
/// source. N-th axis returned represents nth dimension and holds value range
-/// for that dimension. This method redirects to pure virtual DoGetAxesAny().
+/// for that dimension. This function redirects to pure virtual DoGetAxesAny().
///
/// ApplyAxisAdjustment() reads from the axis object and apply
-/// any adjustment to the data table. Method is a part of the update chain
-/// that happen when user changes axis value range at runtime. This method
+/// any adjustment to the data table. Function is a part of the update chain
+/// that happen when user changes axis value range at runtime. This function
/// is responsible for reading new value range from the axis object and
/// applying it to the data table value domain. Parameters:
/// - axis the axis object containing axis value range adjustments
@@ -256,7 +256,7 @@ inline std::string const& MultiDimAxisAny::GetName() const
/// was up-to-date
///
/// RefreshAxisAdjustment() refreshes the axis object to reflect
-/// the data table domain value range. Method is a part of the adjustment
+/// the data table domain value range. Function is a part of the adjustment
/// refresh chain called by MultiDimGrid to synchronize the structures
/// with the underlying data table updated in some way. Parameters:
/// - axis the axis object that should be synced with the table
@@ -309,7 +309,7 @@ class MultiDimTableAny
std::any GetValueAny(Coords const& coords) const;
void SetValueAny(Coords const& coords, std::any const& value);
- /// Value conversion methods to be overriden in derived classes.
+ /// Value conversion functions to be overriden in derived classes.
virtual std::any StringToValue(std::string const& value) const = 0;
virtual std::string ValueToString(std::any const& value) const = 0;
@@ -405,9 +405,9 @@ inline void MultiDimTableAny::SetValueAny
///
/// RefreshTableData(): Refresh the data shown in the wxGrid control
/// of the widget.
-/// Call this method if you need to refresh the data shown to the user
+/// Call this function if you need to refresh the data shown to the user
/// in the grid control.
-/// It redirects to DoRefreshTableData(). If one suspect to call this method
+/// It redirects to DoRefreshTableData(). If one suspect to call this function
/// (directly or indirectly) multiple times as a part of chain of refreshes,
/// it could be protected by GridRefreshTableDataGuard.
/// See also GridRefreshTableDataGuard
@@ -515,7 +515,7 @@ class MultiDimGrid
,e_axis_y
};
- // Use these methods to access table_ and grid_ pointers. Note that these
+ // Use these functions to access table_ and grid_ pointers. Note that these
// getters will throw if the underlying pointer is NULL.
MultiDimTableAny& table() const;
wxGrid& grid() const;
@@ -629,7 +629,7 @@ class MultiDimGrid
MultiDimAxisAny& GetAxis(unsigned int n);
MultiDimAxisAny const& GetAxis(unsigned int n) const;
- /// This is the actual method that performs the refresh.
+ /// This is the actual function that performs the refresh.
void DoRefreshTableData();
bool DoRefreshAxisVaries(unsigned int n);
@@ -639,7 +639,7 @@ class MultiDimGrid
/// Autoselects two first non-disabled axis
bool AutoselectGridAxis();
- /// Helper for the AutoselectGridAxis() method
+ /// Helper for the AutoselectGridAxis() function
std::pair<int,int> SuggestGridAxisSelection() const;
bool DoApplyAxisAdjustment(unsigned int n);
diff --git a/multidimgrid_safe.hpp b/multidimgrid_safe.hpp
index 60d72dc..3cf94f4 100644
--- a/multidimgrid_safe.hpp
+++ b/multidimgrid_safe.hpp
@@ -42,10 +42,10 @@
/// These classes are provided to allow the type-safe use/checks when the axis
/// and table types are known at compile time.
///
-/// Almost every untyped virtual method is reimplemented in those classes to
-/// redirect the work to its Do* twin virtual method that takes correctly typed
+/// Almost every untyped virtual function is reimplemented in those classes to
+/// redirect the work to its Do* twin virtual function that takes correctly
typed
/// parameters.
-/// You should not use untyped method versions (such as
MultiDimAxis::GetValue(),
+/// You should not use untyped function versions (such as
MultiDimAxis::GetValue(),
/// MultiDimTable::SetValue()) - use typed versions instead
/// (MultiDimAxis::DoGetValue(), MultiDimTable::DoSetValue()).
@@ -56,8 +56,8 @@
/// Use it as the base class for any specific custom axis with known value
type.
/// See also MultiDimEnumAxis MultiDimIntAxis
///
-/// GetValue(n): Redirect the method to the typed method DoGetValue()
-/// This method should not be used at all, use DoGetValue() instead
+/// GetValue(n): Redirect the function to the typed function DoGetValue()
+/// This function should not be used at all, use DoGetValue() instead
template<typename E>
class MultiDimAxis
@@ -181,12 +181,12 @@ struct ValueCastConversion
/// Template parameters are:
/// - T Type of the table values.
/// - Derived Type of the deriving class.
-/// - ConversionPolicy A class providing two const member (or static) methods
+/// - ConversionPolicy A class providing two const member (or static)
functions
/// ValueToString and StringToValue which will be used to convert between
/// std::string and T. The default is to use ValueCastConversion.
///
-/// DoGetValue and DoSetValue: These two methods has to be provided in
-/// the derived class. These methods are not virtual in MultiDimGridN.
+/// DoGetValue and DoSetValue: These two functions has to be provided in
+/// the derived class. These functions are not virtual in MultiDimGridN.
///
/// Example of usage:
/// class MyTable
@@ -216,12 +216,12 @@ class MultiDimTable
protected:
/// MultiDimTable contract:
- /// The Derived class has to implement these two methods.
- /// Note that these methods are not virtual.
+ /// The Derived class has to implement these two functions.
+ /// Note that these functions are not virtual.
T DoGetValue(Coords const&) const;
void DoSetValue(Coords const&, T const&);
- /// Helper methods for unwrapping/wrapping a value from/into std::any.
+ /// Helper functions for unwrapping/wrapping a value from/into std::any.
template<typename A>
static A UnwrapAny(std::any const&);
template<typename A>
@@ -240,7 +240,7 @@ class MultiDimTable
/// Adjustable Axis base class.
///
/// Use this class as the base for you adjustable axis. This class defines
-/// type-safe methods to implement.
+/// type-safe functions to implement.
///
/// This template uses BaseAxisType as its base class. The only constraint
/// is that this base class has to have a constructor taking axis name as
@@ -250,9 +250,9 @@ class MultiDimTable
/// - AdjustControl type of the adjustment control you will use for the axis
/// - BaseAxisType base class to use for the axis
///
-/// CreateAdjustControl(grid, table): Redirects to type-safe method
+/// CreateAdjustControl(grid, table): Redirects to type-safe function
/// DoCreateAdjustControl().
-/// Do not override this method, override DoCreateAdjustControl instead.
+/// Do not override this function, override DoCreateAdjustControl instead.
template<typename AdjustControl, typename BaseAxisType = MultiDimAxisAny>
class MultiDimAdjustableAxis
@@ -267,7 +267,7 @@ class MultiDimAdjustableAxis
/// This ctor is protected because this class has to be derived from.
MultiDimAdjustableAxis(std::string const& name);
- /// Type-safe versions of the corresponding methods.
+ /// Type-safe versions of the corresponding functions.
virtual AxisAdjustControl* DoCreateAdjustControl
(MultiDimGrid& grid
,MultiDimTableAny& table
diff --git a/multidimgrid_tools.cpp b/multidimgrid_tools.cpp
index b3af96c..dcb6d31 100644
--- a/multidimgrid_tools.cpp
+++ b/multidimgrid_tools.cpp
@@ -124,7 +124,7 @@ void AutoResizingTreeCtrl::DoGetBestSizePrivate
,bool is_root
)
{
- // This method recursivly expands all the nodes in the tree and calculates
+ // This function recursively expands all the nodes in the tree and
calculates
// widest bounding rectangle width. It then collapses back originally
// collapsed nodes and returns.
if(!is_root)
diff --git a/multidimgrid_tools.hpp b/multidimgrid_tools.hpp
index 27b364c..c3b7ef4 100644
--- a/multidimgrid_tools.hpp
+++ b/multidimgrid_tools.hpp
@@ -80,7 +80,7 @@ class AxisMaxBoundAdjusterBase
/// Once user selects a number (115 for example), this number becomes maximum
/// for the axis values (the axis value domain becomes [-10, 115]).
///
-/// Two parameters used throughout the class methods:
+/// Two parameters used throughout the class functions:
/// - maximum_upper_bound - upper bound for the maximum axis value
/// - maximum_lower_bound - lower bound for the maximum axis value
diff --git a/rate_table.cpp b/rate_table.cpp
index f895cd0..68ddb5b 100644
--- a/rate_table.cpp
+++ b/rate_table.cpp
@@ -836,7 +836,7 @@ class table_impl final
bool is_equal(table_impl const& other) const;
- // Public class method implementations.
+ // Public class function implementations.
void name(std::string const& name) { name_ = name; }
std::uint32_t number() const { return *number_; }
std::string const& name() const { return *name_; }
@@ -846,14 +846,14 @@ class table_impl final
table_impl(table_impl const&) = delete;
table_impl& operator=(table_impl const&) = delete;
- // Helper methods for IO: all of them throw std::runtime_error on failure
+ // Helper functions for IO: all of them throw std::runtime_error on failure
// and mention the field name in the error message.
//
// They also check that the optional value provided as the output parameter
// for reading data into is not initialized yet as it's an error to have
// duplicate fields in our format.
- // read_xxx() methods for binary format.
+ // read_xxx() functions for binary format.
static void read_string
(std::optional<std::string>& ostr
@@ -888,13 +888,13 @@ class table_impl final
,std::uint16_t length
);
- // This one is different from the generic methods above as it's only used
+ // This one is different from the generic functions above as it's only used
// for the specific values_ field and not any arbitrary vector.
void read_values(std::istream& ifs, std::uint16_t length);
- // parse_xxx() methods for text format.
+ // parse_xxx() functions for text format.
- // This method returns the pointer to ostr string value to allow further
+ // This function returns the pointer to ostr string value to allow further
// modifying it later in the caller.
static std::string* parse_string
(std::optional<std::string>& ostr
@@ -2409,7 +2409,7 @@ class database_impl final
mutable std::shared_ptr<table_impl> table_;
};
- // Add an entry to the index. This method should be always used instead of
+ // Add an entry to the index. This function should be always used instead
of
// updating index_ vector directly as it also takes care of updating
// index_by_number_ map.
//
@@ -2730,7 +2730,7 @@ void database_impl::save(fs::path const& path)
std::ostream& index() { return index_.ofs_; }
std::ostream& database() { return database_.ofs_; }
- // The core of this class functionality is in this method: it tries to
+ // The core of this class functionality is in this function: it tries
to
// atomically rename the files to the real output path and throws,
// without changing the (possibly) existing file at the given path, on
// failure.
diff --git a/rate_table.hpp b/rate_table.hpp
index ecb7cb2..030c9b5 100644
--- a/rate_table.hpp
+++ b/rate_table.hpp
@@ -84,7 +84,7 @@ class table
Number number() const;
std::string const& name() const;
- // Method computing the hash value as used in the original SOA format.
+ // Function computing the hash value as used in the original SOA format.
std::uint32_t compute_hash_value() const;
// Comparison with another table: all fields are compared.
@@ -155,14 +155,14 @@ class database final
// Add a new table, throws if a table with the same number already exists.
//
// Notice that the addition of the new tables only are taken into account
- // when and if the database is saved using save() method. However
+ // when and if the database is saved using save() function. However
// tables_count() return value is updated immediately and calling this
- // method invalidates the previously valid indices.
+ // function invalidates the previously valid indices.
void append_table(table const& table);
// Add a new table, replacing the existing one with the same number, if
any.
//
- // The notes for append_table() also apply to this method.
+ // The notes for append_table() also apply to this function.
void add_or_replace_table(table const& table);
// Delete a table with the given number.
diff --git a/rate_table_test.cpp b/rate_table_test.cpp
index 91db325..981239e 100644
--- a/rate_table_test.cpp
+++ b/rate_table_test.cpp
@@ -62,7 +62,7 @@ class std_out_redirector
std_out_redirector(std_out_redirector const&) = delete;
std_out_redirector& operator=(std_out_redirector const&) = delete;
- // For convenience, this method returns everything output so far and clears
+ // For convenience, this function returns everything output so far and
clears
// the output, i.e. the next call to it will only return output appearing
// after this call. The name is supposed to emphasize this.
std::string take_output()
@@ -74,7 +74,7 @@ class std_out_redirector
private:
// The order of declarations here is important: stream_out_ must be
- // initialzied before orig_streambuf_ whose initialization uses it.
+ // initialized before orig_streambuf_ whose initialization uses it.
// The stream where cout is redirected during this object life-time.
std::ostringstream stream_out_;
diff --git a/tier_view_editor.cpp b/tier_view_editor.cpp
index fbf888a..d4152c1 100644
--- a/tier_view_editor.cpp
+++ b/tier_view_editor.cpp
@@ -195,7 +195,7 @@ TierEditorGrid::TierEditorGrid
)
{
// We use default MultiDimGrid constructor and Create() call here, because
- // MultiDimGrid constructor/Create calls some of the methods TierEditorGrid
+ // MultiDimGrid constructor/Create calls some of the functions
TierEditorGrid
// overrides, so the object has to be fully constructed by the time
// MultiDimGrid::Create() is called.
Create(parent, table, id, pos, size);
diff --git a/wx_test_about_version.cpp b/wx_test_about_version.cpp
index 74ed199..540275a 100644
--- a/wx_test_about_version.cpp
+++ b/wx_test_about_version.cpp
@@ -209,7 +209,7 @@ LMI_WX_TEST_CASE(about_dialog_version)
// high vertical resolutions.
//
// The first test just checks that the return value of
- // LineXXX() methods makes sense: it should return false if
+ // LineXXX() functions makes sense: it should return false
if
// no scrolling is possible. The second test checks that
// scrolling down does actually work.
LMI_ASSERT_WITH_MSG
diff --git a/wx_test_calculation_summary.cpp b/wx_test_calculation_summary.cpp
index cc3c218..a9308fb 100644
--- a/wx_test_calculation_summary.cpp
+++ b/wx_test_calculation_summary.cpp
@@ -79,7 +79,7 @@ int const total_number_of_columns = 12;
// Base class for all the tests working with the preferences dialog. It
// defines both a simpler interface for the derived classes to define the
-// tests with the preferences dialog, and also provides a helper run() method
+// tests with the preferences dialog, and also provides a helper run() function
// which shows the preferences dialog and performs these checks.
class expect_preferences_dialog_base
:public wxExpectModalBase<MvcController>
@@ -170,7 +170,7 @@ class expect_preferences_dialog_base
}
// These variables are only valid inside the overridden
- // OnPreferencesInvoked() method.
+ // OnPreferencesInvoked() function.
MvcController* dialog_;
wxCheckBox* use_checkbox_;
};
diff --git a/wx_test_case.hpp b/wx_test_case.hpp
index 5d65a4a..6e64966 100644
--- a/wx_test_case.hpp
+++ b/wx_test_case.hpp
@@ -52,7 +52,7 @@ class wx_base_test_case
/// for them to not be available and this shouldn't result in the test
/// errors.
///
- /// Notice that this method needs to be public to be usable from helpers of
+ /// Notice that this function needs to be public to be usable from helpers
of
/// the tests and not just from the test code itself.
///
/// The file doesn't need to exist, but must have the correct extension.
@@ -75,14 +75,14 @@ class wx_base_test_case
/// Return true if running in distribution testing mode.
///
- /// This method is used to partially skip execution of the tests that are
+ /// This function is used to partially skip execution of the tests that are
/// specific to the binary program distribution. If the entire test should
/// be skipped, prefer to use skip_if_not_distribution() instead.
bool is_distribution_test() const;
/// Skip the test if not running in distribution testing mode.
///
- /// This method can be used to skip execution of a test entirely unless
+ /// This function can be used to skip execution of a test entirely unless
/// --distribution command line option was specified.
///
/// Throws test_skipped_exception if the distribution option was not given.
diff --git a/wx_test_default_update.cpp b/wx_test_default_update.cpp
index 49cf59f..4ed7c0e 100644
--- a/wx_test_default_update.cpp
+++ b/wx_test_default_update.cpp
@@ -117,7 +117,7 @@ LMI_WX_TEST_CASE(default_update)
return "defaults dialog";
}
- // Helper method toggling the value of the "UseDOB" field which can be
+ // Helper function toggling the value of the "UseDOB" field which can
be
// represented by either a check box or a two element radio box
// depending on the skin used.
static void ToggleUseDOB(wxWindow* usedob_window)
diff --git a/wx_test_document.hpp b/wx_test_document.hpp
index 853061d..ddb0851 100644
--- a/wx_test_document.hpp
+++ b/wx_test_document.hpp
@@ -43,7 +43,7 @@ wxWindow* wx_test_focus_controller_child(MvcController&
dialog, char const* name
/// Helper base class for classes creating or opening documents.
///
-/// This class provides methods for closing the current document, optionally
+/// This class provides functions for closing the current document, optionally
/// discarding the changes done to it.
///
/// Unfortunately it is impossible to close the document automatically from
@@ -112,7 +112,7 @@ class wx_test_document_base
}
protected:
- // This method should be called by the derived classes when the document
+ // This function should be called by the derived classes when the document
// window is really opened.
void set_opened() { opened_ = true; }
@@ -120,7 +120,7 @@ class wx_test_document_base
wx_test_document_base(wx_test_document_base const&) = delete;
wx_test_document_base& operator=(wx_test_document_base const&) = delete;
- // Common part of different close() methods.
+ // Common part of different close() functions.
void do_close()
{
// If we started closing the document, we should reset the flag: even
@@ -138,7 +138,7 @@ class wx_test_document_base
/// Represents an existing illustration document.
///
/// Instantiating an object of this class simulates opening the specified
-/// illustration. Its close() method must be called before destroying an object
+/// illustration. Its close() function must be called before destroying an
object
/// of this class to ensure that it doesn't stay open.
class wx_test_existing_illustration
diff --git a/wx_test_input_validation.cpp b/wx_test_input_validation.cpp
index 89b452b..67e5c3e 100644
--- a/wx_test_input_validation.cpp
+++ b/wx_test_input_validation.cpp
@@ -56,7 +56,7 @@
///
/// Errors are tested by catching the exceptions and examining their associated
/// messages and not by checking for the message boxes displayed by the program
-/// because these message boxes are shown from OnExceptionInMainLoop() method
+/// because these message boxes are shown from OnExceptionInMainLoop() function
/// of the application object which behaves differently in the test suite.
namespace
diff --git a/wx_test_new.hpp b/wx_test_new.hpp
index e9cc476..daa7a95 100644
--- a/wx_test_new.hpp
+++ b/wx_test_new.hpp
@@ -29,7 +29,7 @@
/// Represents a new illustration document.
///
/// Instantiating an object of this class simulates creating a new
illustration.
-/// Its close() method must be called before destroying an object of this class
+/// Its close() function must be called before destroying an object of this
class
/// to ensure that it doesn't stay open.
class wx_test_new_illustration
@@ -68,7 +68,7 @@ class wx_test_new_illustration
/// Represents a new census document.
///
/// Instantiating an object of this class simulates creating a new census
-/// document. As with illustrations, close() method must be called before
+/// document. As with illustrations, close() function must be called before
/// destroying it.
class wx_test_new_census
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [lmi-commits] [lmi] master 0ab124d: Prefer C++ terminology,
Greg Chicares <=