1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170 | ------------------------------------------------------------------------------
-- GNAT Documentation Generation Tool --
-- --
-- Copyright (C) 2022, AdaCore --
-- --
-- This is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. This software is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- --
-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public --
-- License for more details. You should have received a copy of the GNU --
-- General Public License distributed with this software; see file --
-- COPYING3. If not, go to http://www.gnu.org/licenses for a complete copy --
-- of the license. --
------------------------------------------------------------------------------
with Libadalang.Analysis;
with Libadalang.Common;
with GNATdoc.Comments.Options;
package GNATdoc.Comments.Extractor is
use all type Libadalang.Common.Ada_Node_Kind_Type;
use Libadalang.Common;
function Extract
(Node : Libadalang.Analysis.Basic_Decl'Class;
Options : GNATdoc.Comments.Options.Extractor_Options)
return not null Structured_Comment_Access
with Pre =>
Node.Kind in Ada_Abstract_Subp_Decl
| Ada_Entry_Body
| Ada_Entry_Decl
| Ada_Exception_Decl
| Ada_Expr_Function
| Ada_Generic_Package_Decl
| Ada_Generic_Package_Instantiation
| Ada_Generic_Subp_Decl
| Ada_Generic_Subp_Instantiation
| Ada_Null_Subp_Decl
| Ada_Number_Decl
| Ada_Object_Decl
| Ada_Package_Decl
| Ada_Package_Renaming_Decl
| Ada_Protected_Body
| Ada_Protected_Type_Decl
| Ada_Single_Protected_Decl
| Ada_Single_Task_Decl
| Ada_Subp_Body
| Ada_Subp_Decl
| Ada_Subp_Renaming_Decl
| Ada_Subtype_Decl
| Ada_Task_Type_Decl
or (Node.Kind in Ada_Type_Decl
and then Node.As_Type_Decl.F_Type_Def.Kind
in Ada_Access_To_Subp_Def
| Ada_Array_Type_Def
| Ada_Decimal_Fixed_Point_Def
| Ada_Derived_Type_Def
| Ada_Enum_Type_Def
| Ada_Floating_Point_Def
| Ada_Interface_Type_Def
| Ada_Mod_Int_Type_Def
| Ada_Ordinary_Fixed_Point_Def
| Ada_Private_Type_Def
| Ada_Record_Type_Def
| Ada_Signed_Int_Type_Def
| Ada_Type_Access_Def);
-- Extract documentation for supported kinds of nodes.
procedure Extract
(Node : Libadalang.Analysis.Basic_Decl'Class;
Options : GNATdoc.Comments.Options.Extractor_Options;
Documentation : out Structured_Comment'Class)
with Pre =>
Node.Kind in Ada_Abstract_Subp_Decl
| Ada_Entry_Body
| Ada_Entry_Decl
| Ada_Exception_Decl
| Ada_Expr_Function
| Ada_Generic_Package_Decl
| Ada_Generic_Package_Instantiation
| Ada_Generic_Subp_Decl
| Ada_Generic_Subp_Instantiation
| Ada_Null_Subp_Decl
| Ada_Number_Decl
| Ada_Object_Decl
| Ada_Package_Decl
| Ada_Package_Renaming_Decl
| Ada_Protected_Body
| Ada_Protected_Type_Decl
| Ada_Single_Protected_Decl
| Ada_Single_Task_Decl
| Ada_Subp_Body
| Ada_Subp_Decl
| Ada_Subp_Renaming_Decl
| Ada_Subtype_Decl
| Ada_Task_Type_Decl
or (Node.Kind in Ada_Type_Decl
and then Node.As_Type_Decl.F_Type_Def.Kind
in Ada_Access_To_Subp_Def
| Ada_Array_Type_Def
| Ada_Decimal_Fixed_Point_Def
| Ada_Derived_Type_Def
| Ada_Enum_Type_Def
| Ada_Floating_Point_Def
| Ada_Interface_Type_Def
| Ada_Mod_Int_Type_Def
| Ada_Ordinary_Fixed_Point_Def
| Ada_Private_Type_Def
| Ada_Record_Type_Def
| Ada_Signed_Int_Type_Def
| Ada_Type_Access_Def);
-- Extract documentation for supported kinds of nodes.
function Extract
(Node : Libadalang.Analysis.Basic_Decl'Class;
Options : GNATdoc.Comments.Options.Extractor_Options)
return Structured_Comment
with Pre =>
Node.Kind in Ada_Abstract_Subp_Decl
| Ada_Entry_Body
| Ada_Entry_Decl
| Ada_Exception_Decl
| Ada_Expr_Function
| Ada_Generic_Package_Decl
| Ada_Generic_Package_Instantiation
| Ada_Generic_Subp_Decl
| Ada_Generic_Subp_Instantiation
| Ada_Null_Subp_Decl
| Ada_Number_Decl
| Ada_Object_Decl
| Ada_Package_Decl
| Ada_Package_Renaming_Decl
| Ada_Protected_Body
| Ada_Protected_Type_Decl
| Ada_Single_Protected_Decl
| Ada_Single_Task_Decl
| Ada_Subp_Body
| Ada_Subp_Decl
| Ada_Subp_Renaming_Decl
| Ada_Subtype_Decl
| Ada_Task_Type_Decl
or (Node.Kind in Ada_Type_Decl
and then Node.As_Type_Decl.F_Type_Def.Kind
in Ada_Access_To_Subp_Def
| Ada_Array_Type_Def
| Ada_Decimal_Fixed_Point_Def
| Ada_Derived_Type_Def
| Ada_Enum_Type_Def
| Ada_Floating_Point_Def
| Ada_Interface_Type_Def
| Ada_Mod_Int_Type_Def
| Ada_Ordinary_Fixed_Point_Def
| Ada_Private_Type_Def
| Ada_Record_Type_Def
| Ada_Signed_Int_Type_Def
| Ada_Type_Access_Def);
-- Extract documentation for supported kinds of nodes.
function Extract_Formal_Section
(Documentation : Structured_Comment;
Name : Libadalang.Analysis.Defining_Name'Class)
return Structured_Comment;
-- Create new structured comment from the section for the formal parameter
-- of the generic with the given name.
end GNATdoc.Comments.Extractor;
|