improve docs

NARKOZ · Mar 9, 2015 · f6532d5 · f6532d5
1 parent 468c10a
commit f6532d5
Show file tree

Hide file tree

Showing 15 changed files with 34 additions and 3 deletions.
diff --git a/lib/gitlab/cli.rb b/lib/gitlab/cli.rb
@@ -6,11 +6,27 @@
 class Gitlab::CLI
   extend Helpers
 
+  # Start a new CLI session.
+  #
+  # @example
+  #   Gitlab::CLI.start(['help'])
+  #   Gitlab::CLI.start(['help', 'issues'])
+  #
+  # @param [Array] args The command and it's optional arguments.
   def self.start(args)
     command = args.shift.strip rescue 'help'
     run(command, args)
   end
 
+  # Processes a CLI command and outputs a result to the stream (stdout).
+  #
+  # @example
+  #   Gitlab::CLI.run('help')
+  #   Gitlab::CLI.run('help', ['issues'])
+  #
+  # @param [String] cmd The name of a command.
+  # @param [Array] args The optional arguments for a command.
+  # @return [nil]
   def self.run(cmd, args=[])
     case cmd
     when 'help'

diff --git a/lib/gitlab/client.rb b/lib/gitlab/client.rb
@@ -6,6 +6,7 @@ class Client < API
     include Branches
     include Groups
     include Issues
+    include Labels
     include MergeRequests
     include Milestones
     include Notes
@@ -15,6 +16,5 @@ class Client < API
     include Snippets
     include SystemHooks
     include Users
-    include Labels
   end
 end
diff --git a/lib/gitlab/client/branches.rb b/lib/gitlab/client/branches.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to repositories.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/branches.md
   module Branches
     # Gets a list of project repositiory branches.
     #
@@ -28,7 +29,7 @@ def branches(project, options={})
     def branch(project, branch)
       get("/projects/#{project}/repository/branches/#{branch}")
     end
-    
+
     alias_method :repo_branch, :branch
 
     # Protects a repository branch.

diff --git a/lib/gitlab/client/groups.rb b/lib/gitlab/client/groups.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to groups.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/groups.md
   module Groups
     # Gets a list of groups.
     #

diff --git a/lib/gitlab/client/issues.rb b/lib/gitlab/client/issues.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to issues.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md
   module Issues
     # Gets a list of user's issues.
     # Will return a list of project's issues if project ID passed.

diff --git a/lib/gitlab/client/labels.rb b/lib/gitlab/client/labels.rb
@@ -1,4 +1,6 @@
 class Gitlab::Client
+  # Defines methods related to labels.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/labels.md
   module Labels
     # Gets a list of project's labels.
     #

diff --git a/lib/gitlab/client/merge_requests.rb b/lib/gitlab/client/merge_requests.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to merge requests.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/merge_requests.md
   module MergeRequests
     # Gets a list of project merge requests.
     #

diff --git a/lib/gitlab/client/milestones.rb b/lib/gitlab/client/milestones.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to milestones.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/milestones.md
   module Milestones
     # Gets a list of project's milestones.
     #
@@ -26,7 +27,7 @@ def milestones(project, options={})
     def milestone(project, id)
       get("/projects/#{project}/milestones/#{id}")
     end
-    
+
     # Gets the issues of a given milestone.
     #
     # @example

diff --git a/lib/gitlab/client/notes.rb b/lib/gitlab/client/notes.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to notes.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/notes.md
   module Notes
     # Gets a list of projects notes.
     #

diff --git a/lib/gitlab/client/projects.rb b/lib/gitlab/client/projects.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to projects.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md
   module Projects
     # Gets a list of projects owned by the authenticated user.
     #

diff --git a/lib/gitlab/client/repositories.rb b/lib/gitlab/client/repositories.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to repositories.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/repositories.md
   module Repositories
     # Gets a list of project repository tags.
     #

diff --git a/lib/gitlab/client/repository_files.rb b/lib/gitlab/client/repository_files.rb
@@ -2,6 +2,7 @@
 
 class Gitlab::Client
   # Defines methods related to repository files.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/repository_files.md
   module RepositoryFiles
     # Creates a new repository file.
     #

diff --git a/lib/gitlab/client/snippets.rb b/lib/gitlab/client/snippets.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to snippets.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/project_snippets.md
   module Snippets
     # Gets a list of project's snippets.
     #

diff --git a/lib/gitlab/client/system_hooks.rb b/lib/gitlab/client/system_hooks.rb
@@ -1,5 +1,6 @@
 class Gitlab::Client
   # Defines methods related to system hooks.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/system_hooks.md
   module SystemHooks
     # Gets a list of system hooks.
     #

diff --git a/lib/gitlab/client/users.rb b/lib/gitlab/client/users.rb
@@ -1,5 +1,7 @@
 class Gitlab::Client
   # Defines methods related to users.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/users.md
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/session.md
   module Users
     # Gets a list of users.
     #