From 18ecfe19b13808fc247b9780791b1c1132a8a96b Mon Sep 17 00:00:00 2001
From: Nicola Fontana <ntd@entidi.it>
Date: Sat, 29 Aug 2009 03:27:37 +0200
Subject: [PATCH] [AdgDim] Enhanced docs

Highlighted the "This function is only useful in..." message as a note
and put at the beginning of the docblock to emphasize it.
---
 adg/adg-dim.c | 35 +++++++++++++++++++++++++----------
 1 file changed, 25 insertions(+), 10 deletions(-)

diff --git a/adg/adg-dim.c b/adg/adg-dim.c
index a5850131..4a57f831 100644
--- a/adg/adg-dim.c
+++ b/adg/adg-dim.c
@@ -369,8 +369,11 @@ adg_dim_get_org(AdgDim *dim)
  * @dim: an #AdgDim
  * @org: the org coordinates
  *
- * Sets new org coordinates. This function is only useful
- * in new dimension implementations.
+ * <note><para>
+ * This function is only useful in new dimension implementations.
+ * </para></note>
+ *
+ * Sets new org coordinates.
  **/
 void
 adg_dim_set_org(AdgDim *dim, const AdgPair *org)
@@ -390,8 +393,11 @@ adg_dim_set_org(AdgDim *dim, const AdgPair *org)
  * @org_x: x component of org
  * @org_y: y component of org
  *
- * Explicitely sets new org coordinates. This function is only useful
- * in new dimension implementations.
+ * <note><para>
+ * This function is only useful in new dimension implementations.
+ * </para></note>
+ *
+ * Explicitely sets new org coordinates.
  **/
 void
 adg_dim_set_org_explicit(AdgDim *dim, gdouble org_x, gdouble org_y)
@@ -616,8 +622,11 @@ adg_dim_set_pos_explicit(AdgDim *dim, gdouble pos1_x, gdouble pos1_y,
  * adg_dim_get_angle:
  * @dim: an #AdgDim
  *
- * Gets the dimension angle. This function is only useful
- * in new dimension implementations.
+ * <note><para>
+ * This function is only useful in new dimension implementations.
+ * </para></note>
+ *
+ * Gets the dimension angle.
  *
  * Returns: the angle (in radians)
  **/
@@ -638,8 +647,11 @@ adg_dim_get_angle(AdgDim *dim)
  * @dim: an #AdgDim
  * @angle: the new angle (in radians)
  *
- * Sets a new dimension angle. This function is only useful
- * in new dimension implementations.
+ * <note><para>
+ * This function is only useful in new dimension implementations.
+ * </para></note>
+ *
+ * Sets a new dimension angle.
  **/
 void
 adg_dim_set_angle(AdgDim *dim, gdouble angle)
@@ -914,8 +926,11 @@ adg_dim_set_note(AdgDim *dim, const gchar *note)
  * @dim: an #AdgDim object
  * @cr: a #cairo_t drawing context
  *
- * Renders the quote of @dim at the @org position. This function
- * is only useful in new dimension implementations.
+ * <note><para>
+ * This function is only useful in new dimension implementations.
+ * </para></note>
+ *
+ * Renders the quote of @dim at the @org position.
  **/
 void
 adg_dim_render_quote(AdgDim *dim, cairo_t *cr)
-- 
2.11.4.GIT