Skip to content
Snippets Groups Projects
Commit bd4ab21c authored by Douwe Maan's avatar Douwe Maan
Browse files

Fix code docs

parent 4a0ebccf
No related branches found
No related tags found
No related merge requests found
Loading
@@ -13,8 +13,7 @@
Loading
@@ -13,8 +13,7 @@
# range.to_param # => {from: "f3f856029bc5f966c5a7ee24cf7efefdd20e6019^", to: "e86e1013709735be5bb767e2b228930c543f25ae"} # range.to_param # => {from: "f3f856029bc5f966c5a7ee24cf7efefdd20e6019^", to: "e86e1013709735be5bb767e2b228930c543f25ae"}
# range.to_s # => "f3f85602..e86e1013" # range.to_s # => "f3f85602..e86e1013"
# #
# # Assuming `project` is a Project with a repository containing both commits: # # Assuming the specified project has a repository containing both commits:
# range.project = project
# range.valid_commits? # => true # range.valid_commits? # => true
# #
class CommitRange class CommitRange
Loading
@@ -68,7 +67,7 @@ class CommitRange
Loading
@@ -68,7 +67,7 @@ class CommitRange
   
range_string.strip! range_string.strip!
   
unless range_string.match(/\A#{PATTERN}\z/) unless range_string =~ /\A#{PATTERN}\z/
raise ArgumentError, "invalid CommitRange string format: #{range_string}" raise ArgumentError, "invalid CommitRange string format: #{range_string}"
end end
   
Loading
@@ -123,8 +122,6 @@ class CommitRange
Loading
@@ -123,8 +122,6 @@ class CommitRange
   
# Check if both the starting and ending commit IDs exist in a project's # Check if both the starting and ending commit IDs exist in a project's
# repository # repository
#
# project - An optional Project to check (default: `project`)
def valid_commits? def valid_commits?
commit_start.present? && commit_end.present? commit_start.present? && commit_end.present?
end end
Loading
Loading
Loading
@@ -2,8 +2,8 @@ require 'gitlab/markdown'
Loading
@@ -2,8 +2,8 @@ require 'gitlab/markdown'
   
module Gitlab module Gitlab
module Markdown module Markdown
# Issues, Snippets and Merge Requests shares similar functionality in refernce filtering. # Issues, Snippets, Merge Requests, Commits and Commit Ranges share
# All this functionality moved to this class # similar functionality in refernce filtering.
class AbstractReferenceFilter < ReferenceFilter class AbstractReferenceFilter < ReferenceFilter
include CrossProjectReference include CrossProjectReference
   
Loading
@@ -26,16 +26,15 @@ module Gitlab
Loading
@@ -26,16 +26,15 @@ module Gitlab
   
# Public: Find references in text (like `!123` for merge requests) # Public: Find references in text (like `!123` for merge requests)
# #
# AnyReferenceFilter.references_in(text) do |match, object| # AnyReferenceFilter.references_in(text) do |match, id, project_ref, matches|
# "<a href=...>PREFIX#{object}</a>" # object = find_object(project_ref, id)
# "<a href=...>#{object.to_reference}</a>"
# end # end
# #
# PREFIX - symbol that detects reference (like ! for merge requests)
# object - reference object (snippet, merget request etc)
# text - String text to search. # text - String text to search.
# #
# Yields the String match, the Integer referenced object ID, and an optional String # Yields the String match, the Integer referenced object ID, an optional String
# of the external project reference. # of the external project reference, and all of the matchdata.
# #
# Returns a String replaced with the return of the block. # Returns a String replaced with the return of the block.
def self.references_in(text) def self.references_in(text)
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment