[gnome-commander] noop: Code comments



commit 066ec71c823bf325b7b958190d36ccbf1926d03f
Author: Uwe Scholz <uwescholz src gnome org>
Date:   Sat Nov 5 23:38:54 2016 +0100

    noop: Code comments

 src/tags/gnome-cmd-tags.h |   23 +++++++++++++++--------
 1 files changed, 15 insertions(+), 8 deletions(-)
---
diff --git a/src/tags/gnome-cmd-tags.h b/src/tags/gnome-cmd-tags.h
index ec100a4..aff5310 100644
--- a/src/tags/gnome-cmd-tags.h
+++ b/src/tags/gnome-cmd-tags.h
@@ -490,17 +490,23 @@ const gchar *gcmd_tags_get_name(const GnomeCmdTag tag);
 const GnomeCmdTagClass gcmd_tags_get_class(const GnomeCmdTag tag);
 const gchar *gcmd_tags_get_class_name(const GnomeCmdTag tag);
 const gchar *gcmd_tags_get_value(GnomeCmdFile *f, const GnomeCmdTag tag);
+const std::string gcmd_tags_get_value_string(GnomeCmdFile *f, const GnomeCmdTag tag);
 const gchar *gcmd_tags_get_title(const GnomeCmdTag tag);
 const gchar *gcmd_tags_get_description(const GnomeCmdTag tag);
 
-// gcmd_tags_get_tag_by_name() returns tag for given tag_name (eg. AlbumArtist) in the specified tag_class 
(here TAG_AUDIO)
-// if tag_class is omitted, tag_name must contain fully qualified tag name (eg. Audio.AlbumArtist)
-
+/**
+ * gcmd_tags_get_tag_by_name() returns tag for given tag_name (eg. AlbumArtist)
+ * in the specified tag_class (here TAG_AUDIO). If tag_class is omitted, tag_name
+ * must contain fully qualified tag name (eg. Audio.AlbumArtist).
+ */
 GnomeCmdTag gcmd_tags_get_tag_by_name(const gchar *tag_name, const GnomeCmdTagClass 
tag_class=TAG_NONE_CLASS);
 
-// gcmd_tags_get_value_by_name() returns metatag value for given tag_name (eg. AlbumArtist) in the specified 
tag_class (here TAG_AUDIO)
-// if tag_class is omitted, tag_name must contain fully qualified tag name (eg. Audio.AlbumArtist)
-
+/**
+ * gcmd_tags_get_value_by_name() returns metatag value for given
+ * tag_name (eg. AlbumArtist) in the specified tag_class (here TAG_AUDIO)
+ * if tag_class is omitted, tag_name must contain fully qualified tag
+ * name (eg. Audio.AlbumArtist).
+ */
 inline const gchar *gcmd_tags_get_value_by_name(GnomeCmdFile *f, const gchar *tag_name, const 
GnomeCmdTagClass tag_class=TAG_NONE_CLASS)
 {
     g_return_val_if_fail (f != NULL, "");
@@ -526,7 +532,7 @@ class GnomeCmdFileMetadata
 
   public:
 
-    GnomeCmdFileMetadata() {}                                                   // to make g++ 3.4 happy
+    GnomeCmdFileMetadata() {}
 
     gboolean is_accessed (const GnomeCmdTagClass tag_class) const;
     gboolean is_accessed (const GnomeCmdTag tag) const;
@@ -561,7 +567,8 @@ inline void GnomeCmdFileMetadata::add (const GnomeCmdTag tag, std::string value)
     if (value.empty())
         return;
 
-    std::string::size_type end = value.find_last_not_of(" \t\n\r\0",std::string::npos,5);         // remove 
trailing whitespace from a string
+    // remove trailing whitespace from a string
+    std::string::size_type end = value.find_last_not_of(" \t\n\r\0",std::string::npos,5);
 
     if (end==std::string::npos)
         return;


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