Better comments in the comparison engine

	* include/abg-comparison.h (enum diff_category): Add comments to
	describe what to update when a new enumerator is added to this enum.
	* src/abg-comp-filter.cc (has_fn_return_type_cv_qual_change): Fix
	comment thinko here.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>

diff --git a/include/abg-comparison.h b/include/abg-comparison.h
index 5418034..ba4339c 100644 (file)
--- a/include/abg-comparison.h
+++ b/include/abg-comparison.h
@@ -316,6 +316,25 @@ public:
 
 /// An enum for the different categories that a diff tree node falls
 /// into, regarding the kind of changes it represents.
+///
+/// Note that if you add an enumerator to this enum, you need to
+/// update a few spots accordingly:
+///
+///   * update the ACCESS_CHANGE_CATEGORY enumerator (which is the
+///     last enumerator of this enum by OR-ing its initializer with
+///     the new enumerator.
+///
+///   * update the categorize_harmless_diff_node or
+///     categorize_harmful_diff_node function depending on if the new
+///     enumerator classifies diff nodes as harmless or harmful.
+///
+///   * update the get_default_harmless_categories_bitmap or
+///    get_default_harmful_categories_bitmap function as well, just
+///    like above.
+///
+///   * update the "operator<<(ostream& o, diff_category c)" streaming
+///     operator so that it can stream the new enumerator to a textual
+///     output stream.
 enum diff_category
 {
   /// This means the diff node does not carry any (meaningful) change,

diff --git a/src/abg-comp-filter.cc b/src/abg-comp-filter.cc
index a56f789..199b7b9 100644 (file)
--- a/src/abg-comp-filter.cc
+++ b/src/abg-comp-filter.cc
@@ -1160,8 +1160,9 @@ has_fn_parm_type_cv_qual_change(const diff* dif)
 /// Test if a function type or decl diff node carries a CV
 /// qualifier-only change on its return type.
 ///
-/// @param the dif to consider.  Note that if this is neither a
-/// function type nor decl diff node, the function returns false.
+/// @param dif the diff node to consider.  Note that if this is
+/// neither a function type nor decl diff node, the function returns
+/// false.
 ///
 /// @return true iff @p dif is a function decl or type diff node which
 /// carries a CV qualifier-only change on its return type.