From 4e01114571e4a7654146b974a89376f11bcf21ca Mon Sep 17 00:00:00 2001
From: Thibault Dockx <thibault.dockx@fusiondirectory.org>
Date: Tue, 11 Feb 2025 17:13:31 +0000
Subject: [PATCH] :sparkles: First commit - comment how to in code
Comment how to in code p4
---
source/fusiondirectory/development/documentation/PHPDoc.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/source/fusiondirectory/development/documentation/PHPDoc.rst b/source/fusiondirectory/development/documentation/PHPDoc.rst
index 8e0f48b..257a0b9 100644
--- a/source/fusiondirectory/development/documentation/PHPDoc.rst
+++ b/source/fusiondirectory/development/documentation/PHPDoc.rst
@@ -91,7 +91,7 @@ A PHPDoc comment starts with `/**` and ends with `*/`. Each line inside the bloc
Documenting Classes & Files
---------------------------
-### Documenting a Class
+**Documenting a Class**
.. code-block:: php
@@ -140,6 +140,7 @@ To generate documentation using Doxygen:
doxygen -g Doxyfile
3. **Modify the `Doxyfile`**:
+
- Set `INPUT` to the PHP source code directory.
- Enable `EXTRACT_ALL = YES` to parse all comments.
- Set `FILE_PATTERNS = *.php` to only parse PHP files.
@@ -151,6 +152,7 @@ To generate documentation using Doxygen:
doxygen Doxyfile
5. **View the Output**:
+
- Open `html/index.html` in a browser.
-----------------
--
GitLab