Fix various apidoc typos

	* include/abg-comparison.h (class function_suppression): Fix typo
	in the doc string.
	* src/abg-comparison.cc (is_type_diff, read_suppressions)
	(diff::reported_once, typedef_diff::report): Fix the doc string.

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

diff --git a/include/abg-comparison.h b/include/abg-comparison.h
index 06b86e3d3104e40c8ebd0217ab3c8ae22be8c11f..a22913263b2e28be03964416fe5377a22824f88b 100644 (file)
--- a/include/abg-comparison.h
+++ b/include/abg-comparison.h
@@ -470,8 +470,8 @@ typedef vector<function_suppression_sptr> function_suppressions_type;
 /// Abstraction of a function suppression specification.
 ///
 /// Specifies under which condition reports about a @ref
-/// function_decl_diff diff node should be dropped on the floor the
-/// purpose of reporting.
+/// function_decl_diff diff node should be dropped on the floor for
+/// the purpose of reporting.
 class function_suppression : public suppression_base
 {
   class priv;

diff --git a/src/abg-comparison.cc b/src/abg-comparison.cc
index cfdf0c2bb616bee86720f1f9ca426c1960dfd835..0d76d3ba485988ab10d8b4b5a402e1a218c4b49a 100644 (file)
--- a/src/abg-comparison.cc
+++ b/src/abg-comparison.cc
@@ -169,7 +169,8 @@ operator~(visiting_kind l)
 ///
 /// @param diff the diff node to test.
 ///
-/// @return true if the @p diff is about differences between types.
+/// @return a pointer to the actual type_diff_base* that @p diff extends, iff it is
+/// about differences between types.
 static const type_diff_base*
 is_type_diff(const diff* diff)
 {return dynamic_cast<const type_diff_base*>(diff);}
@@ -233,8 +234,8 @@ read_function_suppression(const ini::config::section& section);
 /// Read a vector of suppression specifications from the sections of
 /// an ini::config.
 ///
-/// Note that each time a new kind of suppression specification is
-/// added, this function needs to be updated.
+/// Note that this function needs to be updated each time a new kind
+/// of suppression specification is added.
 ///
 /// @param config the config to read from.
 ///
@@ -2343,7 +2344,7 @@ diff::traverse(diff_node_visitor& v)
 /// Sets a flag saying if a report has already been emitted for the
 /// current diff.
 ///
-/// @param f true if a repot has already been emitted for the
+/// @param f true if a report has already been emitted for the
 /// current diff, false otherwise.
 void
 diff::reported_once(bool f) const
@@ -8333,7 +8334,7 @@ typedef_diff::has_local_changes() const
 /// Reports the difference between the two subjects of the diff in a
 /// serialized form.
 ///
-/// @param out the output stream to emit the repot to.
+/// @param out the output stream to emit the report to.
 ///
 /// @param indent the indentation string to use.
 void