add Doxygen documentation

[o-du/phy.git] / docs / Doxygen / terminal_commands.txt

diff --git a/docs/Doxygen/terminal_commands.txt b/docs/Doxygen/terminal_commands.txt
new file mode 100644 (file)
index 0000000..d663785
--- /dev/null
+++ b/docs/Doxygen/terminal_commands.txt
@@ -0,0 +1,15 @@
+# Terminal commands for generating doxygen docs
+
+# open terminal on the phy/docs/Doxygen folder
+
+cd docs/Doxygen
+
+# generate the Doxyfile (if not using the sample)
+# commented because using the sample Doxyfile
+# doxygen -g
+
+# run the doxygen
+
+doxygen Doxyfile
+
+# the html files will generated on the phy/docs/API folder