From e55d69b6bf86b6ed746b6b0dfb750366afe84522 Mon Sep 17 00:00:00 2001
From: Nicola Fontana <ntd@entidi.it>
Date: Sat, 29 Aug 2009 03:26:54 +0200
Subject: [PATCH] [AdgEntity] 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-entity.c | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/adg/adg-entity.c b/adg/adg-entity.c
index 7acbbf28..11c3d3ee 100644
--- a/adg/adg-entity.c
+++ b/adg/adg-entity.c
@@ -334,9 +334,11 @@ adg_entity_get_parent(AdgEntity *entity)
  * @entity: an #AdgEntity
  * @parent: the parent entity
  *
- * Sets a new parent on @entity.
- *
+ * <note><para>
  * This function is only useful in entity implementations.
+ * </para></note>
+ *
+ * Sets a new parent on @entity.
  **/
 void
 adg_entity_set_parent(AdgEntity *entity, AdgEntity *parent)
@@ -445,7 +447,10 @@ adg_entity_get_canvas(AdgEntity *entity)
  * adg_entity_get_rendered:
  * @entity: an #AdgEntity object
  *
+ * <note><para>
  * This function is only useful in entity implementations.
+ * </para></note>
+ *
  * Gets the rendered flag of @entity.
  *
  * Returns: the current rendered state
@@ -467,7 +472,10 @@ adg_entity_get_rendered(AdgEntity *entity)
  * @entity: an #AdgEntity object
  * @rendered: new state for the rendered flag
  *
+ * <note><para>
  * This function is only useful in entity implementations.
+ * </para></note>
+ *
  * Sets the rendered flag of @entity to @rendered.
  **/
 void
-- 
2.11.4.GIT