Skip to content

support implicit templates #886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 28 additions & 5 deletions src/lib/AST/ASTVisitor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -562,8 +562,7 @@ populate(
std::optional<Javadoc>& javadoc,
Decl const* D)
{
RawComment const* RC =
D->getASTContext().getRawCommentForDeclNoCache(D);
RawComment const* RC = getDocumentation(D);
MRDOCS_CHECK_OR(RC, false);
comments::FullComment* FC =
RC->parse(D->getASTContext(), &sema_.getPreprocessor(), D);
Expand Down Expand Up @@ -1232,6 +1231,15 @@ ASTVisitor::
populate(TemplateInfo& Template, DeclTy const*, TemplateDeclTy const* TD)
{
MRDOCS_ASSERT(TD);
MRDOCS_CHECK_OR(!TD->isImplicit());
if (TemplateParameterList const* TPL = TD->getTemplateParameters();
!TPL->empty() &&
std::ranges::none_of(TPL->asArray(), [](NamedDecl const* ND) {
return !ND->isImplicit();
}))
{
return;
}
TemplateParameterList const* TPL = TD->getTemplateParameters();
populate(Template, TPL);
}
Expand Down Expand Up @@ -1519,14 +1527,29 @@ populate(
{
return;
}
if (TPL->size() > TI.Params.size())
auto TemplateParameters = TPL->asArray();
auto ExplicitTemplateParameters =
std::views::filter(
TemplateParameters,
[](NamedDecl const* P)
{
return !P->isImplicit();
});
std::size_t const nExplicit = std::ranges::distance(
ExplicitTemplateParameters);
MRDOCS_CHECK_OR(nExplicit);
if (nExplicit > TI.Params.size())
{
TI.Params.resize(TPL->size());
TI.Params.resize(nExplicit);
}
for (std::size_t i = 0; i < TPL->size(); ++i)
auto explicitIt = ExplicitTemplateParameters.begin();
std::size_t i = 0;
while (explicitIt != ExplicitTemplateParameters.end())
{
NamedDecl const* P = TPL->getParam(i);
populate(TI.Params[i], P);
++explicitIt;
++i;
}
if (auto* RC = TPL->getRequiresClause())
{
Expand Down
10 changes: 10 additions & 0 deletions src/lib/AST/ASTVisitor.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,16 @@ class ASTVisitor
void
populate(std::optional<TemplateInfo>& Template, DeclTy const* D, TemplateDeclTy const* VTD)
{
MRDOCS_CHECK_OR(VTD);
MRDOCS_CHECK_OR(!VTD->isImplicit());
if (TemplateParameterList const* TPL = VTD->getTemplateParameters();
!TPL->empty() &&
std::ranges::none_of(TPL->asArray(), [](NamedDecl const* ND) {
return !ND->isImplicit();
}))
{
return;
}
if (!Template)
{
Template.emplace();
Expand Down
19 changes: 17 additions & 2 deletions src/lib/AST/ClangHelpers.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -400,11 +400,26 @@ isStaticFileLevelMember(Decl const* D)
return false;
}

RawComment const*
getDocumentation(Decl const* D)
{
RawComment const* RC =
D->getASTContext().getRawCommentForDeclNoCache(D);
if (!RC)
{
auto const* TD = dyn_cast<TemplateDecl>(D);
MRDOCS_CHECK_OR(TD, nullptr);
NamedDecl const* ND = TD->getTemplatedDecl();
MRDOCS_CHECK_OR(ND, nullptr);
RC = ND->getASTContext().getRawCommentForDeclNoCache(ND);
}
return RC;
}

bool
isDocumented(Decl const* D)
{
return D->getASTContext().getRawCommentForDeclNoCache(D);
return getDocumentation(D) != nullptr;
}


} // clang::mrdocs
4 changes: 4 additions & 0 deletions src/lib/AST/ClangHelpers.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -926,6 +926,10 @@ MRDOCS_DECL
bool
isDocumented(Decl const *D);

MRDOCS_DECL
RawComment const*
getDocumentation(Decl const *D);

template <class DeclTy>
bool
isDefinition(DeclTy* D)
Expand Down
1 change: 0 additions & 1 deletion src/lib/Metadata/Finalizers/OverloadsFinalizer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ findBaseClassPermutation(
MRDOCS_CHECK_OR(info, SymbolID::invalid);
if (auto* record = dynamic_cast<RecordInfo*>(info))
{
bool overloadsFromBase = false;
for (auto const& base: record->Bases)
{
auto const baseInfo = corpus.find(base.Type->namedSymbol());
Expand Down
64 changes: 40 additions & 24 deletions test-files/golden-tests/javadoc/copydoc/param-types.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -723,6 +723,17 @@ void

[.small]#<<g-09c,_» more&period;&period;&period;_>>#

Auto function


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
<<g-0b,g>>(auto a);
----

[.small]#<<g-0b,_» more&period;&period;&period;_>>#

Enum param function


Expand Down Expand Up @@ -756,16 +767,6 @@ void

[.small]#<<g-04a,_» more&period;&period;&period;_>>#


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class a&colon;auto&gt;
void
<<g-0b,g>>(auto a);
----

[.small]#<<g-0b,_» more&period;&period;&period;_>>#

Decltype function


Expand Down Expand Up @@ -849,6 +850,35 @@ Documentation for a function with a qualified identifier parameter&period;
| The first parameter of g
|===

[#g-0b]
== g

Auto function

=== Synopsis

Declared in `&lt;param&hyphen;types&period;cpp&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
g(auto a);
----

=== Description

Documentation for a function with an `auto` parameter&period;

=== Parameters

[cols=2]
|===
| Name
| Description
| *a*
| The first parameter of g
|===

[#g-04c]
== g

Expand Down Expand Up @@ -936,20 +966,6 @@ Documentation for the non&hyphen;variadic function&period;
| The first parameter of g
|===

[#g-0b]
== g

=== Synopsis

Declared in `&lt;param&hyphen;types&period;cpp&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class a&colon;auto&gt;
void
g(auto a);
----

[#g-0c]
== g

Expand Down
71 changes: 47 additions & 24 deletions test-files/golden-tests/javadoc/copydoc/param-types.html
Original file line number Diff line number Diff line change
Expand Up @@ -916,6 +916,14 @@ <h3>Synopses</h3>
</code>
</pre><span class="small"><a href="#g-09c"><em>» more...</em></a></span>

<span>Auto function</span>
<pre>
<code class="source-code cpp">
void
<a href="#g-0b">g</a>(auto a);
</code>
</pre><span class="small"><a href="#g-0b"><em>» more...</em></a></span>

<span>Enum param function</span>
<pre>
<code class="source-code cpp">
Expand All @@ -940,15 +948,6 @@ <h3>Synopses</h3>
</code>
</pre><span class="small"><a href="#g-04a"><em>» more...</em></a></span>


<pre>
<code class="source-code cpp">
template&lt;class a:auto&gt;
void
<a href="#g-0b">g</a>(auto a);
</code>
</pre><span class="small"><a href="#g-0b"><em>» more...</em></a></span>

<span>Decltype function</span>
<pre>
<code class="source-code cpp">
Expand Down Expand Up @@ -1067,9 +1066,9 @@ <h3>Parameters</h3>
</div>
<div>
<div>
<h2 id="g-04c">g</h2>
<h2 id="g-0b">g</h2>
<div>
<span>Enum param function</span>
<span>Auto function</span>

</div>
</div>
Expand All @@ -1080,13 +1079,13 @@ <h3>Synopsis</h3>
<pre>
<code class="source-code cpp">
void
g(<a href="#testEnum">testEnum</a> a);
g(auto a);
</code>
</pre>
</div>
<div>
<h3>Description</h3>
<p>Documentation for a function with an enum parameter.</p>
<p>Documentation for a function with an <code>auto</code> parameter.</p>
</div>
<div>
<h3>Parameters</h3>
Expand All @@ -1108,9 +1107,9 @@ <h3>Parameters</h3>
</div>
<div>
<div>
<h2 id="g-096">g</h2>
<h2 id="g-04c">g</h2>
<div>
<span>Variadic function</span>
<span>Enum param function</span>

</div>
</div>
Expand All @@ -1121,13 +1120,13 @@ <h3>Synopsis</h3>
<pre>
<code class="source-code cpp">
void
g(int a, ...);
g(<a href="#testEnum">testEnum</a> a);
</code>
</pre>
</div>
<div>
<h3>Description</h3>
<p>Documentation for the variadic function.</p>
<p>Documentation for a function with an enum parameter.</p>
</div>
<div>
<h3>Parameters</h3>
Expand All @@ -1149,9 +1148,9 @@ <h3>Parameters</h3>
</div>
<div>
<div>
<h2 id="g-04a">g</h2>
<h2 id="g-096">g</h2>
<div>
<span>Non-variadic function</span>
<span>Variadic function</span>

</div>
</div>
Expand All @@ -1162,13 +1161,13 @@ <h3>Synopsis</h3>
<pre>
<code class="source-code cpp">
void
g(int a);
g(int a, ...);
</code>
</pre>
</div>
<div>
<h3>Description</h3>
<p>Documentation for the non-variadic function.</p>
<p>Documentation for the variadic function.</p>
</div>
<div>
<h3>Parameters</h3>
Expand All @@ -1190,20 +1189,44 @@ <h3>Parameters</h3>
</div>
<div>
<div>
<h2 id="g-0b">g</h2>
<h2 id="g-04a">g</h2>
<div>
<span>Non-variadic function</span>

</div>
</div>
<div>
<h3>Synopsis</h3>
<div>
Declared in <code>&lt;param-types.cpp&gt;</code></div>
<pre>
<code class="source-code cpp">
template&lt;class a:auto&gt;
void
g(auto a);
g(int a);
</code>
</pre>
</div>
<div>
<h3>Description</h3>
<p>Documentation for the non-variadic function.</p>
</div>
<div>
<h3>Parameters</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>a</strong></td>
<td><span>The first parameter of g</span></td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div>
Expand Down
Loading
Loading