Skip to content

Instantly share code, notes, and snippets.

@robmazan

robmazan/jsdoc-config.json

Created May 10, 2013 08:29
Show Gist options
  • Save robmazan/5553179 to your computer and use it in GitHub Desktop.
Save robmazan/5553179 to your computer and use it in GitHub Desktop.
Download ZIP
Configure JSDoc3 for a Maven project
Raw
jsdoc-config.json
{
"source": {
"excludePattern": "jam\/.*"
}
}
Raw
pom-jsdoc.xml
<?xml version="1.0" encoding="UTF-8"?>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.2.1</version>
<executions>
<execution>
<id>Generate JSDoc</id>
<goals>
<goal>exec</goal>
</goals>
<phase>site</phase>
<configuration>
<executable>cmd</executable>
<workingDirectory>${basedir}/src/main/javascript</workingDirectory>
<arguments>
<argument>/C</argument>
<argument>jsdoc</argument>
<argument>-r</argument>
<argument>-d</argument>
<argument>${project.build.directory}/site/jsdoc</argument>
<argument>-c</argument>
<argument>${basedir}/src/site/jsdoc-config.json</argument>
<argument>*.js</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>
Raw
site.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
...
<body>
...
<menu name="Additional reports">
<item name="JSDoc" href="jsdoc/index.html" />
</menu>
</body>
</project>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment