AutoBuildDocumentation

sphinx/source/api/classes/class_wellfired_peek_application_unity_editor_dotpeek.rst

@@ -11,7 +11,7 @@ DotPeek
 Description
 ------------
 
-
+This is a public wrapper around .:ref:`Peek<namespacewellfired_peek>` application. It gives access to different utilities allowing a total control of .:ref:`Peek<namespacewellfired_peek>`. 
 
 Properties
 -----------
@@ -23,19 +23,19 @@ Properties
 +---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
 |:ref:`Storage<classwellfired_peek_viewmodel_datastorage_storage>`                            |:ref:`Storage<classwellfired_peek_application_unity_editor_dotpeek_1a6a07d42db1939a49cee805130f110e30>` **{** get; set; **}**              |
 +---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-|:ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>`          |:ref:`CurrentApplication<classwellfired_peek_application_unity_editor_dotpeek_1aea375075bf499b7c4410e64f52bfecbc>` **{** get; set; **}**   |
-+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
 |:ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>`          |:ref:`NewApplication<classwellfired_peek_application_unity_editor_dotpeek_1a060d3530544a95556c42d4f9c5d0ccef>` **{** get; set; **}**       |
 +---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+|:ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>`          |:ref:`CurrentApplication<classwellfired_peek_application_unity_editor_dotpeek_1aea375075bf499b7c4410e64f52bfecbc>` **{** get; set; **}**   |
++---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
 |:ref:`DotPeek<classwellfired_peek_application_unity_editor_dotpeek>`                         |:ref:`Instance<classwellfired_peek_application_unity_editor_dotpeek_1ae8953869686231a60e38e0c1d274ae8a>` **{** get; set; **}**             |
 +---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
 
 Public Methods
 ---------------
 
-+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-|void         |:ref:`DoBuildGenerated<classwellfired_peek_application_unity_editor_dotpeek_1a34172c6ad8cd394d1f3ae160dfdbde76>` **(** string path **)**   |
-+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
++-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|void         |:ref:`DoBuildReportGenerated<classwellfired_peek_application_unity_editor_dotpeek_1a69ad8fbacf003021521a5dcff05e12a9>` **(** string reportAbsolutePath **)**   |
++-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Breakdown
 ----------
@@ -44,27 +44,61 @@ Breakdown
 
 - :ref:`IDotPeekListener<interfacewellfired_peek_application_unity_editor_idotpeeklistener>` **Listener** **{** get; set; **}**
 
+    **Description**
+
+        Give access to .:ref:`Peek<namespacewellfired_peek>` callbacks, like when the report is generated and where it is stored for example. 
+
 .. _classwellfired_peek_application_unity_editor_dotpeek_1a381e1d91dc2dff79988fbc20fa60f8bc:
 
 - :ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>` **CustomVCS** **{** get; set; **}**
 
+    **Description**
+
+        Allows to provide a custom commit id to .:ref:`Peek<namespacewellfired_peek>` when it is generating the build report. 
+
 .. _classwellfired_peek_application_unity_editor_dotpeek_1a6a07d42db1939a49cee805130f110e30:
 
 - :ref:`Storage<classwellfired_peek_viewmodel_datastorage_storage>` **Storage** **{** get; set; **}**
 
-.. _classwellfired_peek_application_unity_editor_dotpeek_1aea375075bf499b7c4410e64f52bfecbc:
+    **Description**
 
-- :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>` **CurrentApplication** **{** get; set; **}**
+        Allows to read or modify .:ref:`Peek<namespacewellfired_peek>` settings on the disk. 
 
 .. _classwellfired_peek_application_unity_editor_dotpeek_1a060d3530544a95556c42d4f9c5d0ccef:
 
 - :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>` **NewApplication** **{** get; set; **}**
 
