Browse Source

Fix comment/documentation for `AliasesAPI`

pull/8/head
Anton Tarasenko 2 years ago
parent
commit
d28f00593a
  1. 12
      sources/Aliases/AliasesAPI.uc

12
sources/Aliases/AliasesAPI.uc

@ -58,7 +58,7 @@ public function _reloadSources()
* with a given name `sourceName`. * with a given name `sourceName`.
* *
* Custom alias sources can be added manually by the admin through the * Custom alias sources can be added manually by the admin through the
* `Aliases_Feature` config file.. * `Aliases_Feature` config file.
* *
* @param sourceName Name that alias source was added as to * @param sourceName Name that alias source was added as to
* `Aliases_Feature`. * `Aliases_Feature`.
@ -181,7 +181,7 @@ private final function Text ResolveWithSource(
* *
* In Acedia aliases are typically prefixed with '$' to indicate that user * In Acedia aliases are typically prefixed with '$' to indicate that user
* means to enter alias. This method is able to handle both aliases with and * means to enter alias. This method is able to handle both aliases with and
* without that prefix. This does not lead to conflicts, because '$' is cannot * without that prefix. This does not lead to conflicts, because '$' cannot
* be a valid part of any alias. * be a valid part of any alias.
* *
* Lookup of alias can fail if either alias does not exist in weapon alias * Lookup of alias can fail if either alias does not exist in weapon alias
@ -215,7 +215,7 @@ public final function Text ResolveWeapon(
* *
* In Acedia aliases are typically prefixed with '$' to indicate that user * In Acedia aliases are typically prefixed with '$' to indicate that user
* means to enter alias. This method is able to handle both aliases with and * means to enter alias. This method is able to handle both aliases with and
* without that prefix. This does not lead to conflicts, because '$' is cannot * without that prefix. This does not lead to conflicts, because '$' cannot
* be a valid part of any alias. * be a valid part of any alias.
* *
* Lookup of alias can fail if either alias does not exist in color alias * Lookup of alias can fail if either alias does not exist in color alias
@ -249,7 +249,7 @@ public final function Text ResolveColor(
* *
* In Acedia aliases are typically prefixed with '$' to indicate that user * In Acedia aliases are typically prefixed with '$' to indicate that user
* means to enter alias. This method is able to handle both aliases with and * means to enter alias. This method is able to handle both aliases with and
* without that prefix. This does not lead to conflicts, because '$' is cannot * without that prefix. This does not lead to conflicts, because '$' cannot
* be a valid part of any alias. * be a valid part of any alias.
* *
* Lookup of alias can fail if either alias does not exist in feature alias * Lookup of alias can fail if either alias does not exist in feature alias
@ -283,7 +283,7 @@ public final function Text ResolveFeature(
* *
* In Acedia aliases are typically prefixed with '$' to indicate that user * In Acedia aliases are typically prefixed with '$' to indicate that user
* means to enter alias. This method is able to handle both aliases with and * means to enter alias. This method is able to handle both aliases with and
* without that prefix. This does not lead to conflicts, because '$' is cannot * without that prefix. This does not lead to conflicts, because '$' cannot
* be a valid part of any alias. * be a valid part of any alias.
* *
* Lookup of alias can fail if either alias does not exist in entity alias * Lookup of alias can fail if either alias does not exist in entity alias
@ -317,7 +317,7 @@ public final function Text ResolveEntity(
* *
* In Acedia aliases are typically prefixed with '$' to indicate that user * In Acedia aliases are typically prefixed with '$' to indicate that user
* means to enter alias. This method is able to handle both aliases with and * means to enter alias. This method is able to handle both aliases with and
* without that prefix. This does not lead to conflicts, because '$' is cannot * without that prefix. This does not lead to conflicts, because '$' cannot
* be a valid part of any alias. * be a valid part of any alias.
* *
* Custom alias sources are any type of alias source that isn't built-in into * Custom alias sources are any type of alias source that isn't built-in into

Loading…
Cancel
Save