class Solargraph::Convention::Base

The base class for Conventions.

A Convention provides Environs that customize ApiMaps with additional pins and other information. Subclasses should implement the ‘local` and `global` methods as necessary.

Public Instance Methods

global (doc_map)

Source

# File lib/solargraph/convention/base.rb, line 28
def global doc_map
  EMPTY_ENVIRON
end

The Environ for a DocMap. Subclasses can override this method.

@param doc_map [DocMap] @return [Environ]

local (source_map)

Source

# File lib/solargraph/convention/base.rb, line 19
def local source_map
  EMPTY_ENVIRON
end

The Environ for a source map. Subclasses can override this method.

@param source_map [SourceMap] @return [Environ]

object (api_map, rooted_tag, scope, visibility, deep, skip, no_core)

Source

# File lib/solargraph/convention/base.rb, line 44
def object api_map, rooted_tag, scope, visibility,
           deep, skip, no_core
  EMPTY_ENVIRON
end

Provides any additional method pins based on e the described object.

@param api_map [ApiMap] @param rooted_tag [String] A fully qualified namespace, with

generic parameter values if applicable

@param scope [Symbol] :class or :instance @param visibility [Array<Symbol>] :public, :protected, and/or :private @param deep [Boolean] @param skip [Set<String>] @param no_core [Boolean] Skip core classes if true

@return [Environ]