chore(docs): adding group tags

Added @group tags to feature flags Signed-off-by: kpoorman <kjp@codefriar.com>
codefriar · Oct 5, 2023 · a65330d · a65330d
1 parent fb44ba0
commit a65330d
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 14 deletions.
diff --git a/docs/FF.md b/docs/FF.md
@@ -2,6 +2,8 @@
 
 Convenience class for checking feature flags. This is purely Syntactic sugar.
 
+**Group** FeatureFlag
+
 ## Methods
 
 ### `public static Boolean isEnabled(String featureName)`

diff --git a/docs/FeatureFlag.md b/docs/FeatureFlag.md
@@ -2,6 +2,8 @@
 
 Provides a unified, simple and testable api for feature flags
 
+**Group** FeatureFlag
+
 ## Constructors
 
 ### `public FeatureFlag()`

diff --git a/docs/FeatureFlagDataProvider.md b/docs/FeatureFlagDataProvider.md
@@ -3,6 +3,8 @@
 This class is responsible for querying / fetching FeatureFlag data. This is separate from the
 FeatureFlag flag class to facilitate proper unit testing. (and just good design)
 
+**Group** FeatureFlag
+
 ## Constructors
 
 ### `public FeatureFlagDataProvider()`

diff --git a/docs/home.md b/docs/home.md
@@ -44,10 +44,6 @@ is executed. The QueueableProcess class automatically attaches this finalizer t&
 
 This class contains two inner classes used for testing the QueueableProcess framework.
 
-### [FF](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FF)
-
-Convenience class for checking feature flags. This is purely Syntactic sugar.
-
 ### [FLSType](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FLSType)
 
 ### [FailsafeExceptionHandler](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FailsafeExceptionHandler)
@@ -57,20 +53,11 @@ boilerplate exception handling code everywhere, this class can be used to log ex
 
 ### [FailsafeExceptionHandlerTests](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FailsafeExceptionHandlerTests)
 
-### [FeatureFlag](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FeatureFlag)
-
-Provides a unified, simple and testable api for feature flags
-
 ### [FeatureFlagCommonTests](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FeatureFlagCommonTests)
 
 Class serves to DRY code for various testing methods that
 require it. It is not intended to be used directly.
 
-### [FeatureFlagDataProvider](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FeatureFlagDataProvider)
-
-This class is responsible for querying / fetching FeatureFlag data. This is separate from the
-FeatureFlag flag class to facilitate proper unit testing. (and just good design)
-
 ### [FeatureFlagDataProviderTests](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FeatureFlagDataProviderTests)
 
 ### [FeatureFlagTests](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/FeatureFlagTests)
@@ -417,4 +404,24 @@ By adding 'extends Invocable' to your class and adding the call method, any clas
 invoked by this single invocable method.
 
 
+## FeatureFlag
+
+### [FF](https://github.com/codefriar/ApexKit/wiki/FeatureFlag/FF)
+
+Convenience class for checking feature flags. This is purely Syntactic sugar.
+
+
+
+### [FeatureFlag](https://github.com/codefriar/ApexKit/wiki/FeatureFlag/FeatureFlag)
+
+Provides a unified, simple and testable api for feature flags
+
+
+
+### [FeatureFlagDataProvider](https://github.com/codefriar/ApexKit/wiki/FeatureFlag/FeatureFlagDataProvider)
+
+This class is responsible for querying / fetching FeatureFlag data. This is separate from the
+FeatureFlag flag class to facilitate proper unit testing. (and just good design)
+
+
 ```
diff --git a/force-app/main/default/classes/feature flags/FF.cls b/force-app/main/default/classes/feature flags/FF.cls
@@ -1,5 +1,7 @@
 /**
  * @description Convenience class for checking feature flags. This is purely Syntactic sugar.
+ *
+ * @group FeatureFlag
  */
 public with sharing class FF {
 	/**

diff --git a/force-app/main/default/classes/feature flags/FeatureFlag.cls b/force-app/main/default/classes/feature flags/FeatureFlag.cls
@@ -1,5 +1,7 @@
 /**
  * @description Provides a unified, simple and testable api for feature flags
+ *
+ * @group FeatureFlag
  */
 public with sharing class FeatureFlag {
 	/**

diff --git a/force-app/main/default/classes/feature flags/FeatureFlagDataProvider.cls b/force-app/main/default/classes/feature flags/FeatureFlagDataProvider.cls
@@ -1,6 +1,8 @@
 /**
  * @description This class is responsible for querying / fetching FeatureFlag data. This is separate from the
  * FeatureFlag flag class to facilitate proper unit testing. (and just good design)
+ *
+ * @group FeatureFlag
  */
 public with sharing class FeatureFlagDataProvider {
 	/**

diff --git a/force-app/main/default/classes/queueable process/QueueableProcess.cls b/force-app/main/default/classes/queueable process/QueueableProcess.cls
@@ -72,7 +72,7 @@ public abstract class QueueableProcess implements Queueable, Database.AllowsCall
 	 *
 	 * @param incomingException Exception - the exception that was thrown during execution.
 	 */
-	virtual public void handleException(Exception incomingException) {
+	public virtual void handleException(Exception incomingException) {
 		QueueableProcess.defaultHandleExceptionCalled = true;
 		System.debug(incomingException.getMessage()); // NOPMD
 	}