[glibmm] Fix some Doxygen warnings



commit b4cf126f8ed670020de3d4388730d56c26b1ca54
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Sun Apr 3 16:24:40 2016 +0200

    Fix some Doxygen warnings
    
    * glib/glibmm/property.h: More code within #ifndef DOXYGEN_SHOULD_SKIP_THIS.
    * glib/src/bytearray.hg: Change parameter name index_ to index.
    * tools/pm/DocsParser.pm: When the C parameter name does not coincide with
    the C++ name, change to the C++ name in the documentation also when the C
    name ends with an underscore.

 glib/glibmm/property.h |    2 +-
 glib/src/bytearray.hg  |    6 +++---
 tools/pm/DocsParser.pm |    7 ++++---
 3 files changed, 8 insertions(+), 7 deletions(-)
---
diff --git a/glib/glibmm/property.h b/glib/glibmm/property.h
index 454be13..d7cd91b 100644
--- a/glib/glibmm/property.h
+++ b/glib/glibmm/property.h
@@ -467,7 +467,6 @@ Property_ReadOnly<T>::get_proxy()
 {
   return Glib::PropertyProxy_ReadOnly<T>(object_, get_name_internal());
 }
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 /**** Glib::Property_WriteOnly<T> ****************************************************/
 
@@ -536,6 +535,7 @@ Property_WriteOnly<T>::get_proxy()
 {
   return Glib::PropertyProxy_WriteOnly<T>(object_, get_name_internal());
 }
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 } // namespace Glib
 
diff --git a/glib/src/bytearray.hg b/glib/src/bytearray.hg
index a921a65..3005197 100644
--- a/glib/src/bytearray.hg
+++ b/glib/src/bytearray.hg
@@ -83,9 +83,9 @@ public:
    */
   const guint8* get_data() const;
 
-  _WRAP_METHOD(Glib::RefPtr<ByteArray> remove_index(guint index_), g_byte_array_remove_index, refreturn)
-  _WRAP_METHOD(Glib::RefPtr<ByteArray> remove_index_fast(guint index_), g_byte_array_remove_index_fast, 
refreturn)
-  _WRAP_METHOD(Glib::RefPtr<ByteArray> remove_range(guint index_, guint length), g_byte_array_remove_range, 
refreturn)
+  _WRAP_METHOD(Glib::RefPtr<ByteArray> remove_index(guint index), g_byte_array_remove_index, refreturn)
+  _WRAP_METHOD(Glib::RefPtr<ByteArray> remove_index_fast(guint index), g_byte_array_remove_index_fast, 
refreturn)
+  _WRAP_METHOD(Glib::RefPtr<ByteArray> remove_range(guint index, guint length), g_byte_array_remove_range, 
refreturn)
 
   _WRAP_METHOD(void sort(const SlotCompare& slot), g_byte_array_sort_with_data, slot_name slot, 
slot_callback ByteArray_Compare_Data_Func, no_slot_copy)
   _IGNORE(g_byte_array_sort)
diff --git a/tools/pm/DocsParser.pm b/tools/pm/DocsParser.pm
index 8743171..04fe6c9 100644
--- a/tools/pm/DocsParser.pm
+++ b/tools/pm/DocsParser.pm
@@ -504,6 +504,8 @@ sub append_parameter_docs($$;$)
   {
     my $param = $docs_param_names[$i];
     my $desc = $$param_descriptions->{$param};
+    my $param_without_trailing_underscore = $param;
+    $param_without_trailing_underscore =~ s/([a-zA-Z0-9]*(_[a-zA-Z0-9]+)*)_?/$1/g;
 
     if (defined($objCppfunc))
     {
@@ -538,7 +540,7 @@ sub append_parameter_docs($$;$)
       }
       if ($cpp_name ne $param)
       {
-        $param_name_mappings{$param} = $cpp_name;
+        $param_name_mappings{$param_without_trailing_underscore} = $cpp_name;
       }
     }
     elsif ($param eq "callback")
@@ -548,12 +550,11 @@ sub append_parameter_docs($$;$)
       $param_name_mappings{$param} = "slot";
     }
 
-    $param =~ s/([a-zA-Z0-9]*(_[a-zA-Z0-9]+)*)_?/$1/g;
     DocsParser::convert_docs_to_cpp($obj_function, \$desc);
     if(length($desc) > 0)
     {
       $desc  .= '.' unless($desc =~ /(?:^|\.)$/);
-      $$text .= "\n\ param ${param} \u${desc}";
+      $$text .= "\n\ param ${param_without_trailing_underscore} \u${desc}";
     }
   }
   return %param_name_mappings;


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