refactor: code cleanups and add functionDependsOn

egomobile · Feb 1, 2024 · b4384fc · b4384fc
1 parent dc61b65
commit b4384fc
Show file tree

Hide file tree

Showing 13 changed files with 603 additions and 438 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Change Log (@egomobile/documentation)
 
+## 0.4.0
+
+- add tools to add function dependencies
+- reorganize code, especially types
+
 ## 0.3.0
 
 - implement serializable types and `serializeDependencies()` utility function

diff --git a/README.md b/README.md
@@ -19,7 +19,8 @@ npm install --save @egomobile/documentation
 ```typescript
 import {
     defaultDependencies,
-    DependsOn
+    DependsOn,
+    functionDependsOn
 } from "@egomobile/documentation";
 
 @DependsOn({
@@ -76,6 +77,12 @@ class MyDocumentedClass {
     }
 }
 
+function myFunction() {
+  // ...
+}
+// do this for functions as well
+functionDependsOn(myFunction);
+
 console.log(
     // by default all information are
     // stored in this module-wide array

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@egomobile/documentation",
-    "version": "0.3.0",
+    "version": "0.4.0",
     "description": "Tools for documenting (TypeScript) code.",
     "main": "lib/index.js",
     "engines": {