Developing Apama Applications > Developing Apama Applications in EPL > Generating Documentation for Your EPL Code
Generating Documentation for Your EPL Code
Just as you can use the Javadoc tool to generate documentation for Java, you can use the ApamaDoc tool to generate documentation for EPL. ApamaDoc, which is based on Javadoc, generates reference documentation from EPL source code. To enhance what ApamaDoc automatically generates, you can insert annotations in block comments. Annotations are a mixture of text and tags.
ApamaDoc is an export wizard in Apama Studio. It generates static HTML pages that document the structure of all EPL code in a project. This includes the .mon files that you create as well as all .mon files in all bundles that have been added to a project.
Alternatively, you can generate ApamaDoc in headless mode by invoking the apamadoc utility from the command line.
Copyright © 2013 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors.