Merge branch 'topic/vadim/laldoc' into 'master'

Improvements to generate LAL documentation

See merge request eng/ide/gnatdoc!216

Author: godunko

source/backend/rst/gnatdoc-backend-rst-pt.adb

@@ -201,7 +201,7 @@ package body GNATdoc.Backend.RST.PT is
          use type VSS.Strings.Virtual_String;
 
          Entity_Template  : VSS.Strings.Templates.Virtual_String_Template :=
-           "{}.. ada:generic-package-instantiation:: {}";
+           "{}.. ada:generic-package-instantiation:: package {} is new {}";
          Package_Template : VSS.Strings.Templates.Virtual_String_Template :=
            "{}    :package: {}";
          Instpkg_Template : VSS.Strings.Templates.Virtual_String_Template :=
@@ -213,7 +213,9 @@ package body GNATdoc.Backend.RST.PT is
          File.Put_Line
            (Entity_Template.Format
               (VSS.Strings.Formatters.Strings.Image (Indent),
-               VSS.Strings.Formatters.Strings.Image (Entity.Name)),
+               VSS.Strings.Formatters.Strings.Image (Entity.Name),
+               VSS.Strings.Formatters.Strings.Image
+                 (Entity.RSTPT_Instance_Of)),
             Success);
          File.Put_Line
            (Package_Template.Format
@@ -252,7 +254,7 @@ package body GNATdoc.Backend.RST.PT is
          use type VSS.Strings.Virtual_String;
 
          Object_Template  : VSS.Strings.Templates.Virtual_String_Template :=
-           "{}.. ada:object:: {}";
+           "{}.. ada:object:: {} : constant {}";
          Package_Template : VSS.Strings.Templates.Virtual_String_Template :=
            "{}    :package: {}";
          Objtype_Template : VSS.Strings.Templates.Virtual_String_Template :=
@@ -266,13 +268,15 @@ package body GNATdoc.Backend.RST.PT is
          File.Put_Line
            (Object_Template.Format
               (VSS.Strings.Formatters.Strings.Image (Indent),
-               VSS.Strings.Formatters.Strings.Image (Entity.Name)),
+               VSS.Strings.Formatters.Strings.Image (Entity.Name),
+               VSS.Strings.Formatters.Strings.Image (Entity.RSTPT_Objtype)),
             Success);
          File.Put_Line
            (Package_Template.Format
               (VSS.Strings.Formatters.Strings.Image (Indent),
                VSS.Strings.Formatters.Strings.Image (Package_Name)),
             Success);
+         File.New_Line (Success);
 
          if not Inside_Type and not Entity.RSTPT_Objtype.Is_Empty then
             File.Put_Line

source/frontend/gnatdoc-entities.ads

@@ -147,6 +147,8 @@ package GNATdoc.Entities is
       --  Default value of the object
       RSTPT_Instpkg          : VSS.Strings.Virtual_String;
       --  Name of instantiated package
+      RSTPT_Instance_Of      : VSS.Strings.Virtual_String;
+      --  Name of the generic package
 
       Packages               : Entity_Information_Sets.Set;
       Contain_Subprograms    : aliased Entity_Reference_Sets.Set;

source/frontend/gnatdoc-frontend.adb

@@ -1613,6 +1613,15 @@ package body GNATdoc.Frontend is
          Messages      => Entity.Messages);
       Enclosing.Generic_Instantiations.Insert (Entity);
 
+      Entity.RSTPT_Instance_Of :=
+        VSS.Strings.To_Virtual_String
+          (case Node.Kind is
+              when Ada_Generic_Package_Instantiation =>
+                Node.As_Generic_Package_Instantiation.F_Generic_Pkg_Name.Text,
+              when Ada_Generic_Subp_Instantiation =>
+                Node.As_Generic_Subp_Instantiation.F_Generic_Subp_Name.Text,
+              when others => raise Program_Error);
+
       if Global /= null and GNATdoc.Entities.Globals'Access /= Enclosing then
          Global.Generic_Instantiations.Insert (Entity);
       end if;

testsuite/executable/rstpt/test.out

@@ -11,8 +11,9 @@ LAL
 
 
 
-.. ada:object:: Default_Charset
+.. ada:object:: Default_Charset : constant Standard.String
     :package: LAL
+
     :objtype: Standard.String
     :defval: ``"iso-8859-1"``
 
@@ -35,9 +36,10 @@ LAL
 
     Root of node hierarchy
 
-    .. ada:object:: No_Ada_Node
+    .. ada:object:: No_Ada_Node : constant LAL.Ada_Node
         :package: LAL.Ada_Node
 
+
         Null node.
 
 
@@ -75,7 +77,7 @@ LAL
     Array of nodes
 
 
-.. ada:generic-package-instantiation:: Elementary_Functions
+.. ada:generic-package-instantiation:: package Elementary_Functions is new Ada.Numerics.Generic_Elementary_Functions
     :package: LAL
 
     .. code-block:: ada