docs: add some documentation

Author: Slartibartfass2

src/lib/components/composites/paper-components/paper-view/cards/PaperCard.svelte

@@ -19,7 +19,7 @@
 <!-- Use PaperCardContent elements as children with values according to the tabs props -->
 <!--
 @component
-Paper Card used in the Paper View component.
+Paper Card used in the `PaperView` component.
 
 For each tab in the tabs prop, a tab is created with the label and value of the tab.
 The children of the PaperCard component are rendered in the content of the tab.

src/lib/components/composites/paper-components/paper-view/cards/PaperCardContent.svelte

@@ -13,7 +13,7 @@
 <!-- flex cannot be applied to the Tabs.Content element directly, which is why the content is wrapped in another div -->
 <!--
 @component
-Card content used in the Paper Card component.
+Card content used in the `PaperCard` component.
 
 Usage:
 ```svelte

src/lib/components/composites/paper-components/paper-view/cards/PaperDetailsCard.svelte

@@ -86,7 +86,7 @@
 
 <!--
 @component
-Paper Card for paper details in the Paper View component.
+`PaperCard` for displaying the details of a paper in the `PaperView` component.
 
 Usage:
 ```svelte

src/lib/components/composites/paper-components/paper-view/cards/PaperResearchContextCard.svelte

@@ -24,7 +24,7 @@
 
 <!--
 @component
-Paper Card for review information of a paper in the Paper View component.
+`PaperCard` for displaying the review information and forward/backward references of a paper in the `PaperView` component.
 
 Usage:
 ```svelte

src/lib/components/composites/paper-components/paper-view/cards/ReferencesAndCitationsCardContent.svelte

@@ -32,6 +32,15 @@
     }
 </script>
 
+<!--
+@component
+Card Content for references and citations of a paper, used by `PaperResearchContextCard`.
+
+Usage:
+```svelte
+    <ReferencesAndCitationsCardContent {backwardReferencedPapers} {forwardReferencedPapers} />
+```
+-->
 <section class="flex flex-col h-full gap-5">
     <div class="flex h-full overflow-hidden flex-[1_1_0]">
         <NamedList

src/lib/components/composites/search-bar/SearchBar.svelte

@@ -55,7 +55,7 @@ so if no further handling exist, all elements are retrieved
 by the search.
 
 To limit the amount of calls (if used with backend calls), the search only starts after a
-specified timout in which no other events occur. The default for this is 500 ms.
+specified timeout in which no other events occur. The default timeout is 500 ms.
 
 Usage:
 ```svelte

src/lib/filters.ts

@@ -12,7 +12,7 @@ import type { User } from "./model/api/user";
  * @returns List of items that match the search text
  */
 function filter<T>(items: T[], selector: (item: T) => string, searchText: string) {
-    // Here we case the items to string[] and selector to Selector<string> because we can't just use a selector
+    // Here we cast the items to string[] and selector to Selector<string> because we can't just use a selector
     // with a generic type. This is weird but it's the only way to make it work.
     const fzf = new Fzf(items as string[], {
         selector: selector as Selector<string>,

src/lib/model/general.ts

@@ -47,4 +47,4 @@ function asPaper(paper: Project_Paper | Paper): Paper {
 }
 
 export type { ValidationResult, ApiError, ProjectListEntryInterface, PaperListEntryInterface };
-export { isProjectPaper, asPaper };
+export { asPaper };