docs: enhance documentation for File and Project classes with detailed descriptions and parameters

Author: SunBK201

scubatrace/file.py

@@ -21,9 +21,12 @@
 
 class File:
     """
-    Represents a file in a project.
+    Represents a source code file in a project.
     """
 
+    project: Project
+    """ The project this file belongs to."""
+
     def __init__(self, path: str, project: Project):
         """
         Initializes a new instance of the class.
@@ -40,6 +43,17 @@ def __init__(self, path: str, project: Project):
 
     @staticmethod
     def File(path: str, project: Project) -> File:
+        """
+        Factory function to create a :class:`File` instance.
+
+        Args:
+            path (str): The file relative path.
+            project (Project): The project instance.
+
+        Returns:
+            File: An instance of a language-specific File subclass corresponding to the project's language.
+        """
+
         if project.language == lang.C:
             from .cpp.file import CFile
 
@@ -90,10 +104,7 @@ def language(self) -> type[lang.Language]:
     @property
     def name(self) -> str:
         """
-        Returns the name of the file without the directory path.
-
-        Returns:
-            str: The name of the file.
+        The name of the file without the directory path.
         """
         return os.path.basename(self._path)
 

scubatrace/project.py

@@ -24,6 +24,11 @@ class Project:
     Represents a codebase project with a specified path and language.
     """
 
+    path: str
+    """The file system path to the project root."""
+    language: type[lang.Language]
+    """The programming language type for the project."""
+
     @staticmethod
     def Project(
         path: str,
@@ -32,13 +37,16 @@ def Project(
     ) -> Project:
         """
         Factory function to create a language-specific :class:`Project` instance.
+
         Args:
             path (str): The file system path to the project root.
             language (type[Language]): The programming language type for the project.
             enable_lsp (bool, optional): Whether to enable Language Server Protocol (LSP) support. Defaults to True.
                 Note: For PHP and Swift, LSP is always disabled.
+
         Returns:
             Project: An instance of the appropriate language-specific Project subclass.
+
         Raises:
             ValueError: If the provided language is not supported.
         """