Documentation for method generate-entries assembled from the following types:

class Documentable::Search

From Documentable::Search

(Documentable::Search) method generate-entries

Defined as

method generate-entries(--> Array[Str])

Generates all search entries and store them in an Array. It generates three kind of entries:

• Primary entries: these entries come from Documentable::Primary objects. We initialize one entry per instance of that class found in the registry as follows:

  category => subkind attribute
  value    => name attribute
  url      => url attribute

• Secondary entries: these entries come from Documentable::Secondary objects. Before create any entry of this type, we group all Documentable::Secondary objects by name and after that, we generate one entry per group, as follows:

  category => kind attribute if more than one document is found. Subkind attribute otherwise
  value    => name attribute
  url      => url attribute

• Reference entries: these entries come from Documentable::Index objects. One entry per found object.

  category => kind attribute (it's always Kind::Reference)
  value    => name attribute
  url      => url attribute