[libxml++] Docs: Correct odd use of "herited" word.



commit 3784f3600250a6fd3b2765fa714c96443c98a834
Author: Murray Cumming <murrayc murrayc com>
Date:   Sun Jul 19 20:58:44 2015 +0200

    Docs: Correct odd use of "herited" word.

 libxml++/io/outputbuffer.h      |   12 ++++++------
 libxml++/io/parserinputbuffer.h |   10 +++++-----
 libxml++/noncopyable.h          |    2 +-
 3 files changed, 12 insertions(+), 12 deletions(-)
---
diff --git a/libxml++/io/outputbuffer.h b/libxml++/io/outputbuffer.h
index b9aa6fc..0c0b9bb 100644
--- a/libxml++/io/outputbuffer.h
+++ b/libxml++/io/outputbuffer.h
@@ -26,15 +26,15 @@ namespace xmlpp
 
   /** Base class for xmlOutputBuffer wrapper
    *
-   * It can be herited to create a new output buffer.
-   * A child class has to override do_write, and eventually
-   * do_close if some actions are required before buffer closing.
+   * It can be derived from to create a new output buffer.
+   * A child class has to override do_write(), and possibly
+   * do_close() if some actions are required before buffer closing.
    */
   class OutputBuffer: public NonCopyable
   {
     public:
       /**
-       * @param encoding The encoding herited class wait for in do_write. If
+       * @param encoding The encoding that the derived class waits for in do_write. If
        * not provided, UTF-8 will be sent to do_write.
        *
        * @warning The encoding is done by libxml. As a consequence, libxml must
@@ -60,12 +60,12 @@ namespace xmlpp
        * @param buffer The datas encoded in the charset given to the constructor
        * @param len Buffer length
        *
-       * This function MUST be overriden in herited classes.
+       * This function MUST be overriden in derived classes.
        */
       virtual bool do_write(const char * buffer, int len) = 0;
 
       /** Function called before closing the buffer.
-       * Herited classes should override it if some actions are required before
+       * Derived classes should override it if some actions are required before
        * closing the buffer, instead of doing them in the destructor.
        */
       virtual bool do_close();
diff --git a/libxml++/io/parserinputbuffer.h b/libxml++/io/parserinputbuffer.h
index a2cc34d..c5d65ad 100644
--- a/libxml++/io/parserinputbuffer.h
+++ b/libxml++/io/parserinputbuffer.h
@@ -24,9 +24,9 @@ namespace xmlpp
 
   /** Base class for xmlParserInputBuffer wrapper
    *
-   * It can be herited to create a new output buffer.
-   * A child class has to override do_write, and eventually
-   * do_close if some actions are required before buffer closing.
+   * It can be derived from to create a new output buffer.
+   * A child class has to override do_write(), and possibly
+   * do_close() if some actions are required before buffer closing.
    */
   class ParserInputBuffer: public NonCopyable
   {
@@ -52,12 +52,12 @@ namespace xmlpp
        * @param len bytes to read
        * @return Number of bytes read
        *
-       * This function MUST be overriden in herited classes.
+       * This function MUST be overriden in derived classes.
        */
       virtual int do_read(char * buffer, int len) = 0;
 
       /** Function called before closing the buffer.
-       * Herited classes should override it if some actions are required before
+       * Derived classes should override it if some actions are required before
        * closing the buffer, instead of doing them in the destructor.
        */
       virtual bool do_close();
diff --git a/libxml++/noncopyable.h b/libxml++/noncopyable.h
index 34df6c2..468a6f0 100644
--- a/libxml++/noncopyable.h
+++ b/libxml++/noncopyable.h
@@ -12,7 +12,7 @@ namespace xmlpp
 {
 
 /**
- * Herited by classes which cannot be copied.
+ * A base for classes which cannot be copied.
  */
 class NonCopyable
 {


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]