+    **Description**
+
+        Create a new :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>` that will receive the different callbacks from the game engine when build is being processed. When a new session is required, then the previous one is garbage collected. 
+
+.. _classwellfired_peek_application_unity_editor_dotpeek_1aea375075bf499b7c4410e64f52bfecbc:
+
+- :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>` **CurrentApplication** **{** get; set; **}**
+
+    **Description**
+
+        Returns the current :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>`. 
+
 .. _classwellfired_peek_application_unity_editor_dotpeek_1ae8953869686231a60e38e0c1d274ae8a:
 
 - :ref:`DotPeek<classwellfired_peek_application_unity_editor_dotpeek>` **Instance** **{** get; set; **}**
 
-.. _classwellfired_peek_application_unity_editor_dotpeek_1a34172c6ad8cd394d1f3ae160dfdbde76:
+    **Description**
+
+        Returns the only access point to :ref:`DotPeek<classwellfired_peek_application_unity_editor_dotpeek>`. 
+
+.. _classwellfired_peek_application_unity_editor_dotpeek_1a69ad8fbacf003021521a5dcff05e12a9:
+
+- void **DoBuildReportGenerated** **(** string reportAbsolutePath **)**
+
+    **Description**
+
+        This is called after the build report was generated and saved on the disk. 
 
-- void **DoBuildGenerated** **(** string path **)**
+    **Parameters**
 
+        +---------------------+--------------------------------+
+        |reportAbsolutePath   |Location of the build report.   |
+        +---------------------+--------------------------------+
+

sphinx/source/api/classes/class_wellfired_peek_application_vcs_git_vcs_git.rst

@@ -27,3 +27,7 @@ Breakdown
 
 - string **GetCommitId** **(**  **)**
 
+    **Description**
+
+        Provide the current commit id. 
+

sphinx/source/api/classes/class_wellfired_peek_application_vcs_git_vcs_gitinspector.rst

@@ -29,7 +29,27 @@ Breakdown
 
 - bool **IsRepository** **(** string location **)**
 
+    **Description**
+
+        Detect if this :ref:`IVCSInspector<interfacewellfired_peek_application_vcs_ivcsinspector>` is compatible with the :ref:`VCS<namespacewellfired_peek_application_vcs>` used at the location specified. 
+
+    **Parameters**
+
+        +-------------+
+        |location     |
+        +-------------+
+
 .. _classwellfired_peek_application_vcs_git__vcs_gitinspector_1ab3fccd0b65b174d1a9f49d1eddc552cc:
 
 - :ref:`RepositoryInfo<classwellfired_peek_application_vcs_repositoryinfo>` **GetRepositoryInfo** **(** string location **)**
 
+    **Description**
+
+        Get information about the state of the repository at the location specified. 
+
+    **Parameters**
+
+        +-------------+
+        |location     |
+        +-------------+
+

sphinx/source/api/classes/class_wellfired_peek_application_vcs_novcs.rst

@@ -11,7 +11,7 @@ NoVCS
 Description
 ------------
 
-
+This is used when no :ref:`VCS<namespacewellfired_peek_application_vcs>` used by the project could be detected. 
 
 Public Methods
 ---------------
@@ -27,3 +27,7 @@ Breakdown
 
 - string **GetCommitId** **(**  **)**
 
+    **Description**
+
+        Provide the current commit id. 
+

sphinx/source/api/classes/class_wellfired_peek_application_vcs_repositoryinfo.rst

@@ -8,16 +8,16 @@ RepositoryInfo
 Description
 ------------
 
-
+Info about the status of a local repository 
 
 Public Properties
 ------------------
 
-+-------------------+----------------------------------------------------------------------------------------------------------+
-|string             |:ref:`CommitID<classwellfired_peek_application_vcs_repositoryinfo_1a81255c57aa6836d0f620a6196f68c807>`    |
-+-------------------+----------------------------------------------------------------------------------------------------------+
-|RepositoryStatus   |:ref:`Status<classwellfired_peek_application_vcs_repositoryinfo_1afc5d782a3826595f2bd700c20b0b6fdd>`      |
-+-------------------+----------------------------------------------------------------------------------------------------------+
++------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
+|string                                                                                                |:ref:`CommitID<classwellfired_peek_application_vcs_repositoryinfo_1a81255c57aa6836d0f620a6196f68c807>`    |
++------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
+|:ref:`RepositoryStatus<namespacewellfired_peek_application_vcs_1a35335600ae0002c46f9b81efcf289892>`   |:ref:`Status<classwellfired_peek_application_vcs_repositoryinfo_1afc5d782a3826595f2bd700c20b0b6fdd>`      |
++------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
 
 Breakdown
 ----------
@@ -26,7 +26,15 @@ Breakdown
 
 - string **CommitID** 
 
+    **Description**
+
+        The commit Id checked out. 
+
 .. _classwellfired_peek_application_vcs_repositoryinfo_1afc5d782a3826595f2bd700c20b0b6fdd:
 
-- RepositoryStatus **Status** 
+- :ref:`RepositoryStatus<namespacewellfired_peek_application_vcs_1a35335600ae0002c46f9b81efcf289892>` **Status** 
+
+    **Description**
+
+        Indicates if the local repository is synchronized with the remote one or not. 
 

sphinx/source/api/classes/class_wellfired_peek_application_vcs_svn_vcs_svn.rst

@@ -27,3 +27,7 @@ Breakdown
 
 - string **GetCommitId** **(**  **)**
 
+    **Description**
+
+        Provide the current commit id. 
+

sphinx/source/api/classes/class_wellfired_peek_application_vcs_svn_vcs_svninspector.rst

@@ -29,7 +29,27 @@ Breakdown
 
 - bool **IsRepository** **(** string location **)**
 
+    **Description**
+
+        Detect if this :ref:`IVCSInspector<interfacewellfired_peek_application_vcs_ivcsinspector>` is compatible with the :ref:`VCS<namespacewellfired_peek_application_vcs>` used at the location specified. 
+
+    **Parameters**
+
+        +-------------+
+        |location     |
+        +-------------+
+
 .. _classwellfired_peek_application_vcs_svn__vcs_svninspector_1aa2c71d4e59efeba8ed2283d8b6fee72a:
 
 - :ref:`RepositoryInfo<classwellfired_peek_application_vcs_repositoryinfo>` **GetRepositoryInfo** **(** string location **)**
 
+    **Description**
+
+        Get information about the state of the repository at the location specified. 
+
+    **Parameters**
+
+        +-------------+
+        |location     |
+        +-------------+
+

sphinx/source/api/classes/class_wellfired_peek_application_vcs_vcsutils.rst

@@ -24,3 +24,7 @@ Breakdown
 
 - :ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>` **GetVCSInUse** **(**  **)**
 
