Cleanup pass on documentation that was dumping garbage into doxygen output.

(bzr r10696)

1 files changed, 13 insertions, 13 deletions

diff --git a/src/util/enums.h b/src/util/enums.h
index 824da3f75..34138ad21 100644
--- a/src/util/enums.h
+++ b/src/util/enums.h
@@ -1,6 +1,4 @@
-/**
- * \brief Simplified management of enumerations of svg items with UI labels
- *
+/*
  * Authors:
  *   Nicholas Bishop <nicholasbishop@gmail.com>
  *   Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
@@ -9,16 +7,6 @@
  *
  * Released under GNU GPL.  Read the file 'COPYING' for more information.
  */
-
-/* IMPORTANT
- *  When initializing the EnumData struct, you cannot use _(...) to translate strings.
- * Instead, one must use N_(...) and do the translation every time the string is retreived.
- *
- * Note that get_id_from_key and get_id_from_label return 0 if it cannot find an entry for that key string
- * Note that get_label and get_key return an empty string when the requested id is not in the list.
- */
-
-
 #ifndef INKSCAPE_UTIL_ENUMS_H
 #define INKSCAPE_UTIL_ENUMS_H
 
@@ -27,6 +15,12 @@
 namespace Inkscape {
 namespace Util {
 
+/**
+ * Simplified management of enumerations of svg items with UI labels.
+ * IMPORTANT:
+ *  When initializing the EnumData struct, you cannot use _(...) to translate strings.
+ * Instead, one must use N_(...) and do the translation every time the string is retreived.
+ */
 template<typename E>
 struct EnumData
 {
@@ -37,6 +31,12 @@ struct EnumData
 
 const Glib::ustring empty_string("");
 
+/**
+ * Simplified management of enumerations of svg items with UI labels.
+ *
+ * @note that get_id_from_key and get_id_from_label return 0 if it cannot find an entry for that key string.
+ * @note that get_label and get_key return an empty string when the requested id is not in the list.
+ */
 template<typename E> class EnumDataConverter
 {
 public: