Fixed javadoc (issue #164)

broker/src/main/java/io/moquette/server/Server.java

@@ -81,6 +81,7 @@ public class Server {
     /**
      * Starts Moquette bringing the configuration from the file 
      * located at m_config/moquette.conf
+     * @throws IOException in case of any IO error.
      */
     public void startServer() throws IOException {
         IResourceLoader filesystemLoader = new FileResourceLoader(defaultConfigFile());
@@ -95,6 +96,8 @@ public class Server {
 
     /**
      * Starts Moquette bringing the configuration from the given file
+     * @param configFile text file that contains the configuration.
+     * @throws IOException in case of any IO Error.
      */
     public void startServer(File configFile) throws IOException {
         LOG.info("Using m_config file: " + configFile.getAbsolutePath());
@@ -111,6 +114,9 @@ public class Server {
      *  <li>port</li>
      *  <li>password_file</li>
      * </ul>
+     *
+     * @param configProps the properties map to use as configuration.
+     * @throws IOException in case of any IO Error.
      */
     public void startServer(Properties configProps) throws IOException {
         final IConfig config = new MemoryConfig(configProps);
@@ -119,6 +125,8 @@ public class Server {
 
     /**
      * Starts Moquette bringing the configuration files from the given Config implementation.
+     * @param config the configuration to use to start the broker.
+     * @throws IOException in case of any IO Error.
      */
     public void startServer(IConfig config) throws IOException {
         startServer(config, null);
@@ -127,6 +135,9 @@ public class Server {
     /**
      * Starts Moquette with config provided by an implementation of IConfig class and with the
      * set of InterceptHandler.
+     * @param config the configuration to use to start the broker.
+     * @param handlers the handlers to install in the broker.
+     * @throws IOException in case of any IO Error.
      * */
     public void startServer(IConfig config, List<? extends InterceptHandler> handlers) throws IOException {
         startServer(config, handlers, null, null, null);
@@ -220,6 +231,8 @@ public class Server {
     /**
      * SPI method used by Broker embedded applications to get list of subscribers.
      * Returns null if the broker is not started.
+     *
+     * @return list of subscriptions.
      */
     public List<Subscription> getSubscriptions() {
         if (m_processorBootstrapper == null) {
@@ -230,6 +243,8 @@ public class Server {
 
     /**
      * SPI method used by Broker embedded applications to add intercept handlers.
+     * @param interceptHandler the handler to add.
+     * @return true id operation was successful.
      * */
     public boolean addInterceptHandler(InterceptHandler interceptHandler) {
         if (!m_initialized) {
@@ -240,6 +255,8 @@ public class Server {
 
     /**
      * SPI method used by Broker embedded applications to remove intercept handlers.
+     * @param interceptHandler the handler to remove.
+     * @return true id operation was successful.
      * */
     public boolean removeInterceptHandler(InterceptHandler interceptHandler) {
         if (!m_initialized) {

broker/src/main/java/io/moquette/server/netty/AutoFlushHandler.java

@@ -136,6 +136,9 @@ public class AutoFlushHandler extends ChannelDuplexHandler {
 
     /**
      * Is called when the write timeout expire.
+     *
+     * @param ctx the channel context.
+     * @throws Exception in case of any IO error.
      */
     protected void channelIdle(ChannelHandlerContext ctx/*, IdleStateEvent evt*/) throws Exception {
 //        ctx.fireUserEventTriggered(evt);