AutoBuildDocumentation

WellFiredDevelopment · Feb 22, 2018 · 45631bc · 45631bc
1 parent 1072de6
commit 45631bc
Show file tree

Hide file tree

Showing 15 changed files with 292 additions and 109 deletions.
diff --git a/sphinx/source/api/classes/class_wellfired_peek_application_commandrunner.rst b/sphinx/source/api/classes/class_wellfired_peek_application_commandrunner.rst
diff --git a/sphinx/source/api/classes/class_wellfired_peek_application_vcs_git_gitutils.rst b/sphinx/source/api/classes/class_wellfired_peek_application_vcs_git_gitutils.rst
diff --git a/...pi/classes/class_wellfired_peek_application_vcs_git_gitutils_repositoryinfo.rst b/...pi/classes/class_wellfired_peek_application_vcs_git_gitutils_repositoryinfo.rst
diff --git a/...ellfired_peek_application_vcs_git_git.rst → ...ired_peek_application_vcs_git_vcs_git.rst b/...ellfired_peek_application_vcs_git_git.rst → ...ired_peek_application_vcs_git_vcs_git.rst
@@ -1,4 +1,4 @@
-.. _classwellfired_peek_application_vcs_git_git:
+.. _classwellfired_peek_application_vcs_git_vcs_git:
 
 GIT
 ====
@@ -16,14 +16,14 @@ Description
 Public Methods
 ---------------
 
-+-------------+------------------------------------------------------------------------------------------------------------------+
-|string       |:ref:`GetCommitId<classwellfired_peek_application_vcs_git_git_1ad91aa4825b37b8d301046ab8001e7d7a>` **(**  **)**   |
-+-------------+------------------------------------------------------------------------------------------------------------------+
++-------------+-----------------------------------------------------------------------------------------------------------------------+
+|string       |:ref:`GetCommitId<classwellfired_peek_application_vcs_git__vcs_git_1ae127a494d726c5c7c1ad6f21c1252a16>` **(**  **)**   |
++-------------+-----------------------------------------------------------------------------------------------------------------------+
 
 Breakdown
 ----------
 
-.. _classwellfired_peek_application_vcs_git_git_1ad91aa4825b37b8d301046ab8001e7d7a:
+.. _classwellfired_peek_application_vcs_git__vcs_git_1ae127a494d726c5c7c1ad6f21c1252a16:
 
 - string **GetCommitId** **(**  **)**
 
diff --git a/...peek_application_vcs_git_gitexception.rst → ..._application_vcs_git_vcs_gitexception.rst b/...peek_application_vcs_git_gitexception.rst → ..._application_vcs_git_vcs_gitexception.rst
@@ -1,4 +1,4 @@
-.. _classwellfired_peek_application_vcs_git_gitexception:
+.. _classwellfired_peek_application_vcs_git_vcs_gitexception:
 
 GITException
 =============
@@ -13,25 +13,25 @@ Description
 Public Properties
 ------------------
 
-+------------------+-----------------------------------------------------------------------------------------------------------+
-|override string   |:ref:`Message<classwellfired_peek_application_vcs_git_gitexception_1a42dfcce74e4d6c8c07da71a2c17bdd9d>`    |
-+------------------+-----------------------------------------------------------------------------------------------------------+
++------------------+----------------------------------------------------------------------------------------------------------------+
+|override string   |:ref:`Message<classwellfired_peek_application_vcs_git__vcs_gitexception_1a2708269b477dfa130300c0aa07428fc6>`    |
++------------------+----------------------------------------------------------------------------------------------------------------+
 
 Public Methods
 ---------------
 
-+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-|             |:ref:`GITException<classwellfired_peek_application_vcs_git_gitexception_1ac7faa0c53b71be097562584e57349746>` **(** string command, string error **)**   |
-+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
++-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|             |:ref:`GITException<classwellfired_peek_application_vcs_git__vcs_gitexception_1a5709ed7849564a83573eed446c2f6b4b>` **(** string command, string error **)**   |
++-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Breakdown
 ----------
 
-.. _classwellfired_peek_application_vcs_git_gitexception_1a42dfcce74e4d6c8c07da71a2c17bdd9d:
+.. _classwellfired_peek_application_vcs_git__vcs_gitexception_1a2708269b477dfa130300c0aa07428fc6:
 
 - override string **Message** 
 
-.. _classwellfired_peek_application_vcs_git_gitexception_1ac7faa0c53b71be097562584e57349746:
+.. _classwellfired_peek_application_vcs_git__vcs_gitexception_1a5709ed7849564a83573eed446c2f6b4b:
 
 -  **GITException** **(** string command, string error **)**
 
