[gtk+] docs: Add gtk-doc notation



commit 8999053b5f931a8cee054fbc3abaf1edbd5b19a1
Author: Javier Jardón <jjardon gnome org>
Date:   Fri Oct 22 17:56:00 2010 +0200

    docs: Add gtk-doc notation
    
    to emphasize that GtkMisc and GtkAdjustment are not encouraged in new code

 docs/reference/gtk/tmpl/gtkmisc.sgml |    2 ++
 gtk/gtkalignment.c                   |    4 ++++
 2 files changed, 6 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/gtkmisc.sgml b/docs/reference/gtk/tmpl/gtkmisc.sgml
index 57ab5c7..c9016e2 100644
--- a/docs/reference/gtk/tmpl/gtkmisc.sgml
+++ b/docs/reference/gtk/tmpl/gtkmisc.sgml
@@ -19,11 +19,13 @@ positioned within its allocated area. Note that if the widget is added to
 a container in such a way that it expands automatically to fill its
 allocated area, the alignment settings will not alter the widgets position.
 </para>
+<note>
 <para>
 Note that the desired effect can in most cases be achieved by using the
 #GtkWidget:halign, #GtkWidget:valign and #GtkWidget:margin properties
 on the child widget, so GtkMisc should not be used in new code.
 </para>
+</note>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
diff --git a/gtk/gtkalignment.c b/gtk/gtkalignment.c
index b3e0b85..d8b3fec 100644
--- a/gtk/gtkalignment.c
+++ b/gtk/gtkalignment.c
@@ -42,9 +42,13 @@
  * Of course, if the scale settings are both set to 1, the alignment settings
  * have no effect.
  *
+ * <note>
+ * <para>
  * Note that the desired effect can in most cases be achieved by using the
  * #GtkWidget:halign, #GtkWidget:valign and #GtkWidget:margin properties
  * on the child widget, so #GtkAlignment should not be used in new code.
+ * </para>
+ * </note>
  */
 
 #include "config.h"



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