Fill Documentation Stubs

Author: Behemyth

cppython/plugins/cmake/schema.py

@@ -1,4 +1,9 @@
-"""CMake data definitions"""
+"""CMake plugin schema
+
+This module defines the schema and data models for integrating the CMake
+generator with CPPython. It includes definitions for cache variables,
+configuration presets, and synchronization data.
+"""
 
 from enum import Enum, auto
 from pathlib import Path
@@ -11,10 +16,10 @@
 
 
 class VariableType(Enum):
-    """_summary_
+    """Defines the types of variables that can be used in CMake cache.
 
     Args:
-        Enum: _description_
+        Enum: Base class for creating enumerations.
     """
 
     BOOL = (auto(),)  # Boolean ON/OFF value.
@@ -27,7 +32,12 @@ class VariableType(Enum):
 
 
 class CacheVariable(CPPythonModel, extra='forbid'):
-    """_summary_"""
+    """Represents a variable in the CMake cache.
+
+    Attributes:
+        type: The type of the variable (e.g., BOOL, PATH).
+        value: The value of the variable, which can be a boolean or string.
+    """
 
     type: None | VariableType
     value: bool | str

cppython/plugins/conan/plugin.py

@@ -1,4 +1,9 @@
-"""_summary_"""
+"""Conan Provider Plugin
+
+This module implements the Conan provider plugin for CPPython. It handles
+integration with the Conan package manager, including dependency resolution,
+installation, and synchronization with other tools.
+"""
 
 from pathlib import Path
 from typing import Any
@@ -67,24 +72,27 @@ def update(self) -> None:
 
     @staticmethod
     def supported_sync_type(sync_type: type[SyncData]) -> bool:
-        """_summary_
+        """Checks if the given sync type is supported by the Conan provider.
 
         Args:
-            sync_type: _description_
+            sync_type: The type of synchronization data to check.
 
         Returns:
-            _description_
+            True if the sync type is supported, False otherwise.
         """
         return sync_type in CMakeGenerator.sync_types()
 
     def sync_data(self, consumer: SyncConsumer) -> SyncData:
-        """_summary_
+        """Generates synchronization data for the given consumer.
 
         Args:
-            consumer: _description_
+            consumer: The input consumer for which synchronization data is generated.
 
         Returns:
-            _description_
+            The synchronization data object.
+
+        Raises:
+            NotSupportedError: If the consumer's sync type is not supported.
         """
         for sync_type in consumer.sync_types():
             if sync_type == CMakeSyncData:

cppython/plugins/conan/resolution.py

@@ -1,4 +1,4 @@
-"""_summary_"""
+"""Provides functionality to resolve Conan-specific data for the CPPython project."""
 
 from typing import Any
 

cppython/plugins/conan/schema.py

@@ -1,4 +1,9 @@
-"""TODO"""
+"""Conan plugin schema
+
+This module defines Pydantic models used for integrating the Conan
+package manager with the CPPython environment. The classes within
+provide structured configuration and data needed by the Conan Provider.
+"""
 
 from cppython.core.schema import CPPythonModel
 

cppython/plugins/git/plugin.py

@@ -1,4 +1,9 @@
-"""Git SCM plugin"""
+"""Git SCM Plugin
+
+This module implements the Git SCM plugin for CPPython. It provides
+functionality for interacting with Git repositories, including feature
+detection, version extraction, and project description retrieval.
+"""
 
 from pathlib import Path
 

cppython/plugins/vcpkg/plugin.py

@@ -47,13 +47,13 @@ def features(directory: Path) -> SupportedProviderFeatures:
 
     @staticmethod
     def supported_sync_type(sync_type: type[SyncData]) -> bool:
-        """_summary_
+        """Checks if the given sync type is supported by the vcpkg provider.
 
         Args:
-            sync_type: _description_
+            sync_type: The type of synchronization data to check.
 
         Returns:
-            _description_
+            True if the sync type is supported, False otherwise.
         """
         return sync_type in CMakeGenerator.sync_types()
 

cppython/test/mock/generator.py

@@ -51,10 +51,10 @@ def information() -> Information:
 
     @staticmethod
     def sync_types() -> list[type[SyncData]]:
-        """_summary_
+        """Returns the supported synchronization data types for the mock generator.
 
         Returns:
-            _description_
+            A list of supported synchronization data types.
         """
         return [MockSyncData]
 

tests/integration/examples/test_conan_cmake.py

@@ -1,4 +1,8 @@
-"""TODO"""
+"""Integration tests for the conan and CMake project variation.
+
+This module contains integration tests for projects that use conan and CMake.
+The tests ensure that the projects build, configure, and execute correctly.
+"""
 
 import subprocess
 

tests/integration/examples/test_vcpkg_cmake.py

@@ -1,4 +1,8 @@
-"""TODO"""
+"""Integration tests for the vcpkg and CMake project variation.
+
+This module contains integration tests for projects that use vcpkg and CMake.
+The tests ensure that the projects build, configure, and execute correctly.
+"""
 
 import subprocess