Skip to content

Commit

Permalink
AutoBuildDocumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wellfiredbuildmachine committed Dec 12, 2017
1 parent 04436d6 commit ec07f1d
Show file tree
Hide file tree
Showing 218 changed files with 8,375 additions and 0 deletions.
Empty file removed sphinx/source/api/.gitKeep
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _classwellfired_peek_application_applicationlauncher:

ApplicationLauncher
====================

**Namespace:** :ref:`WellFired.Peek<namespacewellfired_peek>`

Description
------------



Public Static Methods
----------------------

+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|void |:ref:`Launch<classwellfired_peek_application_applicationlauncher_1aaae2bf1283d96f9c74050fbd70d6d95a>` **(** :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>` dotPeekApplication **)** |
+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_applicationlauncher_1aaae2bf1283d96f9c74050fbd70d6d95a:

- void **Launch** **(** :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>` dotPeekApplication **)**

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _classwellfired_peek_application_buildpostprocessor:

BuildPostProcessor
===================

**Namespace:** :ref:`WellFired.Peek<namespacewellfired_peek>`

Description
------------



Public Static Methods
----------------------

+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|async Task |:ref:`PostProcessBuild<classwellfired_peek_application_buildpostprocessor_1aba10cefbb673befccb041fd0a79d0d87>` **(** :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>` dotPeekApplication **)** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_buildpostprocessor_1aba10cefbb673befccb041fd0a79d0d87:

- async Task **PostProcessBuild** **(** :ref:`IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>` dotPeekApplication **)**

Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. _classwellfired_peek_application_unity_editor_unitybuildpostprocessor:

UnityBuildPostProcessor
========================

**Namespace:** :ref:`WellFired.Peek.Application.Unity<namespacewellfired_peek_application_unity>`

Description
------------



Properties
-----------

+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|int |:ref:`callbackOrder<classwellfired_peek_application_unity_editor_unitybuildpostprocessor_1a1af6e085dc034141048ec6940f45960e>` **{** get; set; **}** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

Public Methods
---------------

+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|void |:ref:`OnPostprocessBuild<classwellfired_peek_application_unity_editor_unitybuildpostprocessor_1af41671924d08bfa6fc2d30730a1fce97>` **(** BuildTarget target, string path **)** |
+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_unity_editor_unitybuildpostprocessor_1a1af6e085dc034141048ec6940f45960e:

- int **callbackOrder** **{** get; set; **}**

.. _classwellfired_peek_application_unity_editor_unitybuildpostprocessor_1af41671924d08bfa6fc2d30730a1fce97:

- void **OnPostprocessBuild** **(** BuildTarget target, string path **)**

Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
.. _classwellfired_peek_application_unity_editor_unitydotpeekapplication:

UnityDotPeekApplication
========================

**Namespace:** :ref:`WellFired.Peek.Application.Unity<namespacewellfired_peek_application_unity>`

**Implements:** :ref:`WellFired.Peek.Application.IDotPeekApplication<interfacewellfired_peek_application_idotpeekapplication>`


Description
------------



Properties
-----------

+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|IPlatformProvider |:ref:`PlatformProvider<classwellfired_peek_application_unity_editor_unitydotpeekapplication_1ae045608ffed14d0fbe5e945c1bb7dc43>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`IBuildReportStorage<interfacewellfired_peek_generator_storage_ibuildreportstorage>` |:ref:`BuildReportStorage<classwellfired_peek_application_unity_editor_unitydotpeekapplication_1a06a36c9cbe033b060317662610008aea>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`IPlatformTools<interfacewellfired_peek_generator_platformtools_iplatformtools>` |:ref:`PlatformTools<classwellfired_peek_application_unity_editor_unitydotpeekapplication_1a4ddc9d77c17b50b02e54f3707af069e5>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`IBuildReportGenerator<interfacewellfired_peek_generator_buildreportgeneration_ibuildreportgenerator>` |:ref:`BuildReportGenerator<classwellfired_peek_application_unity_editor_unitydotpeekapplication_1acb61e436daab8a515e3aea93261e47fa>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+

Public Methods
---------------

+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |:ref:`UnityDotPeekApplication<classwellfired_peek_application_unity_editor_unitydotpeekapplication_1ab1ed7e7977b0a7ba141febb483d60297>` **(** BuildTarget buildTarget **)** |
+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|void |:ref:`Launch<classwellfired_peek_application_unity_editor_unitydotpeekapplication_1a3f9fb9b8e356fc18625ae5305bb88648>` **(** string applicationName, string applicationTitle **)** |
+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Public Static Methods
----------------------

+-------------+------------------------------------------------------------------------------------------------------------------------------------------+
|void |:ref:`OpenWindow<classwellfired_peek_application_unity_editor_unitydotpeekapplication_1a4b96a57da42e6b294ca3a1cad36116c3>` **(** **)** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_unity_editor_unitydotpeekapplication_1ae045608ffed14d0fbe5e945c1bb7dc43:

- IPlatformProvider **PlatformProvider** **{** get; set; **}**

.. _classwellfired_peek_application_unity_editor_unitydotpeekapplication_1a06a36c9cbe033b060317662610008aea:

- :ref:`IBuildReportStorage<interfacewellfired_peek_generator_storage_ibuildreportstorage>` **BuildReportStorage** **{** get; set; **}**

.. _classwellfired_peek_application_unity_editor_unitydotpeekapplication_1a4ddc9d77c17b50b02e54f3707af069e5:

- :ref:`IPlatformTools<interfacewellfired_peek_generator_platformtools_iplatformtools>` **PlatformTools** **{** get; set; **}**

.. _classwellfired_peek_application_unity_editor_unitydotpeekapplication_1acb61e436daab8a515e3aea93261e47fa:

- :ref:`IBuildReportGenerator<interfacewellfired_peek_generator_buildreportgeneration_ibuildreportgenerator>` **BuildReportGenerator** **{** get; set; **}**

.. _classwellfired_peek_application_unity_editor_unitydotpeekapplication_1ab1ed7e7977b0a7ba141febb483d60297:

- **UnityDotPeekApplication** **(** BuildTarget buildTarget **)**

.. _classwellfired_peek_application_unity_editor_unitydotpeekapplication_1a3f9fb9b8e356fc18625ae5305bb88648:

- void **Launch** **(** string applicationName, string applicationTitle **)**

.. _classwellfired_peek_application_unity_editor_unitydotpeekapplication_1a4b96a57da42e6b294ca3a1cad36116c3:

- void **OpenWindow** **(** **)**

44 changes: 44 additions & 0 deletions sphinx/source/api/classes/class_wellfired_peek_data_constants.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.. _classwellfired_peek_data_constants:

Constants
==========

**Namespace:** :ref:`WellFired.Peek<namespacewellfired_peek>`

Description
------------



Public Properties
------------------

+---------------+--------------------------------------------------------------------------------------------------------------+
|const string |:ref:`ApplicationName<classwellfired_peek_data_constants_1a522bb71ee9423b8d0850bb5998659f56>` |
+---------------+--------------------------------------------------------------------------------------------------------------+
|const string |:ref:`ApplicationTitle<classwellfired_peek_data_constants_1a8d01e8f5ed1d89d1d9a87a0211580ba4>` |
+---------------+--------------------------------------------------------------------------------------------------------------+
|const string |:ref:`BuildReportExtention<classwellfired_peek_data_constants_1af4888dde530d78f8c4cf6696ceeb289d>` |
+---------------+--------------------------------------------------------------------------------------------------------------+
|const string |:ref:`BuildReportToOpenOnLaunchKey<classwellfired_peek_data_constants_1aa11393c26e130c2a8910e701696e4588>` |
+---------------+--------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_data_constants_1a522bb71ee9423b8d0850bb5998659f56:

- const string **ApplicationName**

.. _classwellfired_peek_data_constants_1a8d01e8f5ed1d89d1d9a87a0211580ba4:

- const string **ApplicationTitle**

.. _classwellfired_peek_data_constants_1af4888dde530d78f8c4cf6696ceeb289d:

- const string **BuildReportExtention**

.. _classwellfired_peek_data_constants_1aa11393c26e130c2a8910e701696e4588:

- const string **BuildReportToOpenOnLaunchKey**

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _classwellfired_peek_data_filesizecomparer:

FileSizeComparer
=================

**Namespace:** :ref:`WellFired.Peek<namespacewellfired_peek>`

Description
------------



Public Methods
---------------

+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|int |:ref:`Compare<classwellfired_peek_data_filesizecomparer_1a03fcb640c8c661191d0be465f940dc11>` **(** :ref:`FileSize<structwellfired_peek_data_filesize>` x, :ref:`FileSize<structwellfired_peek_data_filesize>` y **)** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_data_filesizecomparer_1a03fcb640c8c661191d0be465f940dc11:

- int **Compare** **(** :ref:`FileSize<structwellfired_peek_data_filesize>` x, :ref:`FileSize<structwellfired_peek_data_filesize>` y **)**

26 changes: 26 additions & 0 deletions sphinx/source/api/classes/class_wellfired_peek_data_utility.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _classwellfired_peek_data_utility:

Utility
========

**Namespace:** :ref:`WellFired.Peek<namespacewellfired_peek>`

Description
------------



Public Static Methods
----------------------

+-------------+-------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`Nicify<classwellfired_peek_data_utility_1ac19af491b6c4b5edfc75815cdd3e5980>` **(** this string stringValue **)** |
+-------------+-------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_data_utility_1ac19af491b6c4b5edfc75815cdd3e5980:

- string **Nicify** **(** this string stringValue **)**

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _classwellfired_peek_generator_buildreportgeneration_buildreportgeneratorfactory:

BuildReportGeneratorFactory
============================

**Namespace:** :ref:`WellFired.Peek.Generator<namespacewellfired_peek_generator>`

Description
------------



Public Static Methods
----------------------

+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`IBuildReportGenerator<interfacewellfired_peek_generator_buildreportgeneration_ibuildreportgenerator>` |:ref:`GetBuildReportGenerator<classwellfired_peek_generator_buildreportgeneration_buildreportgeneratorfactory_1a669a17150e8151ccb6ef4a82bfd5e2ac>` **(** :ref:`IPlatformTools<interfacewellfired_peek_generator_platformtools_iplatformtools>` platformTools **)** |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_generator_buildreportgeneration_buildreportgeneratorfactory_1a669a17150e8151ccb6ef4a82bfd5e2ac:

- :ref:`IBuildReportGenerator<interfacewellfired_peek_generator_buildreportgeneration_ibuildreportgenerator>` **GetBuildReportGenerator** **(** :ref:`IPlatformTools<interfacewellfired_peek_generator_platformtools_iplatformtools>` platformTools **)**

0 comments on commit ec07f1d

Please sign in to comment.