Skip to content

Commit

Permalink
AutoBuildDocumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wellfiredbuildmachine committed Dec 29, 2017
1 parent afa2964 commit 8d87bbb
Show file tree
Hide file tree
Showing 25 changed files with 679 additions and 277 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Description
Public Methods
---------------

+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |:ref:`BuildReportSerializer<classwellfired_peek_generator_storage_buildreportserializer_1a272e4adf47054f8ec333ceff7798a28e>` **(** ISerializer serializer **)** |
+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|bool |:ref:`Serialize<classwellfired_peek_generator_storage_buildreportserializer_1adc6e1909f43653a37234093301359d5f>` **(** :ref:`BuildReport<classwellfired_peek_model_buildreport>` buildReport, out string serializedReport **)** |
+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand All @@ -25,6 +27,10 @@ Public Methods
Breakdown
----------

.. _classwellfired_peek_generator_storage_buildreportserializer_1a272e4adf47054f8ec333ceff7798a28e:

- **BuildReportSerializer** **(** ISerializer serializer **)**

.. _classwellfired_peek_generator_storage_buildreportserializer_1adc6e1909f43653a37234093301359d5f:

- bool **Serialize** **(** :ref:`BuildReport<classwellfired_peek_model_buildreport>` buildReport, out string serializedReport **)**
Expand Down
14 changes: 7 additions & 7 deletions sphinx/source/api/classes/class_wellfired_peek_model_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ Public Properties
|bool |:ref:`AutomaticallyShowReportAfterBuild<classwellfired_peek_model_options_1a4c1a71f1fbac17ddad54df735e291468>` |
+---------------+------------------------------------------------------------------------------------------------------------------+

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

+----------------------------------------------------+------------------------------------------------------------------------------------------------+
|:ref:`Options<classwellfired_peek_model_options>` |:ref:`New<classwellfired_peek_model_options_1ac9e5fc6b534472e5e65b9ed9e8190e20>` **(** **)** |
+----------------------------------------------------+------------------------------------------------------------------------------------------------+
+-------------+----------------------------------------------------------------------------------------------------+
| |:ref:`Options<classwellfired_peek_model_options_1acb007cfa380ecd7cc446f9571cfb6a0b>` **(** **)** |
+-------------+----------------------------------------------------------------------------------------------------+

Breakdown
----------
Expand All @@ -54,7 +54,7 @@ Breakdown

- bool **AutomaticallyShowReportAfterBuild**

.. _classwellfired_peek_model_options_1ac9e5fc6b534472e5e65b9ed9e8190e20:
.. _classwellfired_peek_model_options_1acb007cfa380ecd7cc446f9571cfb6a0b:

- :ref:`Options<classwellfired_peek_model_options>` **New** **(** **)**
- **Options** **(** **)**

Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ Public Properties
|string |:ref:`RelativeBuildReportPath<classwellfired_peek_model_projectinfo_1af1721efad6fc12155c480cf720d65735>` |
+---------------+------------------------------------------------------------------------------------------------------------+

public-static-attrib
---------------------
Public Methods
---------------

+------------------------------------------------------------+----------------------------------------------------------------------------------------+
|:ref:`ProjectInfo<classwellfired_peek_model_projectinfo>` |:ref:`New<classwellfired_peek_model_projectinfo_1a2f5c12c1725b335e700bb5e38bdfbf49>` |
+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+-------------+------------------------------------------------------------------------------------------------------------+
| |:ref:`ProjectInfo<classwellfired_peek_model_projectinfo_1a6d15f1c0caa3d877e5b1705580fa2687>` **(** **)** |
+-------------+------------------------------------------------------------------------------------------------------------+

Breakdown
----------
Expand All @@ -43,7 +43,7 @@ Breakdown

- string **RelativeBuildReportPath**

.. _classwellfired_peek_model_projectinfo_1a2f5c12c1725b335e700bb5e38bdfbf49:
.. _classwellfired_peek_model_projectinfo_1a6d15f1c0caa3d877e5b1705580fa2687:

- :ref:`ProjectInfo<classwellfired_peek_model_projectinfo>` **New**
- **ProjectInfo** **(** **)**

Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,20 @@ Description
Public Methods
---------------