diff --git a/...ource/api/classes/class_wellfired_peek_application_vcs_git_vcs_gitinspector.rst b/...ource/api/classes/class_wellfired_peek_application_vcs_git_vcs_gitinspector.rst
@@ -0,0 +1,35 @@
+.. _classwellfired_peek_application_vcs_git_vcs_gitinspector:
+
+GITInspector
+=============
+
+**Namespace:** :ref:`WellFired.Peek.Application.VCS<namespacewellfired_peek_application_vcs>`
+
+**Implements:** :ref:`WellFired.Peek.Application.VCS.IVCSInspector<interfacewellfired_peek_application_vcs_ivcsinspector>`
+
+
+Description
+------------
+
+
+
+Public Methods
+---------------
+
++----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+|bool                                                                        |:ref:`IsRepository<classwellfired_peek_application_vcs_git__vcs_gitinspector_1a873d0c7df8efc1acc2a53a1148c8d59b>` **(** string location **)**        |
++----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+|:ref:`RepositoryInfo<classwellfired_peek_application_vcs_repositoryinfo>`   |:ref:`GetRepositoryInfo<classwellfired_peek_application_vcs_git__vcs_gitinspector_1ab3fccd0b65b174d1a9f49d1eddc552cc>` **(** string location **)**   |
++----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Breakdown
+----------
+
+.. _classwellfired_peek_application_vcs_git__vcs_gitinspector_1a873d0c7df8efc1acc2a53a1148c8d59b:
+
+- bool **IsRepository** **(** string location **)**
+
+.. _classwellfired_peek_application_vcs_git__vcs_gitinspector_1ab3fccd0b65b174d1a9f49d1eddc552cc:
+
+- :ref:`RepositoryInfo<classwellfired_peek_application_vcs_repositoryinfo>` **GetRepositoryInfo** **(** string location **)**
+
diff --git a/sphinx/source/api/classes/class_wellfired_peek_application_vcs_osenvironment.rst b/sphinx/source/api/classes/class_wellfired_peek_application_vcs_osenvironment.rst
@@ -0,0 +1,38 @@
+.. _classwellfired_peek_application_vcs_osenvironment:
+
+OSEnvironment
+==============
+
+**Namespace:** :ref:`WellFired.Peek.Application<namespacewellfired_peek_application>`
+
+Description
+------------
+
+
+
+Public Static Methods
+----------------------
+
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|string       |:ref:`RunCommand<classwellfired_peek_application_vcs_osenvironment_1a47cdb7c5cbab3e54d9cb85dcb614ca5f>` **(** string command, string args, out string retErrors **)**                           |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|string       |:ref:`RunCommand<classwellfired_peek_application_vcs_osenvironment_1a203f7bdc3d083498fcd344e51b128338>` **(** string command, string args, string workingDirectoy, out string retErrors **)**   |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|string       |:ref:`GetWorkingDirectory<classwellfired_peek_application_vcs_osenvironment_1aba51aac30b0d4772de930d1b8213b1b5>` **(**  **)**                                                                   |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Breakdown
+----------
+
+.. _classwellfired_peek_application_vcs_osenvironment_1a47cdb7c5cbab3e54d9cb85dcb614ca5f:
+
+- string **RunCommand** **(** string command, string args, out string retErrors **)**
+
+.. _classwellfired_peek_application_vcs_osenvironment_1a203f7bdc3d083498fcd344e51b128338:
+
+- string **RunCommand** **(** string command, string args, string workingDirectoy, out string retErrors **)**
+
+.. _classwellfired_peek_application_vcs_osenvironment_1aba51aac30b0d4772de930d1b8213b1b5:
+
+- string **GetWorkingDirectory** **(**  **)**
+
diff --git a/sphinx/source/api/classes/class_wellfired_peek_application_vcs_repositoryinfo.rst b/sphinx/source/api/classes/class_wellfired_peek_application_vcs_repositoryinfo.rst
@@ -0,0 +1,32 @@
+.. _classwellfired_peek_application_vcs_repositoryinfo:
+
+RepositoryInfo
+===============
+
+**Namespace:** :ref:`WellFired.Peek.Application<namespacewellfired_peek_application>`
+
+Description
+------------
+
+
+
+Public Properties
+------------------
+
++-------------------+----------------------------------------------------------------------------------------------------------+
+|string             |:ref:`CommitID<classwellfired_peek_application_vcs_repositoryinfo_1a81255c57aa6836d0f620a6196f68c807>`    |
++-------------------+----------------------------------------------------------------------------------------------------------+
+|RepositoryStatus   |:ref:`Status<classwellfired_peek_application_vcs_repositoryinfo_1afc5d782a3826595f2bd700c20b0b6fdd>`      |
++-------------------+----------------------------------------------------------------------------------------------------------+
+
+Breakdown
+----------
+
+.. _classwellfired_peek_application_vcs_repositoryinfo_1a81255c57aa6836d0f620a6196f68c807:
+
+- string **CommitID** 
+
+.. _classwellfired_peek_application_vcs_repositoryinfo_1afc5d782a3826595f2bd700c20b0b6fdd:
+
+- RepositoryStatus **Status** 
+
diff --git a/sphinx/source/api/classes/class_wellfired_peek_application_vcs_svn_vcs_svn.rst b/sphinx/source/api/classes/class_wellfired_peek_application_vcs_svn_vcs_svn.rst
@@ -0,0 +1,29 @@
+.. _classwellfired_peek_application_vcs_svn_vcs_svn:
+
+SVN
+====
+
+**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_svn__vcs_svn_1af7fd7495d034ebfc1dfb2a8f57919a22>` **(**  **)**   |
++-------------+-----------------------------------------------------------------------------------------------------------------------+
+
+Breakdown
+----------
+
+.. _classwellfired_peek_application_vcs_svn__vcs_svn_1af7fd7495d034ebfc1dfb2a8f57919a22:
+
+- string **GetCommitId** **(**  **)**
+
diff --git a/...ource/api/classes/class_wellfired_peek_application_vcs_svn_vcs_svnexception.rst b/...ource/api/classes/class_wellfired_peek_application_vcs_svn_vcs_svnexception.rst
@@ -0,0 +1,37 @@
+.. _classwellfired_peek_application_vcs_svn_vcs_svnexception:
+
+SVNException
+=============
+
+**Namespace:** :ref:`WellFired.Peek.Application.VCS<namespacewellfired_peek_application_vcs>`
+
+Description
+------------
+
+
+
+Public Properties
+------------------
+
++------------------+----------------------------------------------------------------------------------------------------------------+
+|override string   |:ref:`Message<classwellfired_peek_application_vcs_svn__vcs_svnexception_1a943c6e4627dc49963604c2c37ae146a8>`    |
++------------------+----------------------------------------------------------------------------------------------------------------+
+
+Public Methods
+---------------
+
++-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|             |:ref:`SVNException<classwellfired_peek_application_vcs_svn__vcs_svnexception_1a0fb894d9434ba5c912040593bb5d7b89>` **(** string command, string error **)**   |
++-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Breakdown
+----------
+
+.. _classwellfired_peek_application_vcs_svn__vcs_svnexception_1a943c6e4627dc49963604c2c37ae146a8:
+
+- override string **Message** 
+
+.. _classwellfired_peek_application_vcs_svn__vcs_svnexception_1a0fb894d9434ba5c912040593bb5d7b89:
+
+-  **SVNException** **(** string command, string error **)**
+
diff --git a/...ource/api/classes/class_wellfired_peek_application_vcs_svn_vcs_svninspector.rst b/...ource/api/classes/class_wellfired_peek_application_vcs_svn_vcs_svninspector.rst
@@ -0,0 +1,35 @@
+.. _classwellfired_peek_application_vcs_svn_vcs_svninspector:
+
+SVNInspector
+=============
+
+**Namespace:** :ref:`WellFired.Peek.Application.VCS<namespacewellfired_peek_application_vcs>`
+
+**Implements:** :ref:`WellFired.Peek.Application.VCS.IVCSInspector<interfacewellfired_peek_application_vcs_ivcsinspector>`
+
+
+Description
+------------
+
+
+
+Public Methods
+---------------
+
++----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+|bool                                                                        |:ref:`IsRepository<classwellfired_peek_application_vcs_svn__vcs_svninspector_1af5dcf85fcf4ba8545803f02fab9907ea>` **(** string location **)**        |
++----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+|:ref:`RepositoryInfo<classwellfired_peek_application_vcs_repositoryinfo>`   |:ref:`GetRepositoryInfo<classwellfired_peek_application_vcs_svn__vcs_svninspector_1aa2c71d4e59efeba8ed2283d8b6fee72a>` **(** string location **)**   |
++----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Breakdown
+----------
+
+.. _classwellfired_peek_application_vcs_svn__vcs_svninspector_1af5dcf85fcf4ba8545803f02fab9907ea:
+
+- bool **IsRepository** **(** string location **)**
+
+.. _classwellfired_peek_application_vcs_svn__vcs_svninspector_1aa2c71d4e59efeba8ed2283d8b6fee72a:
+
+- :ref:`RepositoryInfo<classwellfired_peek_application_vcs_repositoryinfo>` **GetRepositoryInfo** **(** string location **)**
+
diff --git a/sphinx/source/api/classes/class_wellfired_peek_application_vcs_vcsutils.rst b/sphinx/source/api/classes/class_wellfired_peek_application_vcs_vcsutils.rst
@@ -13,14 +13,14 @@ Description
 Public Static Methods
 ----------------------
 
-+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
-|:ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>`   |:ref:`GetRelevantVCS<classwellfired_peek_application_vcs_vcsutils_1a39772d7b5852845fba8558bb55ba4d60>` **(**  **)**   |
-+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
+|:ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>`   |:ref:`GetVCSInUse<classwellfired_peek_application_vcs_vcsutils_1adb78d4f52d86d98e72c2966141208bf3>` **(**  **)**   |
++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
 
 Breakdown
 ----------
 
-.. _classwellfired_peek_application_vcs_vcsutils_1a39772d7b5852845fba8558bb55ba4d60:
+.. _classwellfired_peek_application_vcs_vcsutils_1adb78d4f52d86d98e72c2966141208bf3:
 
-- :ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>` **GetRelevantVCS** **(**  **)**
+- :ref:`IVCS<interfacewellfired_peek_application_vcs_ivcs>` **GetVCSInUse** **(**  **)**