How to Generate AppSettings Javadoc

Good news! Our documentation has moved to antmedia.io/docs.

• Clone the Ant-Media-Server-Common and cd to Ant-Media-Server-Common/

• Run the command

  $ mvn javadoc:javadoc -Dshow=private
  

  Maven will create javadoc containing all the classes, we need only AppSettings

• Keep the following files and remove the rest

  * Ant-Media-Server-Common/target/site/apidocs/io/antmedia/AppSettings.html
  * Ant-Media-Server-Common/target/site/apidocs/io/antmedia/package-summary.html
  * Ant-Media-Server-Common/target/site/apidocs/io/antmedia/package-tree.html
  * Ant-Media-Server-Common/target/site/apidocs/resources (dir)
  * Ant-Media-Server-Common/target/site/apidocs/*.css
  * Ant-Media-Server-Common/target/site/apidocs/*.js
  * Ant-Media-Server-Common/target/site/apidocs/*.zip
  

• Keep the file/directory structure - Files must be in this order on the document file lets say its (AppSettingsDoc) - ( directory structure io/antmedia should be conserved for proper operation, don't put AppSettings.html directly in the document folder, it should be in io/antmedia/)

  * /io/antmedia/AppSettings.html
  * /io/antmedia/package-summary.html
  * /io/antmedia/package-tree.html
  * /resources
  * /*.css
  * /*.js
  * /*.zip
  

• Send the new versions to antmedia.io/javadoc