Java Docs Tool

User Guide

www.CyberDefenses.com

2

Table of Contents REASON TO DEPLOY ....................................................................................................................................... 3

CONFIGURATION OPTIONS ............................................................................................................................ 4

JAVA DOCS TOOL PLUGIN

3

REASON TO DEPLOY The CyberDefenses Java Doc’s Plugin provides a seamless way to generate documentation from any customized instance of IdentityIQ (IIQ). This plugin provides value to both implementers and clients alike. Every implementation of IIQ requires some amount of customization to fulfil the use case of the product installation. In the midst of custom workflows, rules, tasks and configured applications, there exists a need to provide documentation around all custom objects. The JavaDoc Plugin allows developers the ability to generate a JavaDoc in the typical format with little effort. Configurations are also automatically stored in a friendly format outside of the product.

JAVA DOCS TOOL PLUGIN

4

CONFIGURATION OPTIONS After the plugin is installed, there is only one configuration parameter needed for the plugin to start working. The plugin only asks for a specific file path to generate the JavaDoc styled documentation. After RunNow is pressed, the plugin will begin scanning the current instance of IIQ to gather information for all objects and populate the directory listed.

JAVA DOCS TOOL PLUGIN

5

Once completed, you can open index.html to view the JavaDoc:

JAVA DOCS TOOL PLUGIN