Added @mainpage for doxygen that simply includes the README and LiCENSE

docs. Also added groups for appkit and foundation classes.
stevegeek · Mar 1, 2009 · 2e7294d · 2e7294d
1 parent 6750b90
commit 2e7294d
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/Foundation/Foundation.j b/Foundation/Foundation.j
@@ -55,3 +55,19 @@
 @import "CPURLResponse.j"
 @import "CPUserSessionManager.j"
 @import "CPValue.j"
+
+/*! @defgroup appkit AppKit
+    @defgroup foundation Foundation
+
+    @mainpage
+    Cappuccino is distributed under the @ref license "GNU LGPL".
+
+    @htmlonly <pre>@endhtmlonly
+    @htmlinclude README
+    @htmlonly </pre>@endhtmlonly
+
+    @page license License
+    @htmlonly <pre>@endhtmlonly
+    @htmlinclude LICENSE
+    @htmlonly </pre>@endhtmlonly
+*/
diff --git a/Tools/Documentation/Cappuccino.doxygen b/Tools/Documentation/Cappuccino.doxygen
@@ -137,7 +137,8 @@ EXCLUDE                = AppKit/Cib \
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = _*
 EXCLUDE_SYMBOLS        = _*
-EXAMPLE_PATH           = 
+EXAMPLE_PATH           = ./README \
+                         ./LICENSE
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
 IMAGE_PATH             =