From fe4ca0bc77252e20f88b7f80a005db01309de5b9 Mon Sep 17 00:00:00 2001
From: Arvin Singh Kushwaha <askushwa@ncsu.edu>
Date: Tue, 9 Aug 2022 13:18:09 -0400
Subject: [PATCH] Added documentation to public functions

---
 src/plugins/syntect.rs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/plugins/syntect.rs b/src/plugins/syntect.rs
index d45d153d..b9a0abe6 100644
--- a/src/plugins/syntect.rs
+++ b/src/plugins/syntect.rs
@@ -119,21 +119,33 @@ pub struct SyntectAdapterBuilder<'a> {
 }
 
 impl<'a> SyntectAdapterBuilder<'a> {
+    /// Creates a new empty [`SyntectAdapterBuilder`]
     pub fn new() -> Self {
         Default::default()
     }
+
+    /// Sets the theme
     pub fn theme(mut self, s: &'a str) -> Self {
         self.theme.replace(s);
         self
     }
+
+    /// Sets the syntax set
     pub fn syntax_set(mut self, s: SyntaxSet) -> Self {
         self.syntax_set.replace(s);
         self
     }
+
+    /// Sets the theme set
     pub fn theme_set(mut self, s: ThemeSet) -> Self {
         self.theme_set.replace(s);
         self
     }
+
+    /// Builds the [`SyntectAdapter`]. Default values:
+    /// - `theme`: `InspiredGitHub`
+    /// - `syntax_set`: [`SyntaxSet::load_defaults_newlines()`]
+    /// - `theme_set`: [`ThemeSet::load_defaults()`]
     pub fn build(self) -> SyntectAdapter<'a> {
         SyntectAdapter {
             theme: self.theme.unwrap_or("InspiredGitHub"),