Skip to content

Commit

Permalink
AutoBuildDocumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wellfiredbuildmachine committed Feb 22, 2018
1 parent 0c641ed commit 7e82d37
Show file tree
Hide file tree
Showing 9 changed files with 182 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,11 @@ Description
Public Properties
------------------

+---------------+------------------------------------------------------------------------------------------------------------+
|const string |:ref:`ProjectInfoKey<classwellfired_peek_model_projectinfo_1ad6791f2441a21f81defa663d1e8a0895>` |
+---------------+------------------------------------------------------------------------------------------------------------+
|string |:ref:`GUID<classwellfired_peek_model_projectinfo_1a152624669a8c3e54674eeb81a40041ec>` |
+---------------+------------------------------------------------------------------------------------------------------------+
|string |:ref:`RelativeBuildReportPath<classwellfired_peek_model_projectinfo_1af1721efad6fc12155c480cf720d65735>` |
+---------------+------------------------------------------------------------------------------------------------------------+
+---------------+---------------------------------------------------------------------------------------------------+
|const string |:ref:`ProjectInfoKey<classwellfired_peek_model_projectinfo_1ad6791f2441a21f81defa663d1e8a0895>` |
+---------------+---------------------------------------------------------------------------------------------------+
|string |:ref:`GUID<classwellfired_peek_model_projectinfo_1a152624669a8c3e54674eeb81a40041ec>` |
+---------------+---------------------------------------------------------------------------------------------------+

Public Methods
---------------
Expand All @@ -39,10 +37,6 @@ Breakdown

- string **GUID**

.. _classwellfired_peek_model_projectinfo_1af1721efad6fc12155c480cf720d65735:

- string **RelativeBuildReportPath**

.. _classwellfired_peek_model_projectinfo_1a6d15f1c0caa3d877e5b1705580fa2687:

- **ProjectInfo** **(** **)**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. _classwellfired_peek_model_teamoptions:

TeamOptions
============

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

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



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

+---------------+------------------------------------------------------------------------------------------------------------+
|const string |:ref:`TeamOptionsKey<classwellfired_peek_model_teamoptions_1a1e1d9b094be41b7c18eecf75ad3358ad>` |
+---------------+------------------------------------------------------------------------------------------------------------+
|string |:ref:`RelativeBuildReportPath<classwellfired_peek_model_teamoptions_1af8ee6476b869778e0087521d45f50148>` |
+---------------+------------------------------------------------------------------------------------------------------------+
|bool |:ref:`TrackVCSVersion<classwellfired_peek_model_teamoptions_1adffa8f7988ac467f1637233b39138503>` |
+---------------+------------------------------------------------------------------------------------------------------------+

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

+-------------+------------------------------------------------------------------------------------------------------------+
| |:ref:`TeamOptions<classwellfired_peek_model_teamoptions_1aa8772011c89f4f57955e8994b5cad7fd>` **(** **)** |
+-------------+------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_model_teamoptions_1a1e1d9b094be41b7c18eecf75ad3358ad:

- const string **TeamOptionsKey**

.. _classwellfired_peek_model_teamoptions_1af8ee6476b869778e0087521d45f50148:

- string **RelativeBuildReportPath**

.. _classwellfired_peek_model_teamoptions_1adffa8f7988ac467f1637233b39138503:

- bool **TrackVCSVersion**

.. _classwellfired_peek_model_teamoptions_1aa8772011c89f4f57955e8994b5cad7fd:

- **TeamOptions** **(** **)**

Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@ Description
Properties
-----------

+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`GUID<classwellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy_1a477ab0de10419cea251b0dad93ba4de7>` **{** get; set; **}** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`RelativeBuildReportPath<classwellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy_1aa58b69bef253a4ec1c5359c29ca97969>` **{** get; set; **}** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`GUID<classwellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy_1a477ab0de10419cea251b0dad93ba4de7>` **{** get; set; **}** |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------
Expand All @@ -26,7 +24,3 @@ Breakdown

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

.. _classwellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy_1aa58b69bef253a4ec1c5359c29ca97969:

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

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

TeamOptionsProxy
=================

**Namespace:** :ref:`WellFired.Peek.ViewModel.DataStorage<namespacewellfired_peek_viewmodel_datastorage>`

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



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

+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`RelativeBuildReportPath<classwellfired_peek_viewmodel_datastorage_dataproxies_teamoptionsproxy_1aaf7b81b115c467bd292250cb87bc65ea>` **{** get; set; **}** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|bool |:ref:`TrackVCSVersion<classwellfired_peek_viewmodel_datastorage_dataproxies_teamoptionsproxy_1aed3356abb5360fb2fcc1661aec674e65>` **{** get; set; **}** |
+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_viewmodel_datastorage_dataproxies_teamoptionsproxy_1aaf7b81b115c467bd292250cb87bc65ea:

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

