From: Dodji Seketeli <dodji@redhat.com>
Date: Sun, 2 Oct 2022 17:04:50 +0000 (+0200)
Subject: ir: Fix documentation of canonical type propagation
X-Git-Tag: libabigail-2.2~29
X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=ff55722fad6ea62ed532f39885c2d67b6ff87298;p=libabigail.git

ir: Fix documentation of canonical type propagation

	* src/abg-ir.cc (on-the-fly-canonicalization): Enclose the comment
	into <pre> html tag to make the ascii-art graph look good.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
---

diff --git a/src/abg-ir.cc b/src/abg-ir.cc
index 2563b5b3..381437c7 100644
--- a/src/abg-ir.cc
+++ b/src/abg-ir.cc
@@ -22505,15 +22505,17 @@ copy_member_function(const class_or_union_sptr& t, const method_decl* method)
 /// we say that T is a recursive type, because it has T (itself) as
 /// one of its sub-types:
 ///
-///   T
-///   +-- ST0
-///   |
-///   +-- ST1
-///   |    +
-///   |    |
-///   |    +-- T
-///   |
-///   +-- ST2
+/// <PRE>
+///    T
+///    +-- ST0
+///    |
+///    +-- ST1
+///    |    +
+///    |    |
+///    |    +-- T
+///    |
+///    +-- ST2
+/// </PRE>
 ///
 /// ST1 is said to "depend" on T because it has T as a sub-type.  But
 /// because T is recursive, then ST1 is said to depend on a recursive