summaryrefslogtreecommitdiffstats
path: root/src/main/javadoc/overview.html
diff options
context:
space:
mode:
authorWesley Wolfe <weswolf@aol.com>2013-02-22 22:49:38 -0600
committerWesley Wolfe <weswolf@aol.com>2013-02-22 22:49:38 -0600
commit90faffc3399be881d6010885c398c845ceb6b848 (patch)
tree6f0c93691d8ce000209808e04365fab1f761aa5e /src/main/javadoc/overview.html
parent76e82dddd95cd020b55ccd0661e7d2bf49b5ed6e (diff)
downloadbukkit-90faffc3399be881d6010885c398c845ceb6b848.tar
bukkit-90faffc3399be881d6010885c398c845ceb6b848.tar.gz
bukkit-90faffc3399be881d6010885c398c845ceb6b848.tar.lz
bukkit-90faffc3399be881d6010885c398c845ceb6b848.tar.xz
bukkit-90faffc3399be881d6010885c398c845ceb6b848.zip
Pulling all pending Bukkit-JavaDoc changes
Diffstat (limited to 'src/main/javadoc/overview.html')
-rw-r--r--src/main/javadoc/overview.html17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
new file mode 100644
index 00000000..e96bf35e
--- /dev/null
+++ b/src/main/javadoc/overview.html
@@ -0,0 +1,17 @@
+<body>
+ <p>Bukkit, the plugin development framework.</p>
+
+ <p>
+ The documentation is for developing plugins and is split into the
+ respective packages for each subject matter. This documentation does not
+ cover running a server, contributing code back to the project, or setting
+ up a workspace. Working knowledge of the Java language is a prerequisite
+ for developing plugins.
+ </p><p>
+ For basic plugin development, see the {@link org.bukkit.plugin plugin
+ package}. It covers the basic requirements of a plugin jar.
+ </p><p>
+ For handling events and triggered code, see the {@link org.bukkit.event
+ event package}.
+ </p>
+</body>