Javadoc: Add engine overview

10 years ago · abb2b784e0
parent 85bba59541
commit abb2b784e0
2 changed files with 27 additions and 0 deletions
--- a/build.gradle
+++ b/build.gradle
@ -82,6 +82,7 @@ task mergedJavadoc(type: Javadoc, description: 'Creates Javadoc from all the pro
        options.addStringOption('Xdoclint:none', '-quiet')
    }
    options.overview = file("javadoc-overview.html")
    // Note: The closures below are executed lazily.
    source subprojects.collect {project ->
        project.sourceSets*.allJava
--- a/javadoc-overview.html
+++ b/javadoc-overview.html
@ -0,0 +1,26 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
 <head>
 <title></title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 </head>
 <body>
 jMonkeyEngine is a game engine made for developers who want to create 3D games 
 following modern technology standards. The framework is programmed entirely 
 in Java aimed at wide accessibility and quick deployment to desktop, 
 web, and mobile platforms.
 <h3>Key Features</h3>
 <ul>
 <li>Free, open-source software (under the New BSD license) – Use our free engine for commercial, educational, or hobby game development</li>
 <li>Minimal adaptations for cross-compatibility – Create games that run on any OpenGL 2 and 3-ready device with the Java Virtual Machine – web, desktop, or mobile.</li>
 <li>Built around a shader-based architecture – Compliant with current and next generation graphics standards.</li>
 <li>jMonkeyEngine SDK – A complete development environment (IDE) with visual editors, integrated tools, and unique plugins.</li>
 <li>Complete and modular – The developer remains in power while getting all game development essentials straight out of the box.</li>
 </ul>
 </body>
 </html>