more doc fixes

Fri, 07 Jul 2023 18:41:03 +0200

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Fri, 07 Jul 2023 18:41:03 +0200
changeset 741
1210ee2d755f
parent 740
378578666c83 (diff)
parent 738
54b1d577551b (current diff)
child 742
bcf788f3f6f5

more doc fixes

src/cx/list.h file | annotate | diff | comparison | revisions
--- a/src/cx/iterator.h	Fri Jul 07 18:22:13 2023 +0200
+++ b/src/cx/iterator.h	Fri Jul 07 18:41:03 2023 +0200
@@ -204,13 +204,13 @@
 
 /**
  * Iterator value type.
- * An iterator points to a certain element in an (possibly unbounded) chain of elements.
+ * An iterator points to a certain element in a (possibly unbounded) chain of elements.
  * Iterators that are based on collections (which have a defined "first" element), are supposed
  * to be "position-aware", which means that they keep track of the current index within the collection.
  *
  * @note Objects that are pointed to by an iterator are always mutable through that iterator. However,
  * this iterator cannot mutate the collection itself (add or remove elements) and any mutation of the
- * collection by other means make this iterator invalid (regardless of what cxIteratorValid() returns).
+ * collection by other means makes this iterator invalid (regardless of what cxIteratorValid() returns).
  *
  * @see CxMutIterator
  */
--- a/src/cx/list.h	Fri Jul 07 18:22:13 2023 +0200
+++ b/src/cx/list.h	Fri Jul 07 18:41:03 2023 +0200
@@ -77,7 +77,7 @@
     void (*destructor)(struct cx_list_s *list);
 
     /**
-     * Member function for inserting a single elements.
+     * Member function for inserting a single element.
      * Implementors SHOULD see to performant implementations for corner cases.
      */
     int (*insert_element)(
@@ -145,7 +145,7 @@
     );
 
     /**
-     * Member function for sorting the list in place.
+     * Member function for sorting the list in-place.
      */
     void (*sort)(struct cx_list_s *list);
 
@@ -584,7 +584,7 @@
 }
 
 /**
- * Sorts the list in place.
+ * Sorts the list in-place.
  *
  * \remark The underlying sort algorithm is implementation defined.
  *

mercurial