Skip to content

Commit e2b582d

Browse files
committed
Fix phpdoc_align style issues
Remove partial @param documentation that only documented some parameters while others relied on type hints. This was triggering Pint's phpdoc_align rule. Affected files: - ListDocuments.php - Document.php - DocumentService.php - MarkdownConverter.php
1 parent bda8e15 commit e2b582d

4 files changed

Lines changed: 0 additions & 17 deletions

File tree

server-documentation/src/Filament/Admin/Resources/DocumentResource/Pages/ListDocuments.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,6 @@ protected function getHeaderActions(): array
6363

6464
/**
6565
* Import a Markdown file and create a new document.
66-
*
67-
* @param array{markdown_file: TemporaryUploadedFile, use_frontmatter?: bool} $data
6866
*/
6967
protected function importMarkdownFile(array $data): void
7068
{

server-documentation/src/Models/Document.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,9 +247,6 @@ public function scopeForServer(Builder $query, Server $server): Builder
247247
});
248248
}
249249

250-
/**
251-
* @param array<string> $types
252-
*/
253250
public function scopeForTypes(Builder $query, array $types): Builder
254251
{
255252
return $query->whereIn('type', $types);

server-documentation/src/Services/DocumentService.php

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ public function getDocumentsForServer(Server $server, ?User $user = null): Colle
6868

6969
/**
7070
* Query documents for a server without caching.
71-
*
72-
* @param array<string> $allowedTypes
7371
*/
7472
protected function queryDocumentsForServer(Server $server, array $allowedTypes): Collection
7573
{
@@ -155,8 +153,6 @@ public function isServerMod(User $user, Server $server): bool
155153

156154
/**
157155
* Generate a change summary for version history.
158-
*
159-
* @param array<string> $dirtyFields
160156
*/
161157
public function generateChangeSummary(array $dirtyFields, string $oldContent, string $newContent): string
162158
{
@@ -337,8 +333,6 @@ protected function cacheSupportsTagging(): bool
337333

338334
/**
339335
* Generate cache key for server documents.
340-
*
341-
* @param array<string> $allowedTypes
342336
*/
343337
protected function getServerDocumentsCacheKey(Server $server, array $allowedTypes): string
344338
{
@@ -402,8 +396,6 @@ public function pruneVersions(Document $document, ?int $keepCount = null): int
402396

403397
/**
404398
* Log an audit event for document operations.
405-
*
406-
* @param array<string, mixed> $context
407399
*/
408400
protected function logAudit(string $action, Document $document, array $context = []): void
409401
{

server-documentation/src/Services/MarkdownConverter.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ public function toMarkdown(string $html): string
4242

4343
/**
4444
* Convert Markdown content to HTML.
45-
*
46-
* @param bool $sanitize Whether to sanitize the output HTML (default: true)
4745
*/
4846
public function toHtml(string $markdown, bool $sanitize = true): string
4947
{
@@ -265,8 +263,6 @@ public function sanitizeFilename(string $name): string
265263

266264
/**
267265
* Add YAML frontmatter to markdown content.
268-
*
269-
* @param array<string, mixed> $metadata
270266
*/
271267
public function addFrontmatter(string $markdown, array $metadata): string
272268
{

0 commit comments

Comments
 (0)