[gtksourceviewmm] Documented SourceMarkup.

[Krzesimir Nowak <krnowak src gnome org>]

commit ae87cb0292eebb584e0c0ff503a99b281909f985
Author: Krzesimir Nowak <qdlacz gmail com>
Date:   Sun Jan 17 18:58:27 2010 +0100

    Documented SourceMarkup.
    
    * gtksourceview/gtksourceviewmm/sourcemarkup.cc:
    * gtksourceview/gtksourceviewmm/sourcemarkup.h: Documented.

 gtksourceview/gtksourceviewmm/sourcemarkup.cc |    2 +-
 gtksourceview/gtksourceviewmm/sourcemarkup.h  |   96 +++++++++++++++++++++++--
 2 files changed, 91 insertions(+), 7 deletions(-)
---
diff --git a/gtksourceview/gtksourceviewmm/sourcemarkup.cc b/gtksourceview/gtksourceviewmm/sourcemarkup.cc
index 83f55ca..6f2fa6e 100644
--- a/gtksourceview/gtksourceviewmm/sourcemarkup.cc
+++ b/gtksourceview/gtksourceviewmm/sourcemarkup.cc
@@ -1,6 +1,6 @@
 /* markup.cc
  *
- * Copyright 2009, 2010 Krzesimir Nowak
+ * Copyright (C) 2009, 2010 Krzesimir Nowak
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
diff --git a/gtksourceview/gtksourceviewmm/sourcemarkup.h b/gtksourceview/gtksourceviewmm/sourcemarkup.h
index e40912d..fa260ff 100644
--- a/gtksourceview/gtksourceviewmm/sourcemarkup.h
+++ b/gtksourceview/gtksourceviewmm/sourcemarkup.h
@@ -3,6 +3,8 @@
 
 /* markup.h
  *
+ * Based on Gtk::StockID.
+ *
  * Copyright (C) 2009, 2010 Krzesimir Nowak
  *
  * This library is free software; you can redistribute it and/or
@@ -25,37 +27,119 @@
 
 namespace gtksourceview
 {
-
+/** It is just a class holding markup string.
+ *
+ * This class exists because now nice constructor overload could be used in some
+ * places.
+ *
+ * @newin{2,10}
+ */
 class SourceMarkup
 {
 public:
+  /** Creates empty SourceMarkup.
+   *
+   * @return A new SourceMarkup.
+   *
+   * @newin{2,10}
+   */
   SourceMarkup();
 
-  explicit SourceMarkup(const Glib::ustring& id);
-
-  explicit SourceMarkup(const char* id);
+  /** Creates SourceMarkup containing text from @a markup.
+   *
+   * @param markup A markup string.
+   *
+   * @return A new SourceMarkup.
+   *
+   * @newin{2,10}
+   */
+  explicit SourceMarkup(const Glib::ustring& markup);
+
+  /** Creates SourceMarkup containing text from @a markup.
+   *
+   * @param markup A markup C string.
+   *
+   * @return A new SourceMarkup.
+   *
+   * @newin{2,10}
+   */
+  explicit SourceMarkup(const char* markup);
 
   ~SourceMarkup();
 
+  /** Creates SourceMarkup containing text from @a other SourceMarkup.
+   *
+   * @param other Other SourceMarkup.
+   *
+   * @return A new SourceMarkup.
+   *
+   * @newin{2,10}
+   */
   SourceMarkup(const SourceMarkup& other);
 
+  /** Assigns contents of @a other SourceMarkup to this one.
+   *
+   * @param other Other SourceMarkup.
+   *
+   * @return This SourceMarkup.
+   *
+   * @newin{2,10}
+   */
   SourceMarkup& operator=(const SourceMarkup& other);
 
+  /** Checks if SourceMarkup is not empty.
+   *
+   * @return @c true if SourceMarkup is not empty, otherwise @c false.
+   *
+   * @newin{2,10}
+   */
   operator bool() const;
 
-  bool equal(const SourceMarkup& rhs) const;
-
+  /** Checks if @a other SourceMarkup is the same as this one.
+   *
+   * @param other Other SourceMarkup.
+   *
+   * @return @c true if both this and @a other SourceMarkup are equal.
+   *
+   * @newin{2,10}
+   */
+  bool equal(const SourceMarkup& other) const;
+
+  /** Get the string representation of the SourceMarkup.
+   *
+   * @return A string holding markup.
+   *
+   * @newin{2,10}
+   */
   Glib::ustring get_string() const;
 
+  /** Get the C string representation of the SourceMarkup.
+   *
+   * @return A C string holding markup.
+   *
+   * @newin{2,10}
+   */
   const char* get_c_str()  const;
 
 protected:
   Glib::ustring markup_;
 };
 
+/** See SourceMarkup::equal()
+ *
+ * @relates gtksourceview::SourceMarkup
+ *
+ * @newin{2,10}
+ */
 inline bool operator==(const SourceMarkup& lhs, const SourceMarkup& rhs)
   { return lhs.equal(rhs); }
 
+/** See SourceMarkup::equal()
+ *
+ * @relates gtksourceview::SourceMarkup
+ *
+ * @newin{2,10}
+ */
 inline bool operator!=(const SourceMarkup& lhs, const SourceMarkup& rhs)
   { return !lhs.equal(rhs); }