Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/keenwrite.git

Add API usage comment

AuthorDaveJarvis <email>
Date2021-12-05 21:01:05 GMT-0800
Commite28c48f323e67dfba717ba2ec7ec6d87d76ad3f6
Parentfd7f19a
src/main/java/com/keenwrite/editors/definition/DefinitionEditor.java
}
+ /**
+ * Returns the variable definitions. This is called in critical parts of the
+ * application, necessitating a cache. The cache is updated by calling
+ * {@link #interpolate(SigilOperator)}, which happens upon tree modifications
+ * via the editor or immediately after the definition file is loaded.
+ *
+ * @return The definition map with all variable references fully interpolated
+ * and replaced.
+ */
@Override
public Map<String, String> getDefinitions() {
Delta9 lines added, 0 lines removed, 9-line increase