[glib: 3/15] glib: Move some documentation comments to where the symbols are defined

[Philip Withnall <pwithnall src gnome org>]

commit 5ad9d3fd6190fd4d27c42051e1cbb4eb62da25f2
Author: Philip Withnall <withnall endlessm com>
Date:   Mon May 27 18:11:35 2019 +0100

    glib: Move some documentation comments to where the symbols are defined
    
    This makes it easier to maintain the documentation and code at the same
    time. The documentation comments haven’t been modified.
    
    Signed-off-by: Philip Withnall <withnall endlessm com>

 glib/docs.c    | 34 ----------------------------------
 glib/gmacros.h | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+), 34 deletions(-)
---
diff --git a/glib/docs.c b/glib/docs.c
index f68a1a8b7..60ca64c3c 100644
--- a/glib/docs.c
+++ b/glib/docs.c
@@ -1819,22 +1819,6 @@
  * Returns: the offset of @member from the start of @struct_type
  */
 
-/**
- * G_CONST_RETURN:
- *
- * If %G_DISABLE_CONST_RETURNS is defined, this macro expands
- * to nothing. By default, the macro expands to const. The macro
- * can be used in place of const for functions that return a value
- * that should not be modified. The purpose of this macro is to allow
- * us to turn on const for returned constant strings by default, while
- * allowing programmers who find that annoying to turn it off. This macro
- * should only be used for return values and for "out" parameters, it
- * doesn't make sense for "in" parameters.
- *
- * Deprecated: 2.30: API providers should replace all existing uses with
- * const and API consumers should adjust their code accordingly
- */
-
 /**
  * G_N_ELEMENTS:
  * @arr: the array
@@ -2139,24 +2123,6 @@
  * of deprecated GLib APIs.
  */
 
-/**
- * G_GNUC_FUNCTION:
- *
- * Expands to "" on all modern compilers, and to  __FUNCTION__ on gcc
- * version 2.x. Don't use it.
- *
- * Deprecated: 2.16: Use G_STRFUNC() instead
- */
-
-/**
- * G_GNUC_PRETTY_FUNCTION:
- *
- * Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__
- * on gcc version 2.x. Don't use it.
- *
- * Deprecated: 2.16: Use G_STRFUNC() instead
- */
-
 /**
  * G_GNUC_INTERNAL:
  *
diff --git a/glib/gmacros.h b/glib/gmacros.h
index db5f0b087..63cefe38e 100644
--- a/glib/gmacros.h
+++ b/glib/gmacros.h
@@ -689,6 +689,24 @@
 #define G_GNUC_WARN_UNUSED_RESULT
 #endif /* __GNUC__ */
 
+/**
+ * G_GNUC_FUNCTION:
+ *
+ * Expands to "" on all modern compilers, and to  __FUNCTION__ on gcc
+ * version 2.x. Don't use it.
+ *
+ * Deprecated: 2.16: Use G_STRFUNC() instead
+ */
+
+/**
+ * G_GNUC_PRETTY_FUNCTION:
+ *
+ * Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__
+ * on gcc version 2.x. Don't use it.
+ *
+ * Deprecated: 2.16: Use G_STRFUNC() instead
+ */
+
 #ifndef G_DISABLE_DEPRECATED
 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
  * macros, so we can refer to them as strings unconditionally.
@@ -867,6 +885,22 @@
 #define G_ALIGNOF(type) (G_STRUCT_OFFSET (struct { char a; type b; }, b))
 #endif
 
+/**
+ * G_CONST_RETURN:
+ *
+ * If %G_DISABLE_CONST_RETURNS is defined, this macro expands
+ * to nothing. By default, the macro expands to const. The macro
+ * can be used in place of const for functions that return a value
+ * that should not be modified. The purpose of this macro is to allow
+ * us to turn on const for returned constant strings by default, while
+ * allowing programmers who find that annoying to turn it off. This macro
+ * should only be used for return values and for "out" parameters, it
+ * doesn't make sense for "in" parameters.
+ *
+ * Deprecated: 2.30: API providers should replace all existing uses with
+ * const and API consumers should adjust their code accordingly
+ */
+
 /* Deprecated -- do not use. */
 #ifndef G_DISABLE_DEPRECATED
 #ifdef G_DISABLE_CONST_RETURNS