Skip to content

Commit 2ce0b4f

Browse files
committed
touched up function def to be cleaner
1 parent a8414b3 commit 2ce0b4f

File tree

5 files changed

+43
-33
lines changed

5 files changed

+43
-33
lines changed

src/components/doxygen-function-def/BUILD.bazel

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ ng_ts_project(
2626
"//src/components/doxygen-member-components/doxygen-return",
2727
"//src/components/doxygen-paragraph",
2828
"//src/components/doxygen-refid-link",
29+
"//src/components/doxygen-type-name",
2930
"//src/search:doxygen-def-types",
3031
"@npm//@angular/common",
3132
"@npm//@angular/core",

src/components/doxygen-function-def/doxygen-function-def.component.html

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,40 @@
22
<doxygen-description
33
[description]="def.detailedDescription"></doxygen-description>
44
</div>
5-
<div *ngIf="def.parameters.length > 0">
6-
<h3>Parameters</h3>
7-
<table class="table-auto border-collapse w-4/6">
8-
<tr>
9-
<th class="px-2">Return</th>
10-
<th class="px-2">Name</th>
11-
</tr>
12-
<tr *ngFor="let parameter of def.parameters">
13-
<td class="py-2">
14-
<div *ngIf="parameter.typeRefid; else noID" class="py-4 px-2">
15-
<a [doxygenRefidLink]="parameter.typeRefid">{{ parameter.type }}</a>
16-
</div>
17-
<ng-template #noID
18-
><div class="py-4 px-2">{{ parameter.type }}</div></ng-template
19-
>
20-
</td>
21-
<td>
22-
<div class="py-4 px-2">
23-
{{ parameter.name }}
24-
</div>
25-
</td>
26-
</tr>
27-
</table>
28-
</div>
29-
<div *ngIf="def.return.type != ''">
30-
<doxygen-return [return]="def.return"></doxygen-return>
31-
</div>
5+
<table *ngIf="def.parameters.length > 0">
6+
<tr>
7+
<th><h2 id="parameters" class="text-base font-bold m-0">Parameters</h2></th>
8+
<th class="w-full"></th>
9+
</tr>
10+
11+
<tr
12+
*ngFor="let parameter of def.parameters"
13+
class="odd:bg-black/5 dark:odd:bg-white/5">
14+
<td class="text-right whitespace-nowrap align-top py-2">
15+
<doxygen-type-name [def]="parameter"></doxygen-type-name>
16+
</td>
17+
<td class="py-2">
18+
<div>
19+
<code class="dark:text-secondary">{{ parameter.name }}</code>
20+
</div>
21+
<p
22+
*ngFor="let paragraph of parameter.detailedDescription"
23+
class="last:mb-0">
24+
<doxygen-paragraph [paragraph]="paragraph"></doxygen-paragraph>
25+
</p>
26+
</td>
27+
</tr>
28+
29+
<tr>
30+
<th><h2 id="returns" class="text-base font-bold m-0">Returns</h2></th>
31+
<th></th>
32+
</tr>
33+
<tr>
34+
<td class="text-right whitespace-nowrap align-top py-2">
35+
<doxygen-type-name [def]="def.return"></doxygen-type-name>
36+
</td>
37+
<td class="py-2">{{ def.return.description }}</td>
38+
</tr>
39+
</table>
3240

3341
<doxygen-location [location]="def.location"></doxygen-location>

src/components/doxygen-function-def/doxygen-function-def.module.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ import {DoxygenReturnModule} from '../doxygen-member-components/doxygen-return/d
88
import {DoxygenLocationModule} from '../doxygen-member-components/doxygen-location/doxygen-location.module';
99
import {DoxygenDefinitionModule} from '../doxygen-member-components/doxygen-definition/doxygen-definition.module';
1010
import {DoxygenRefidLinkModule} from '../doxygen-refid-link/doxygen-refid-link.module';
11+
import {DoxygenTypeNameModule} from '../doxygen-type-name/doxygen-type-name.module';
1112

1213
@NgModule({
1314
declarations: [DoxygenFunctionDefComponent],
1415
imports: [
1516
CommonModule,
17+
DoxygenTypeNameModule,
1618
DoxygenParagraphModule,
1719
DoxygenDescriptionModule,
1820
DoxygenParametersModule,
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<h3 style="font-size: 18">Description</h3>
21
<p *ngFor="let paragraph of description">
32
<doxygen-paragraph [paragraph]="paragraph"></doxygen-paragraph>
43
</p>

src/styles.scss

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,6 @@ table {
127127
tr:first-child {
128128
background-color: var(--color-content-bg);
129129

130-
th {
131-
border-bottom: 1px solid var(--color-text);
132-
border-top: 1px solid var(--color-text);
133-
}
134-
135130
th:first-child {
136131
border-top-left-radius: 4px;
137132
}
@@ -141,6 +136,11 @@ table {
141136
}
142137
}
143138

139+
th {
140+
border-bottom: 1px solid var(--color-text);
141+
border-top: 1px solid var(--color-text);
142+
}
143+
144144
tr > td:first-child,
145145
tr > th:first-child {
146146
border-left: 1px solid var(--color-text);

0 commit comments

Comments
 (0)