Class | YARD::RegistryStore |
In: |
lib/yard/registry_store.rb
|
Parent: | Object |
The data store for the {Registry}.
@see Registry @see Serializers::YardocSerializer
checksums | [R] | |
file | [R] | |
proxy_types | [R] | @deprecated The registry no longer tracks proxy types |
Deletes the .yardoc database on disk
@param [Boolean] force if force is not set to true, the file/directory
will only be removed if it ends with .yardoc. This helps with cases where the directory might have been named incorrectly.
@return [Boolean] true if the .yardoc database was deleted, false
otherwise.
Gets a {CodeObjects::Base} from the store
@param [String, Symbol] key the path name of the object to look for.
If it is empty or :root, returns the {#root} object.
@return [CodeObjects::Base, nil] a code object or nil if none is found
Associates an object with a path @param [String, Symbol] key the path name (:root or ’’ for root object) @param [CodeObjects::Base] value the object to store @return [CodeObjects::Base] returns value
Gets all code objects from the store. Loads the entire database if reload is true
@param [Boolean] reload if false, does not load the entire database
before a lookup.
@return [Array<CodeObjects::Base>] all the code objects
@param [Symbol] type the type to look for @return [Array<CodeObjects::Base>] a list of objects with a given
{CodeObjects::Base#type}
@since 0.8.0