Skip to content

Commit 7c97c35

Browse files
update
1 parent 3d58106 commit 7c97c35

File tree

2 files changed

+32
-30
lines changed

2 files changed

+32
-30
lines changed

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ HTML_OUTPUT = src/reference
5959

6060
# predictable links
6161
HTML_FILE_EXTENSION = .html
62-
CASE_SENSE_NAMES = NO
62+
CASE_SENSE_NAMES = YES
6363

6464
#OUTPUT_DIRECTORY = doxy_out
6565
COLLABORATION_GRAPH = NO

src/gettingstarted/extension/general.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,65 +17,67 @@ This page provides an overview of general concepts. For details of any particula
1717

1818
### Plugins and extensions
1919

20-
The core of a plugin is the [`PluginInstance`](/reference/classalbert_1_1_plugin_instance.html) class.
20+
The core of a plugin is the [`PluginInstance`](/reference/classalbert_1_1PluginInstance.html) class.
2121
It is the interface that every Albert plugin must implement.
2222
The loader of a plugin resolves and instantiates the concrete implementation of this class.
2323
It serves as settings widget and extension factory and provides utility functions for plugins.
2424

25-
[`Extension`](/reference/classalbert_1_1_extension.html) is the polymorphic base class of any kind of extension.
26-
Built on this type the extension system provides a polymorphic extension registry.
25+
[`Extension`](/reference/classalbert_1_1Extension.html) is the polymorphic base class of any kind of extension.
26+
Built on this type the extension system provides an [`ExtensionRegistry`](/reference/classalbert_1_1ExtensionRegistry.html).
2727
Plugins can implement existing extension interfaces to provide additional functionality,
2828
but also define their own types of extensions and listen for registrations of instances thereof.
2929

30-
The core application offers a set of built-in interfaces that plugins can implement to extend functionality.
31-
The current core app extension interfaces are:
32-
33-
![img](/reference/classalbert_1_1_Extension__inherit__graph.svg)
34-
30+
Related classes:
3531

36-
Related:
37-
- [`ExtensionPlugin`](/reference/classalbert_1_1_extension_plugin.html):
32+
- [`ExtensionPlugin`](/reference/classalbert_1_1ExtensionPlugin.html):
3833
Implements the `Extension` interface using the metadata of the plugin instance.
39-
- [`StrongDependency`](/reference/classalbert_1_1_strong_dependency.html)
34+
- [`StrongDependency`](/reference/classalbert_1_1StrongDependency.html)
4035
Fetches and holds a reference to a mandatory dependency.
41-
- [`WeakDependency`](/reference/classalbert_1_1_weak_dependency.html)
36+
- [`WeakDependency`](/reference/classalbert_1_1WeakDependency.html)
4237
Fetches and holds a reference to an optional dependency.
4338

39+
The core application offers a set of built-in interfaces that plugins can implement.
40+
The current core app extension interfaces are:
41+
42+
![img](/reference/classalbert_1_1Extension__inherit__graph.svg)
43+
4444

4545
### Query handlers
4646

4747
The basic query handling extension are:
4848

49-
- [`TriggerQueryHandler`](/reference/classalbert_1_1_trigger_query_handler.html)
50-
- [`GlobalQueryHandler`](/reference/classalbert_1_1_global_query_handler.html)
51-
- [`FallbackHandler`](/reference/classalbert_1_1_fallback_handler.html)
49+
- [`TriggerQueryHandler`](/reference/classalbert_1_1TriggerQueryHandler.html)
50+
- [`GlobalQueryHandler`](/reference/classalbert_1_1GlobalQueryHandler.html)
51+
- [`FallbackHandler`](/reference/classalbert_1_1FallbackHandler.html)
5252

5353
If you've read the [basics](http://0.0.0.0:4000/gettingstarted/basics/#queries) their purpose should be clear.
54-
All of them provide instances of the [`Item`](/reference/classalbert_1_1_item.html) interface.
55-
It provides several methods associated with the features of the user interface,
56-
most notably the item [`Action`](/reference/classalbert_1_1_action.html) factory.
54+
All of them provide instances of the [`Item`](/reference/classalbert_1_1Item.html) interface.
55+
The `Item` interface provides several methods related to the features of the user interface,
56+
most notably the [`Action`](/reference/classalbert_1_1Action.html) factory.
5757

58+
Related classes:
5859

59-
Related:
60-
- [`StandardItem`](/reference/classalbert_1_1_standard_item.html)
60+
- [`Query`](/reference/classalbert_1_1Query.html)
61+
Represents a query execution.
62+
- [`StandardItem`](/reference/classalbert_1_1StandardItem.html)
6163
Value-based implementation of the `Item` interface.
62-
- [`RankItem`](/reference/classalbert_1_1_rank_item.html)
63-
Used by `GlobalQueryHandler` to score matches.
64-
- [`IndexQueryHandler`](/reference/classalbert_1_1_index_query_handler.html)
64+
- [`RankItem`](/reference/classalbert_1_1RankItem.html)
65+
Used by `GlobalQueryHandler` to return scored matches.
66+
- [`IndexQueryHandler`](/reference/classalbert_1_1IndexQueryHandler.html)
6567
Convenience class performing implicit (fuzzy) matching.
66-
- [`IndexItem`](/reference/classalbert_1_1_index_item.html)
68+
- [`IndexItem`](/reference/classalbert_1_1IndexItem.html)
6769
Used by `IndexQueryHandler` to associate an item with a lookup string.
68-
- [`Matcher`](/reference/classalbert_1_1_matcher.html)
69-
Utility for string matching
70+
- [`Matcher`](/reference/classalbert_1_1Matcher.html)
71+
Utility for string matching.
7072

7173
### Others interfaces
7274

7375
#### Frontend plugins
7476

75-
- [`Frontend`](/reference/classalbert_1_1_frontend.html)
77+
- [`Frontend`](/reference/classalbert_1_1Frontend.html)
7678

7779
#### Plugin providers
7880

79-
- [`PluginLoader`](/reference/classalbert_1_1_plugin_loader.html)
80-
- [`PluginProvider`](/reference/classalbert_1_1_plugin_provider.html)
81+
- [`PluginLoader`](/reference/classalbert_1_1PluginLoader.html)
82+
- [`PluginProvider`](/reference/classalbert_1_1PluginProvider.html)
8183

0 commit comments

Comments
 (0)