Merge pull request #9 from MoonGameLab/repo-doc

Project Docs
MoonGameLab · Jan 19, 2025 · 630961a · 630961a
2 parents 0600322 + 7c0ae0d
commit 630961a
Show file tree

Hide file tree

Showing 8 changed files with 2,734 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,31 @@
 # Doxygen::Filter::Moon
 
-## Currently in development
+## Version 1.0
 
-* Clone the master branch for the proof of concept
+* Doxygen::Filter::Moon - A moonscript code pre-filter for Doxygen
+  * Based on **[doxygen-filter-perl](https://github.com/jordan2175/doxygen-filter-perl)**
 
 
+## MOTIVATION
+
+* I wanted to learn how to write a filter for Doxygen. Since i already use it for my C/CPP projects i was curious if i can make a filter for Moonscript.
+  * FYI: There is already an existing tool to generate docs for MoonScript (**[Ldoc](https://lunarmodules.github.io/ldoc/manual/manual.md.html#Moonscript_Support)**), it is what i've been using in my other projects.
+* I wanted to learn Perl since i've never used it and this is my first project with it. And i was lucky enough to find a reference to follow **[doxygen-filter-perl](https://github.com/jordan2175/doxygen-filter-perl)**
+* Lastly i wanted to give my self options ;) 
+
+## FEATURES
+
+```
+The features of Doxygen::Filter::Moon are as follows:
+    Support for Doxygen style comments in Moonscript
+```
 
 ## INSTALLATION
 
 ```
 To install this module type the following:
 perl Makefile.PL
 make
-make test # TODO 
 make install
 ```
+
diff --git a/bin/moon2dox b/bin/moon2dox
@@ -1,4 +1,23 @@
 #!/usr/bin/env perl
+#
+#####################################################################
+# This program is not guaranteed to work at all, and by using this  #
+# program you release the author of any and all liability.          #
+#                                                                   #
+# You may use this code as long as you are in compliance with the   #
+# license (see the LICENSE file) and this notice, disclaimer and    #
+# comment box remain intact and unchanged.                          #
+#                                                                   #
+# Script:      moon2dox                                             #
+# Description: pre-filter script for doxygen                        #
+#                                                                   #
+# Written by:  Tourahi Amine                                        #
+# Created:     2025-01-19                                           #
+#####################################################################
+#
+#
+#
+#
 
 use strict;
 use warnings;