Skip to content

Commit

Permalink
AutoBuildDocumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wellfiredbuildmachine committed Feb 21, 2018
1 parent 0095216 commit 1072de6
Show file tree
Hide file tree
Showing 7 changed files with 194 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _classwellfired_peek_application_vcs_git_git:

GIT
====

**Namespace:** :ref:`WellFired.Peek.Application.VCS<namespacewellfired_peek_application_vcs>`

**Implements:** :ref:`WellFired.Peek.Application.VCS.IVCS<interfacewellfired_peek_application_vcs_ivcs>`


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



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

+-------------+------------------------------------------------------------------------------------------------------------------+
|string |:ref:`GetCommitId<classwellfired_peek_application_vcs_git_git_1ad91aa4825b37b8d301046ab8001e7d7a>` **(** **)** |
+-------------+------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_vcs_git_git_1ad91aa4825b37b8d301046ab8001e7d7a:

- string **GetCommitId** **(** **)**

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

GITException
=============

**Namespace:** :ref:`WellFired.Peek.Application.VCS<namespacewellfired_peek_application_vcs>`

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



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

+------------------+-----------------------------------------------------------------------------------------------------------+
|override string |:ref:`Message<classwellfired_peek_application_vcs_git_gitexception_1a42dfcce74e4d6c8c07da71a2c17bdd9d>` |
+------------------+-----------------------------------------------------------------------------------------------------------+

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

+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| |:ref:`GITException<classwellfired_peek_application_vcs_git_gitexception_1ac7faa0c53b71be097562584e57349746>` **(** string command, string error **)** |
+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_vcs_git_gitexception_1a42dfcce74e4d6c8c07da71a2c17bdd9d:

- override string **Message**

.. _classwellfired_peek_application_vcs_git_gitexception_1ac7faa0c53b71be097562584e57349746:

- **GITException** **(** string command, string error **)**

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

GITUtils
=========

**Namespace:** :ref:`WellFired.Peek.Application.VCS<namespacewellfired_peek_application_vcs>`

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



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

+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|bool |:ref:`IsGITRepo<classwellfired_peek_application_vcs_git_gitutils_1a5ac68a8e65eee0d4e769cb7cc4356321>` **(** **)** |
+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|:ref:`RepositoryInfo<classwellfired_peek_application_vcs_git_gitutils_repositoryinfo>` |:ref:`GetRepositoryInfo<classwellfired_peek_application_vcs_git_gitutils_1a9892972ae1d8ecf16755892bb1f4f1b3>` **(** **)** |
+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_vcs_git_gitutils_1a5ac68a8e65eee0d4e769cb7cc4356321:

- bool **IsGITRepo** **(** **)**

.. _classwellfired_peek_application_vcs_git_gitutils_1a9892972ae1d8ecf16755892bb1f4f1b3:

- :ref:`RepositoryInfo<classwellfired_peek_application_vcs_git_gitutils_repositoryinfo>` **GetRepositoryInfo** **(** **)**

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

RepositoryInfo
===============

**Namespace:** :ref:`WellFired.Peek.Application.VCS.GIT<namespacewellfired_peek_application_vcs_git>`

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



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

+-------------------+-----------------------------------------------------------------------------------------------------------------------+
|string |:ref:`CommitID<classwellfired_peek_application_vcs_git_gitutils_repositoryinfo_1ad1d53e5f23214bf2c838f0d2b40a9ffb>` |
+-------------------+-----------------------------------------------------------------------------------------------------------------------+
|RepositoryStatus |:ref:`Status<classwellfired_peek_application_vcs_git_gitutils_repositoryinfo_1ae83606742521b3ec6dbd5d722b67848f>` |
+-------------------+-----------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_vcs_git_gitutils_repositoryinfo_1ad1d53e5f23214bf2c838f0d2b40a9ffb:

- string **CommitID**

.. _classwellfired_peek_application_vcs_git_gitutils_repositoryinfo_1ae83606742521b3ec6dbd5d722b67848f:

- RepositoryStatus **Status**

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

VCSUtils
=========

**Namespace:** :ref:`WellFired.Peek.Application<namespacewellfired_peek_application>`

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



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

+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|:ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>` |:ref:`GetRelevantVCS<classwellfired_peek_application_vcs_vcsutils_1a39772d7b5852845fba8558bb55ba4d60>` **(** **)** |
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_application_vcs_vcsutils_1a39772d7b5852845fba8558bb55ba4d60:

- :ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>` **GetRelevantVCS** **(** **)**

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

MsDurationConverter
====================

**Namespace:** :ref:`WellFired.Peek.View<namespacewellfired_peek_view>`

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



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

+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|object |:ref:`Convert<classwellfired_peek_view_converters_msdurationconverter_1a079bc8a57db1d8dc5700147c196d5dd7>` **(** object value, Type targetType, object parameter, CultureInfo culture **)** |
+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|object |:ref:`ConvertBack<classwellfired_peek_view_converters_msdurationconverter_1a350df0250db7054d423850ee8a7e7b6e>` **(** object value, Type targetType, object parameter, CultureInfo culture **)** |
+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Breakdown
----------

.. _classwellfired_peek_view_converters_msdurationconverter_1a079bc8a57db1d8dc5700147c196d5dd7:

- object **Convert** **(** object value, Type targetType, object parameter, CultureInfo culture **)**

.. _classwellfired_peek_view_converters_msdurationconverter_1a350df0250db7054d423850ee8a7e7b6e:

- object **ConvertBack** **(** object value, Type targetType, object parameter, CultureInfo culture **)**

Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Properties
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|string |:ref:`UnityVersion<classwellfired_peek_viewmodel_buildreport_overview_1adc78e2c57b21dc97d23a43521245baf8>` **{** get; set; **}** |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|long |:ref:`BuildDuration<classwellfired_peek_viewmodel_buildreport_overview_1a1aaae15af82dbd8c668034d832d35b2d>` **{** get; set; **}** |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`FileSize<structwellfired_peek_data_filesize>` |:ref:`BuildSize<classwellfired_peek_viewmodel_buildreport_overview_1a82ab2c9b0757de3bf688ac03857865ac>` **{** get; set; **}** |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|:ref:`FileSize<structwellfired_peek_data_filesize>` |:ref:`ResourceAssetsSize<classwellfired_peek_viewmodel_buildreport_overview_1a14668fb6fc04b9da3e69af50933c9015>` **{** get; set; **}** |
Expand Down Expand Up @@ -55,6 +57,10 @@ Breakdown

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

.. _classwellfired_peek_viewmodel_buildreport_overview_1a1aaae15af82dbd8c668034d832d35b2d:

- long **BuildDuration** **{** get; set; **}**

.. _classwellfired_peek_viewmodel_buildreport_overview_1a82ab2c9b0757de3bf688ac03857865ac:

- :ref:`FileSize<structwellfired_peek_data_filesize>` **BuildSize** **{** get; set; **}**
Expand Down

0 comments on commit 1072de6

Please sign in to comment.