+    **Description**
+
+        Detect which :ref:`VCS<namespacewellfired_peek_application_vcs>` is being used at the location the dll is being executed and return the relevant :ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>`. 
+

sphinx/source/api/classes/class_wellfired_peek_data_utility.rst

@@ -13,9 +13,11 @@ Description
 Public Static Methods
 ----------------------
 
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-|string       |:ref:`Nicify<classwellfired_peek_data_utility_1ac19af491b6c4b5edfc75815cdd3e5980>` **(** this string stringValue **)**   |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
++-------------+----------------------------------------------------------------------------------------------------------------------------+
+|string       |:ref:`Nicify<classwellfired_peek_data_utility_1ac19af491b6c4b5edfc75815cdd3e5980>` **(** this string stringValue **)**      |
++-------------+----------------------------------------------------------------------------------------------------------------------------+
+|float        |:ref:`Keep2Decimals<classwellfired_peek_data_utility_1a8d1c748d01d69dcb2f0e99f632a89038>` **(** float originalValue **)**   |
++-------------+----------------------------------------------------------------------------------------------------------------------------+
 
 Breakdown
 ----------
@@ -24,3 +26,7 @@ Breakdown
 
 - string **Nicify** **(** this string stringValue **)**
 
+.. _classwellfired_peek_data_utility_1a8d1c748d01d69dcb2f0e99f632a89038:
+
+- float **Keep2Decimals** **(** float originalValue **)**
+

sphinx/source/api/classes/class_wellfired_peek_generator_buildreportgeneration_utils_assetsprocessor.rst

@@ -19,7 +19,7 @@ Public Methods
 +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |                                                                     |:ref:`AssetsProcessor<classwellfired_peek_generator_buildreportgeneration_utils_assetsprocessor_1ad62cf6cbca49d22887c32c554d11e1c5>` **(** :ref:`IPluginAnalyzer<interfacewellfired_peek_generator_platformtools_ipluginanalyzer>` pluginAnalyzer, :ref:`IFileAnalyzer<interfacewellfired_peek_generator_buildreportgeneration_utils_ifileanalyzer>` fileAnalyzer, :ref:`FileLocations<classwellfired_peek_generator_buildreportgeneration_utils_filelocations>` fileLocations **)**   |
 +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|List< :ref:`IAsset<interfacewellfired_peek_model_assets_iasset>` >   |:ref:`SortOutUsedAndUnusedAssets<classwellfired_peek_generator_buildreportgeneration_utils_assetsprocessor_1a9a131edf482ebb5c67b9a85b9eccc31d>` **(** List< :ref:`IAsset<interfacewellfired_peek_model_assets_iasset>` > usedAssets, List< :ref:`IScene<interfacewellfired_peek_model_assets_iscene>` > buildScenes, Platform platform **)**                                                                                                                                           |
+|List< :ref:`IAsset<interfacewellfired_peek_model_assets_iasset>` >   |:ref:`SortOutUsedAndUnusedAssets<classwellfired_peek_generator_buildreportgeneration_utils_assetsprocessor_1aa8b68ed859c31f03acdfc8ee26c68977>` **(** List< :ref:`IAsset<interfacewellfired_peek_model_assets_iasset>` > usedAssets, List< :ref:`IScene<interfacewellfired_peek_model_assets_iscene>` > buildScenes, :ref:`FileSize<structwellfired_peek_data_filesize>` buildSize, Platform platform **)**                                                                            |
 +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Breakdown
@@ -29,7 +29,7 @@ Breakdown
 
 -  **AssetsProcessor** **(** :ref:`IPluginAnalyzer<interfacewellfired_peek_generator_platformtools_ipluginanalyzer>` pluginAnalyzer, :ref:`IFileAnalyzer<interfacewellfired_peek_generator_buildreportgeneration_utils_ifileanalyzer>` fileAnalyzer, :ref:`FileLocations<classwellfired_peek_generator_buildreportgeneration_utils_filelocations>` fileLocations **)**
 
-.. _classwellfired_peek_generator_buildreportgeneration_utils_assetsprocessor_1a9a131edf482ebb5c67b9a85b9eccc31d:
+.. _classwellfired_peek_generator_buildreportgeneration_utils_assetsprocessor_1aa8b68ed859c31f03acdfc8ee26c68977:
 
-- List< :ref:`IAsset<interfacewellfired_peek_model_assets_iasset>` > **SortOutUsedAndUnusedAssets** **(** List< :ref:`IAsset<interfacewellfired_peek_model_assets_iasset>` > usedAssets, List< :ref:`IScene<interfacewellfired_peek_model_assets_iscene>` > buildScenes, Platform platform **)**
+- List< :ref:`IAsset<interfacewellfired_peek_model_assets_iasset>` > **SortOutUsedAndUnusedAssets** **(** List< :ref:`IAsset<interfacewellfired_peek_model_assets_iasset>` > usedAssets, List< :ref:`IScene<interfacewellfired_peek_model_assets_iscene>` > buildScenes, :ref:`FileSize<structwellfired_peek_data_filesize>` buildSize, Platform platform **)**
 

sphinx/source/api/classes/class_wellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy.rst

@@ -24,3 +24,7 @@ Breakdown
 
 - string **GUID** **{** get; set; **}**
 
+    **Description**
+
+        This GUID is an identifier for .:ref:`Peek<namespacewellfired_peek>` accross all the team working in a specific :ref:`Unity<namespacewellfired_peek_unity>` project. This is used for example to saved build report in a specific subfolder, allowing different :ref:`Unity<namespacewellfired_peek_unity>` projects to save the reports in the same folder. 
+