added docs skeleton

Author: RPG-Alex

src/ast.rs

@@ -83,8 +83,9 @@ impl ParsedSqlFileSet {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
     use std::{env, fs};
+
+    use super::*;
     use crate::files::{SqlFile, SqlFileSet};
 
     #[test]

src/docs.rs

@@ -8,6 +8,19 @@ pub struct ColumnDoc {
     name: String,
     doc: Option<String>,
 }
+impl ColumnDoc {
+    /// Getter for the `name` field
+    #[must_use]
+    pub fn name(&self) -> &str {
+        &self.name
+    }
+
+    /// Getter for the field `doc`
+    #[must_use]
+    pub fn doc(&self) -> &Option<String> {
+        &self.doc
+    }
+}
 
 /// Structure for containing the `name` of the `Table`, an [`Option`] for the
 /// comment as a [`String`], and a `Vec` of [`ColumnDoc`] contained in the table
@@ -17,6 +30,27 @@ pub struct TableDoc {
     columns: Vec<ColumnDoc>,
 }
 
+impl TableDoc {
+
+    /// Getter for the `name` field
+    #[must_use]
+    pub fn name(&self) -> &str {
+        &self.name
+    }
+
+    /// Getter for the `doc` field 
+    #[must_use]
+    pub fn doc(&self) -> &Option<String> {
+        &self.doc
+    }
+
+    /// Getter for the `columns` field
+    #[must_use]
+    pub fn columns(&self) -> &[ColumnDoc] {
+        &self.columns
+    }
+}
+
 /// Structure for containing the docs for every `Table` in an `.sql` file as a
 /// `Vec` of [`TableDoc`]
 pub struct SqlDocs {
@@ -26,11 +60,12 @@ pub struct SqlDocs {
 impl SqlDocs {
     /// Create a new instance of [`SqlDocs`]
     #[must_use]
-    pub fn new(tables: Vec<TableDoc>) -> Self {
+    pub const fn new(tables: Vec<TableDoc>) -> Self {
         Self { tables }
     }
 
-    /// Builds documentation for sql file by attaching leading comments to tables and columns
+    /// Builds documentation for sql file by attaching leading comments to
+    /// tables and columns
     #[must_use]
     pub fn from_parsed_file(file: &ParsedSqlFile, comments: &Comments) -> Self {
         todo!()