merge: Add docstrings for Sharkey components (!1172)

View MR for information: https://activitypub.software/TransFem-org/Sharkey/-/merge_requests/1172

Approved-by: dakkar <dakkar@thenautilus.net>
Approved-by: Hazelnoot <acomputerdog@gmail.com>

packages/frontend/src/components/DynamicNote.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a note with either Misskey or Sharkey style, based on user preference.
 -->
 
 <template>

packages/frontend/src/components/DynamicNoteDetailed.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a note in the detailed view with either Misskey or Sharkey style, based on user preference.
 -->
 
 <template>

packages/frontend/src/components/DynamicNoteSimple.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a note in the simple view with either Misskey or Sharkey style, based on user preference.
 -->
 
 <template>

packages/frontend/src/components/SkApprovalUser.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: marie and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays an account pending approval, with the signup reason and buttons to approve or delete it.
 -->
 
 <template>

packages/frontend/src/components/SkBadgeStrip.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Horizontal strip that displays a user's badges.
 -->
 
 <template>

packages/frontend/src/components/SkDateSeparatedList.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+List of items, divided by date separators.
 -->
 
 <template>

packages/frontend/src/components/SkErrorList.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+List of errors for a viewed note.
 -->
 
 <template>

packages/frontend/src/components/SkFetchNote.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Fetches and displays a note from a note ID.
 -->
 
 <template>

packages/frontend/src/components/SkFlashPlayer.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: CenTdemeern1 and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a Flash Player window via Ruffle.
 -->
 
 <template>

packages/frontend/src/components/SkFollowingFeedEntry.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Selectable entry on the "Following" feed, displaying a user with their most recent note.
 -->
 
 <template>

packages/frontend/src/components/SkFollowingRecentNotes.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+List that displays the most recent note from each followed user, in order, with date separators.
 -->
 
 <template>

packages/frontend/src/components/SkFormula.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: dakkar, MoshiBar, and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Renders a KaTeX formula.
 -->
 
 <template>

packages/frontend/src/components/SkInstanceTicker.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: syuilo and other misskey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Small label that displays the name and icon of an instance.
 -->
 
 <template>

packages/frontend/src/components/SkMfmWindow.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: marie and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a sheet of info about MFM.
 -->
 
 <template>

packages/frontend/src/components/SkModPlayer.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: puniko and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Media player for module files. Displays the pattern in real time as it plays.
 -->
 
 <template>

packages/frontend/src/components/SkMutedNote.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a placeholder for a muted note.
 -->
 
 <template>

packages/frontend/src/components/SkNote.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: syuilo and misskey-project
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a note in the Sharkey style. Used to show the "main" note in a given context.
 -->
 
 <template>

packages/frontend/src/components/SkNoteDetailed.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: syuilo and other misskey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Detailed view of a note in the Sharkey style. Used when opening a note onto its own page.
 -->
 
 <template>

packages/frontend/src/components/SkNoteHeader.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: marie and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Header for a note in the Sharkey style, displaying info such as username and creation timestamp.
 -->
 
 <template>

packages/frontend/src/components/SkNoteSimple.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: syuilo and other misskey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Simple view of a note in the Sharkey style. Used in quote renotes, link previews, etc.
 -->
 
 <template>

packages/frontend/src/components/SkNoteSub.vue

@@ -1,6 +1,10 @@
 <!--
 SPDX-FileCopyrightText: marie and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a sub-note in the Sharkey style. Used to display secondary notes in a given context.
+
+For example, when viewing a reply on the timeline, SkNoteSub will be used to display the note that is being replied to.
 -->
 
 <template>

packages/frontend/src/components/SkNoteTranslation.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a translated version of a note.
 -->
 
 <template>

packages/frontend/src/components/SkOldNoteWindow.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: marie and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays an old version of an edited note.
 -->
 
 <template>

packages/frontend/src/components/SkOneko.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: kopper and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays Oneko, a cat that follows the cursor.
 -->
 
 <template>

packages/frontend/src/components/SkPatternTest.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Allows a user to write text to test their word mutes against, displaying matched words.
 -->
 
 <template>

packages/frontend/src/components/SkRemoteFollowersWarning.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Warning in the following feed/column that remote users may have incomplete/outdated activity.
 -->
 
 <template>

packages/frontend/src/components/SkSearchResultWindow.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: marie and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a list of notes as results of a search.
 -->
 
 <template>

packages/frontend/src/components/SkTransitionGroup.vue

@@ -1,6 +1,11 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+List of elements, with animations for inserting, removing, and reordering items.
+
+Animation can be disabled with the "reduced animation" preferences.
+This component exists because Misskey's implementation of the reduced animation preference tends to break VueJS.
 -->
 
 <template>

packages/frontend/src/components/SkUrlPreviewGroup.vue

@@ -1,6 +1,11 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a group of URL previews.
+
+If the URL to be previewed links to a note, it will be displayed as a quote.
+Attempts to avoid displaying the same preview twice, even if multiple URLs point to the same resource.
 -->
 
 <template>

packages/frontend/src/components/SkUserRecentNotes.vue

@@ -1,6 +1,8 @@
 <!--
 SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors
 SPDX-License-Identifier: AGPL-3.0-only
+
+Displays a user's recent notes for the "Following" feed.
 -->
 
 <template>