.. _classwellfired_peek_viewmodel_datastorage_dataproxies_teamoptionsproxy_1aed3356abb5360fb2fcc1661aec674e65:

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

Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Properties
+--------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`OptionsProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_optionsproxy>` |:ref:`Options<classwellfired_peek_viewmodel_datastorage_storage_1ae1d687bf184d2f1f239d174410bc5c4b>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`TeamOptionsProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_teamoptionsproxy>` |:ref:`TeamOptions<classwellfired_peek_viewmodel_datastorage_storage_1aca4a39abe43789ef386d57a67dfcb3e8>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`ProjectInfoProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy>` |:ref:`ProjectInfo<classwellfired_peek_viewmodel_datastorage_storage_1a5bbbc805a7a82899d6aaf3f48ea68dad>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`BuildReportsRootedPath<classwellfired_peek_viewmodel_datastorage_storage_1ad471432fd7e8190dc86803769ddf9abf>` **{** get; set; **}** |
Expand All @@ -40,6 +42,10 @@ Breakdown

- :ref:`OptionsProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_optionsproxy>` **Options** **{** get; set; **}**

.. _classwellfired_peek_viewmodel_datastorage_storage_1aca4a39abe43789ef386d57a67dfcb3e8:

- :ref:`TeamOptionsProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_teamoptionsproxy>` **TeamOptions** **{** get; set; **}**

.. _classwellfired_peek_viewmodel_datastorage_storage_1a5bbbc805a7a82899d6aaf3f48ea68dad:

- :ref:`ProjectInfoProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy>` **ProjectInfo** **{** get; set; **}**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.. _classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3:

TeamDataVersionUpdater3
========================

**Namespace:** :ref:`WellFired.Peek.ViewModel.DataStorage<namespacewellfired_peek_viewmodel_datastorage>`

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



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

+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|override int |:ref:`VersionNo<classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_1a825aeab284240e4de6870a1c5c19ca58>` |
+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

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

+----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |:ref:`TeamDataVersionUpdater3<classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_1a20b2cc6ba3316ab5a7468a3b82ba571d>` **(** ISerializer serializer, IDataStorageService storageService **)** |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|override void |:ref:`UpdatePreviousVersion<classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_1ae58f58c22108a39fda74e52e7a5e70f2>` **(** **)** |
+----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_1a825aeab284240e4de6870a1c5c19ca58:

- override int **VersionNo**

.. _classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_1a20b2cc6ba3316ab5a7468a3b82ba571d:

- **TeamDataVersionUpdater3** **(** ISerializer serializer, IDataStorageService storageService **)**

.. _classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_1ae58f58c22108a39fda74e52e7a5e70f2:

- override void **UpdatePreviousVersion** **(** **)**

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

TeamOptions
============

**Namespace:** :ref:`WellFired.Peek.ViewModel.DataStorage.TeamDataVersionUpdaters<namespacewellfired_peek_viewmodel_datastorage_teamdataversionupdaters>`

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



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

+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|JRaw |:ref:`RelativeBuildReportPath<classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_teamoptions_1a49ba2fd2b80683360d93c1f82734412a>` |
+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|JRaw |:ref:`TrackVCSVersion<classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_teamoptions_1a9c770f3840b8b25e570a3a8df13bc4fa>` |
+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_teamoptions_1a49ba2fd2b80683360d93c1f82734412a:

- JRaw **RelativeBuildReportPath**

.. _classwellfired_peek_viewmodel_datastorage_teamdataversionupdaters_teamdataversionupdater3_teamoptions_1a9c770f3840b8b25e570a3a8df13bc4fa:

- JRaw **TrackVCSVersion**

Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Properties
+-------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|bool |:ref:`AutomaticallyShowReportAfterBuild<classwellfired_peek_viewmodel_settings_1a75722108f47f6ca2cb0952fa1afcbf38>` **{** get; set; **}** |
+-------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|bool |:ref:`TrackVCSVersion<classwellfired_peek_viewmodel_settings_1ab3d313e1f18b222263c63c7073baebf5>` **{** get; set; **}** |
+-------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`DisplayedBuildReportPath<classwellfired_peek_viewmodel_settings_1ade217231d9addcf23ce5e343bf592f71>` **{** get; set; **}** |
+-------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`BuildReportPath<classwellfired_peek_viewmodel_settings_1ad5fa37c2ca3bd73b9adab17b322463ff>` **{** get; set; **}** |
Expand Down Expand Up @@ -60,6 +62,10 @@ Breakdown

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

.. _classwellfired_peek_viewmodel_settings_1ab3d313e1f18b222263c63c7073baebf5:

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

.. _classwellfired_peek_viewmodel_settings_1ade217231d9addcf23ce5e343bf592f71:

- string **DisplayedBuildReportPath** **{** get; set; **}**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Properties
+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`OptionsProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_optionsproxy>` |:ref:`Options<interfacewellfired_peek_viewmodel_datastorage_istorage_1ac70dd46d04ae94e5d1eda5332c9e9dab>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`TeamOptionsProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_teamoptionsproxy>` |:ref:`TeamOptions<interfacewellfired_peek_viewmodel_datastorage_istorage_1aba01e7f554a788e6a3cd5c53a87afc7f>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`ProjectInfoProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy>` |:ref:`ProjectInfo<interfacewellfired_peek_viewmodel_datastorage_istorage_1a1c596c79f67d59b300372650f20b0b4c>` **{** get; set; **}** |
+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`BuildReportsRootedPath<interfacewellfired_peek_viewmodel_datastorage_istorage_1acb4c31de0d95b7b679d17998e6c025a0>` **{** get; set; **}** |
Expand All @@ -37,6 +39,10 @@ Breakdown

- :ref:`OptionsProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_optionsproxy>` **Options** **{** get; set; **}**

.. _interfacewellfired_peek_viewmodel_datastorage_istorage_1aba01e7f554a788e6a3cd5c53a87afc7f:

- :ref:`TeamOptionsProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_teamoptionsproxy>` **TeamOptions** **{** get; set; **}**

.. _interfacewellfired_peek_viewmodel_datastorage_istorage_1a1c596c79f67d59b300372650f20b0b4c:

- :ref:`ProjectInfoProxy<classwellfired_peek_viewmodel_datastorage_dataproxies_projectinfoproxy>` **ProjectInfo** **{** get; set; **}**
Expand Down

0 comments on commit 7e82d37

Please sign in to comment.