Added Javadocs, cleaned up comments.

This commit is contained in:
sk89q 2011-06-26 23:19:49 -07:00
parent 80e706e962
commit 32265414bd
2 changed files with 16 additions and 3 deletions

15
pom.xml
View File

@ -88,7 +88,6 @@
</resource> </resource>
</resources> </resources>
<!-- Plugins -->
<plugins> <plugins>
<!-- Compile plugin --> <!-- Compile plugin -->
<plugin> <plugin>
@ -170,4 +169,18 @@
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
<reporting>
<plugins>
<!-- Javadocs -->
<!-- TODO: Get Doclava working -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.8</version>
<configuration>
</configuration>
</plugin>
</plugins>
</reporting>
</project> </project>

View File

@ -62,7 +62,7 @@ public void load() throws IOException {
/** /**
* Save the list of regions. * Save the list of regions.
* *
* @throws IOException thrown on save error * @throws IOException thrown on save eIf checking multiple flags for a single locationror
*/ */
public void save() throws IOException { public void save() throws IOException {
loader.save(this); loader.save(this);
@ -118,7 +118,7 @@ public void save() throws IOException {
/** /**
* Get an object for a point for rules to be applied with. Use this * Get an object for a point for rules to be applied with. Use this
* in order to query for flag data or membership data for a given * in order to query for flag data or membership data for a given
* point. If checking multiple flags for a single location, * point.
* *
* @param pt point * @param pt point
* @return applicable region set * @return applicable region set