From dd8712e2e84381419ac43a7ed5c24f4e2a6a4a2c Mon Sep 17 00:00:00 2001
From: Pierre Goiffon <pierre.goiffon@combodo.com>
Date: Wed, 12 Feb 2020 11:43:57 +0100
Subject: [PATCH] :memo: Add more doc for \DBObject::GetAsHTML

---
 core/dbobject.class.php | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/core/dbobject.class.php b/core/dbobject.class.php
index 3531bc8db..f280c42c3 100644
--- a/core/dbobject.class.php
+++ b/core/dbobject.class.php
@@ -1071,21 +1071,20 @@ abstract class DBObject implements iDisplay
 	}
 
     /**
-     * Get $sAttCode formatted as HTML
-     * 
-     * The returned string is already escaped, and as such is protected against XSS
-     * The markup relies on a few assumptions (CSS) that could change without notice
-     * 
      * @api
      * 
      * @param string $sAttCode
      * @param bool   $bLocalize
      *
-     * @return string
+     * @return string $sAttCode formatted as HTML for the console details forms (when viewing, not when editing !)
+     *          The returned string is already escaped, and as such is protected against XSS
+     *          The markup relies on a few assumptions (CSS) that could change without notice
      *
      * @throws ArchivedObjectException
      * @throws CoreException
      * @throws DictExceptionMissingString
+     *
+     * @see \Combodo\iTop\Form\Field\Field for rendering in portal forms
      */
 	public function GetAsHTML($sAttCode, $bLocalize = true)
 	{