Method: YARD::DocstringParser#create_tag

Defined in:
lib/yard/docstring_parser.rb

#create_tag(tag_name, tag_buf = '') ⇒ Tags::Tag, Tags::RefTag

Creates a tag from the tag factory.

To add an already created tag object, append it to #tags.

Parameters:

  • the tag name

  • (defaults to: '')

    the text attached to the tag with newlines removed.

Returns:

  • a tag

Since:

  • 0.8.0



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/yard/docstring_parser.rb', line 208

def create_tag(tag_name, tag_buf = '')
  if tag_buf =~ /\A\s*(?:(\S+)\s+)?\(\s*see\s+(\S+)\s*\)\s*\Z/
    return create_ref_tag(tag_name, $1, $2)
  end

  if library.has_tag?(tag_name)
    @tags += [library.tag_create(tag_name, tag_buf)].flatten
  else
    log.warn "Unknown tag @#{tag_name}" +
             (object ? " in file `#{object.file}` near line #{object.line}" : "")
  end
rescue Tags::TagFormatError
  log.warn "Invalid tag format for @#{tag_name}" +
           (object ? " in file `#{object.file}` near line #{object.line}" : "")
end