Updated documentation

p0dalirius · Nov 30, 2022 · 361b332 · 361b332
1 parent 36ac2d6
commit 361b332
Show file tree

Hide file tree

Showing 64 changed files with 10,390 additions and 8,406 deletions.
diff --git a/Makefile b/Makefile
@@ -6,8 +6,11 @@ clean:
 	@rm -rf `find ./ -type d -name "*__pycache__"`
 	@rm -rf ./build/ ./dist/ ./coercer.egg-info/
 
-documentation:
-	@cd ./documentation/; pdoc --html ../coercer/ --force
+docs:
+	@python3 -m pip install pdoc
+	@echo "[$(shell date)] Generating docs ..."
+	@python3 -m pdoc -d markdown -o ./documentation/ ./coercer/
+	@echo "[$(shell date)] Done!"
 
 install: build
 	python3 setup.py install

diff --git a/coercer/core/MethodFilter.py b/coercer/core/MethodFilter.py
@@ -15,6 +15,15 @@ def __init__(self, filter_method_name=None, filter_protocol_name=None):
         self.filter_protocol_name = filter_protocol_name
 
     def matches_filter(self, instance):
+        """
+        Function matches_filter
+
+        Parameters:
+            ?:instance
+
+        Return:
+            bool:outcome
+        """
         outcome = True
         #
         if self.filter_method_name is not None:

diff --git a/coercer/core/loader.py b/coercer/core/loader.py
@@ -12,6 +12,15 @@
 
 
 def find_and_load_coerce_methods(debug=False):
+    """
+    Function find_and_load_coerce_methods()
+
+    Parameters:
+        bool:debug Enable or disable debug output
+
+    Returns:
+        list:coerce_methods
+    """
     coerce_methods = {}
     search_dir = os.path.dirname(__file__) + os.path.sep + ".." + os.path.sep + "methods"
     if debug:

diff --git a/documentation/coercer.html b/documentation/coercer.html
diff --git a/documentation/coercer/methods.html b/documentation/coercer/methods.html
diff --git a/documentation/coercer/network.html b/documentation/coercer/network.html
diff --git a/documentation/coercer/network/DCERPCSession.html b/documentation/coercer/network/DCERPCSession.html
diff --git a/documentation/coercer/network/DCERPCSessionError.html b/documentation/coercer/network/DCERPCSessionError.html
diff --git a/documentation/coercer/network/Listener.html b/documentation/coercer/network/Listener.html
diff --git a/documentation/coercer/network/authentications.html b/documentation/coercer/network/authentications.html
diff --git a/documentation/coercer/network/smb.html b/documentation/coercer/network/smb.html
diff --git a/documentation/coercer/network/utils.html b/documentation/coercer/network/utils.html
diff --git a/documentation/coercer/protocols.html b/documentation/coercer/protocols.html
diff --git a/documentation/coercer/protocols/MS_DFSNM.html b/documentation/coercer/protocols/MS_DFSNM.html
diff --git a/documentation/coercer/protocols/MS_EFSR.html b/documentation/coercer/protocols/MS_EFSR.html
diff --git a/documentation/coercer/protocols/MS_FSRVP.html b/documentation/coercer/protocols/MS_FSRVP.html
diff --git a/documentation/coercer/protocols/MS_RPRN.html b/documentation/coercer/protocols/MS_RPRN.html
diff --git a/documentation/coercer/utils.html b/documentation/coercer/utils.html
diff --git a/documentation/coercer/utils/RPCProtocol.html b/documentation/coercer/utils/RPCProtocol.html
diff --git a/documentation/coercer/utils/Reporter.html b/documentation/coercer/utils/Reporter.html
diff --git a/documentation/coercer/utils/smb.html b/documentation/coercer/utils/smb.html
diff --git a/documentation/html/coercer/core/MethodFilter.html b/documentation/html/coercer/core/MethodFilter.html