File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1616
1717
1818class VariableType (Enum ):
19- """_summary_
19+ """Defines the types of variables that can be used in CMake cache.
2020
2121 Args:
22- Enum: _description_
22+ Enum: Base class for creating enumerations.
2323 """
2424
2525 BOOL = (auto (),) # Boolean ON/OFF value.
@@ -32,7 +32,12 @@ class VariableType(Enum):
3232
3333
3434class CacheVariable (CPPythonModel , extra = 'forbid' ):
35- """_summary_"""
35+ """Represents a variable in the CMake cache.
36+
37+ Attributes:
38+ type: The type of the variable (e.g., BOOL, PATH).
39+ value: The value of the variable, which can be a boolean or string.
40+ """
3641
3742 type : None | VariableType
3843 value : bool | str
Original file line number Diff line number Diff line change @@ -72,24 +72,27 @@ def update(self) -> None:
7272
7373 @staticmethod
7474 def supported_sync_type (sync_type : type [SyncData ]) -> bool :
75- """_summary_
75+ """Checks if the given sync type is supported by the Conan provider.
7676
7777 Args:
78- sync_type: _description_
78+ sync_type: The type of synchronization data to check.
7979
8080 Returns:
81- _description_
81+ True if the sync type is supported, False otherwise.
8282 """
8383 return sync_type in CMakeGenerator .sync_types ()
8484
8585 def sync_data (self , consumer : SyncConsumer ) -> SyncData :
86- """_summary_
86+ """Generates synchronization data for the given consumer.
8787
8888 Args:
89- consumer: _description_
89+ consumer: The input consumer for which synchronization data is generated.
9090
9191 Returns:
92- _description_
92+ The synchronization data object.
93+
94+ Raises:
95+ NotSupportedError: If the consumer's sync type is not supported.
9396 """
9497 for sync_type in consumer .sync_types ():
9598 if sync_type == CMakeSyncData :
Original file line number Diff line number Diff line change 1- """_summary_ """
1+ """Provides functionality to resolve Conan-specific data for the CPPython project. """
22
33from typing import Any
44
Original file line number Diff line number Diff line change @@ -47,13 +47,13 @@ def features(directory: Path) -> SupportedProviderFeatures:
4747
4848 @staticmethod
4949 def supported_sync_type (sync_type : type [SyncData ]) -> bool :
50- """_summary_
50+ """Checks if the given sync type is supported by the vcpkg provider.
5151
5252 Args:
53- sync_type: _description_
53+ sync_type: The type of synchronization data to check.
5454
5555 Returns:
56- _description_
56+ True if the sync type is supported, False otherwise.
5757 """
5858 return sync_type in CMakeGenerator .sync_types ()
5959
Original file line number Diff line number Diff line change @@ -51,10 +51,10 @@ def information() -> Information:
5151
5252 @staticmethod
5353 def sync_types () -> list [type [SyncData ]]:
54- """_summary_
54+ """Returns the supported synchronization data types for the mock generator.
5555
5656 Returns:
57- _description_
57+ A list of supported synchronization data types.
5858 """
5959 return [MockSyncData ]
6060
You can’t perform that action at this time.
0 commit comments