PluginDocs (hotswap-agent 1.4.1 API)

java.lang.Object
- org.hotswap.agent.distribution.PluginDocs

```
public class PluginDocs
extends java.lang.Object
```
Generate plugin info and documentation into target/html. FIXME - if generated via maven, resources are inside JAR and generation fails with URI is not hierarchical exception need to resolve path inside JAR. Currently it can be launched from the IDE.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String TARGET_DIR

Constructor Summary

Constructors
Constructor Description

PluginDocs()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`assertDirExists(java.net.URL targetFile)`	Create all required directories in path for a file
`static java.lang.String`	`getBaseURL(java.lang.Class clazz)`	From a class definition resolve base URL common for all files in a maven project (project base directory).
`static void`	`main(java.lang.String[] args)`	Generate the docs.
`void`	`scan()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TARGET_DIR
```
public static final java.lang.String TARGET_DIR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PluginDocs
```
public PluginDocs()
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
    Generate the docs.
    
    Parameters:
    
    args - no arguments necessary.
  - getBaseURL
```
public static java.lang.String getBaseURL(java.lang.Class clazz)
```
    From a class definition resolve base URL common for all files in a maven project (project base directory).
    
    Parameters:
    
    clazz - class to use
    
    Returns:
    
    base path (e.g. file:/J:/HotswapAgent/HibernatePlugin)
  - scan
```
public void scan()
          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - assertDirExists
```
public static void assertDirExists(java.net.URL targetFile)
```
    Create all required directories in path for a file