+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |:ref:`BuildReportsLister<classwellfired_peek_viewmodel_buildreportslister_1a1e1844d254f1df10eefab2f1d1a5bbaa>` **(** IPlatformProvider platformProvider, :ref:`IBuildReportStorage<interfacewellfired_peek_generator_storage_ibuildreportstorage>` buildReportStorage, :ref:`IBuildReportsListerClient<interfacewellfired_peek_viewmodel_ibuildreportslisterclient>` client **)** |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|FolderAccessError |:ref:`TrySetNewPath<classwellfired_peek_viewmodel_buildreportslister_1a612cf51226fb97312e6d60e380a0ccdb>` **(** string currentPath, string newPath, out string finalPath **)** |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|void |:ref:`OpenReportToOpenOnLaunch<classwellfired_peek_viewmodel_buildreportslister_1aca59caa1dfd68b1d56dc9c735d0961b3>` **(** **)** |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |:ref:`BuildReportsLister<classwellfired_peek_viewmodel_buildreportslister_1ac15d5c47f94104912aadd734196840ae>` **(** string projectID, string projectPath, :ref:`IBuildReportStorage<interfacewellfired_peek_generator_storage_ibuildreportstorage>` buildReportStorage, :ref:`IBuildReportsListerClient<interfacewellfired_peek_viewmodel_ibuildreportslisterclient>` client **)** |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|FolderAccessError |:ref:`TrySetNewPath<classwellfired_peek_viewmodel_buildreportslister_1a612cf51226fb97312e6d60e380a0ccdb>` **(** string currentPath, string newPath, out string finalPath **)** |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_viewmodel_buildreportslister_1a1e1844d254f1df10eefab2f1d1a5bbaa:
.. _classwellfired_peek_viewmodel_buildreportslister_1ac15d5c47f94104912aadd734196840ae:

- **BuildReportsLister** **(** IPlatformProvider platformProvider, :ref:`IBuildReportStorage<interfacewellfired_peek_generator_storage_ibuildreportstorage>` buildReportStorage, :ref:`IBuildReportsListerClient<interfacewellfired_peek_viewmodel_ibuildreportslisterclient>` client **)**
- **BuildReportsLister** **(** string projectID, string projectPath, :ref:`IBuildReportStorage<interfacewellfired_peek_generator_storage_ibuildreportstorage>` buildReportStorage, :ref:`IBuildReportsListerClient<interfacewellfired_peek_viewmodel_ibuildreportslisterclient>` client **)**

.. _classwellfired_peek_viewmodel_buildreportslister_1a612cf51226fb97312e6d60e380a0ccdb:

- FolderAccessError **TrySetNewPath** **(** string currentPath, string newPath, out string finalPath **)**

.. _classwellfired_peek_viewmodel_buildreportslister_1aca59caa1dfd68b1d56dc9c735d0961b3:

- void **OpenReportToOpenOnLaunch** **(** **)**

Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. _classwellfired_peek_viewmodel_datastorage_optionsproxy:

OptionsProxy
=============

**Namespace:** :ref:`WellFired.Peek.ViewModel<namespacewellfired_peek_viewmodel>`

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



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

+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`BuildReportPath<classwellfired_peek_viewmodel_datastorage_optionsproxy_1a3266ae822dbd3f261ad37b9094b196c0>` **{** get; set; **}** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|bool |:ref:`AutomaticallyShowReportAfterBuild<classwellfired_peek_viewmodel_datastorage_optionsproxy_1a47730217d1e790769dbc4098f16983f3>` **{** get; set; **}** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_viewmodel_datastorage_optionsproxy_1a3266ae822dbd3f261ad37b9094b196c0:

- string **BuildReportPath** **{** get; set; **}**

.. _classwellfired_peek_viewmodel_datastorage_optionsproxy_1a47730217d1e790769dbc4098f16983f3:

- bool **AutomaticallyShowReportAfterBuild** **{** get; set; **}**

Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.. _classwellfired_peek_viewmodel_datastorage_personaldataversionproxy:

PersonalDataVersionProxy
=========================

**Namespace:** :ref:`WellFired.Peek.ViewModel<namespacewellfired_peek_viewmodel>`

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



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

+-------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|int |:ref:`VersionNo<classwellfired_peek_viewmodel_datastorage_personaldataversionproxy_1ae8edae8bac460591222ee42d603fb590>` **{** get; set; **}** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------+

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

+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |:ref:`PersonalDataVersionProxy<classwellfired_peek_viewmodel_datastorage_personaldataversionproxy_1a2fc6f486956ca77d1dc4e1ef1d23e556>` **(** string guid **)** |
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|override void |:ref:`InjectData<classwellfired_peek_viewmodel_datastorage_personaldataversionproxy_1af47918f9beee47cb238fb1726ccee7d1>` **(** string data **)** |
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_viewmodel_datastorage_personaldataversionproxy_1ae8edae8bac460591222ee42d603fb590:

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

.. _classwellfired_peek_viewmodel_datastorage_personaldataversionproxy_1a2fc6f486956ca77d1dc4e1ef1d23e556:

- **PersonalDataVersionProxy** **(** string guid **)**

.. _classwellfired_peek_viewmodel_datastorage_personaldataversionproxy_1af47918f9beee47cb238fb1726ccee7d1:

- override void **InjectData** **(** string data **)**

0 comments on commit 8d87bbb

Please sign in to comment.