Skip to content

Latest commit

 

History

History
67 lines (56 loc) · 2.29 KB

wordcloud.adoc

File metadata and controls

67 lines (56 loc) · 2.29 KB
Raw

Word Cloud

Description

Generate a word cloud from code analysis.

mojo

wordcloud

Configuration

sources

the source folder to scan (default is src/main/java)

outputDirectory

the outpout directory (default is target/generated-docs)

includes

fileSets to include in the scan (default is {"**/package-info.java"})

excludes

fileSets to exclude from the scan (default is {"**/*.java"})

The plugin need the maven-remote-resources-plugin to import html dependencies (js, css) for the doc.

Usage

Maven
            <plugin>
                <groupId>io.github.livingdocumentation</groupId>
                <artifactId>livingdoc-maven-plugin</artifactId>
                <version>${plugin.livingdoc-maven-plugin.version}</version>
                <executions>
                    <execution>
                        <id>wordcloud</id>
                        <phase>generate-resources</phase>
                        <goals>
                            <goal>wordcloud</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <includes>
                        <include>**/domain/**/*.java</include>
                    </includes>
                    <excludes>
                        <exclude>**/annotations/**</exclude>
                        <exclude>**/package-info.java</exclude>
                    </excludes>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-remote-resources-plugin</artifactId>
                <version>1.5</version>
                <configuration>
                    <resourceBundles>
                        <resourceBundle>io.github.livingdocumentation:shared-resources:${plugin.livingdoc-maven-plugin.version}</resourceBundle>
                    </resourceBundles>
                    <outputDirectory>target/generated-docs</outputDirectory>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>process</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>