org.opends.server.admin.doc

Class ConfigGuideGeneration

java.lang.Object

org.opends.server.admin.doc.ConfigGuideGeneration

public class ConfigGuideGeneration
extends Object

This class allow Configuration Guide documentation generation (html format). It is based on the Admin Framework Introspection API

Constructor Summary

Constructors

Constructor and Description
ConfigGuideGeneration()

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(String[] args) Entry point for documentation generation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigGuideGeneration

public ConfigGuideGeneration()

Method Detail

main

public static void main(String[] args)

Entry point for documentation generation. Properties: GenerationDir - The directory where the doc is generated (default is /var/tmp/[CONFIG_GUIDE_DIR>]) LdapMapping - Presence means that the LDAP mapping section is to be generated (default is no) OpenDJWiki - The URL of the OpenDJ Wiki (default is "http://wikis.forgerock.org/confluence/display/OPENDJ") OpenDJHome - The URL of the OpenDJ project Home page (default is "http://opendj.forgerock.org")

Parameters:

args - none.