da

README.md

@@ -68,4 +68,31 @@ Minimal flow:
 - Avoid obfuscating code that uses eval/exec on source strings that expect original identifiers.
 
 ## License
-Specify a license for this project (e.g., MIT). If adding a LICENSE file, reference it here.
+Specify a license for this project (e.g., MIT). If adding a LICENSE file, reference it here.
+## Documentation
+
+Generate Doxygen HTML docs for this codebase.
+
+- Prerequisites (install one of the following):
+  - Windows (chocolatey): choco install doxygen.install
+  - macOS (Homebrew): brew install doxygen
+  - Linux (apt): sudo apt-get update && sudo apt-get install doxygen
+
+- Generate:
+  - From the repository root, run: doxygen [Doxyfile](Doxyfile)
+  - Open the generated site: [docs/html/index.html](docs/html/index.html)
+
+- Notes:
+  - Configuration extracts Python docstrings and Markdown.
+  - Source browsing and inline sources are enabled.
+  - Key modules documented include:
+    - [obfuscator.py](obfuscator.py)
+    - [transformers/rename.py](transformers/rename.py)
+    - [transformers/control_flow.py](transformers/control_flow.py)
+    - [transformers/symbol_tree.py](transformers/symbol_tree.py)
+    - [transformers/class_analyzer.py](transformers/class_analyzer.py)
+    - [transformers/class_mapper.py](transformers/class_mapper.py)
+    - [transformers/attribute_transformer.py](transformers/attribute_transformer.py)
+    - [utils/encryption.py](utils/encryption.py)
+    - [utils/junk_gen.py](utils/junk_gen.py)
+    - [utils/name_gen.py](utils/name_gen.py)