Skip to content

Commit

Permalink
Added COM documentation; closes rubberduck-vba#297
Browse files Browse the repository at this point in the history
  • Loading branch information
rubberduck203 committed Mar 8, 2015
1 parent 46b7e2e commit e7d5cdd
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions RetailCoder.VBE/Interop/ISourceControlProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using System.Threading.Tasks;
using Rubberduck.SourceControl;
using System.Runtime.InteropServices;
using System.ComponentModel;

namespace Rubberduck.Interop
{
Expand All @@ -23,51 +24,67 @@ public interface ISourceControlProvider
IEnumerable Branches { get; }

[DispId(3)]
[Description("Clones a remote repository to the local file system.")]
IRepository Clone(string remotePathOrUrl, string workingDirectory);

[DispId(4)]
[Description("Creates a new repository in/from the specified directory.")]
IRepository Init(string directory, bool bare = false);

[DispId(5)]
[Description("Creates a new repository and sets the CurrentRepository property from the VBProject passed to the ISourceControlProvider upon creation.")]
IRepository InitVBAProject(string directory);

[DispId(6)]
[Description("Pushes commits in the CurrentBranch of the Local repo to the Remote.")]
void Push();

[DispId(7)]
[Description("Fetches the specified remote for tracking.\n If argument is not supplied, returns a default remote defined by implementation.")]
void Fetch([Optional] string remoteName);

[DispId(8)]
[Description("Fetches the currently tracking remote and merges it into the CurrentBranch.")]
void Pull();

[DispId(9)]
[Description("Stages all modified files and commits to CurrentBranch.")]
void Commit(string message);

[DispId(10)]
[Description("Merges the source branch into the desitnation.")]
void Merge(string sourceBranch, string destinationBranch);

[DispId(11)]
[Description("Checks out the target branch.")]
void Checkout(string branch);

[DispId(12)]
[Description("Creates and checks out a new branch.")]
void CreateBranch(string branch);

[DispId(18)]
[Description("Deletes the specified branch from the local repository.")]
void DeleteBranch(string branch);

[DispId(13)]
[Description("Undoes uncommitted changes to a particular file.")]
void Undo(string filePath);

[DispId(14)]
[Description("Reverts entire branch to the last commit.")]
void Revert();

[DispId(15)]
[Description("Adds untracked file to repository.")]
void AddFile(string filePath);

[DispId(16)]
[Description("Removes file from tracking.")]
void RemoveFile(string filePath);

[DispId(17)]
[Description("Returns a collection of file status entries.\n Semantically the same as calling $git status.")]
IEnumerable Status();
}
}

0 comments on commit e7d5cdd

Please sign in to comment.