https://github.com/j256/spring-request-doclet

Doclet that generates documentation automatically using Spring request annotations and Javadocs.
https://github.com/j256/spring-request-doclet

java javadoc spring spring-web

Last synced: about 1 month ago
JSON representation

Doclet that generates documentation automatically using Spring request annotations and Javadocs.

• Host: GitHub
• URL: https://github.com/j256/spring-request-doclet
• Owner: j256
• License: isc
• Created: 2016-11-30T18:37:40.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-16T09:52:19.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T23:46:11.435Z (7 months ago)
• Topics: java, javadoc, spring, spring-web
• Language: Java
• Size: 75.2 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
This package provides a simple doclet for auto-generating documentation using Java's javadoc generator

specifically for tracking spring's web requests.

* For more information, visit the [Spring Request Doclet home page](http://256stuff.com/sources/spring-request-doclet/).	

* Browse the code on the [git repository](https://github.com/j256/spring-request-doclet).

* Maven packages are published via [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.j256.spring-request-doclet/spring-request-doclet/badge.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/com.j256.spring-request-doclet/spring-request-doclet/)

Enjoy. Gray Watson

## Sample Output

For sample output, see this hiearchy: http://256stuff.com/sources/spring-request-doclet/sample/

## How to Use With Maven

To use this doclet you will need to include something like the following into your Maven pom.xml and

execute 'mvn site:site'.

	

		

			

				org.apache.maven.plugins

				maven-javadoc-plugin

				?.?.?

				

					

						spring-request-doclet

						

							javadoc

						

						

							Spring Request Docs

							Spring Request documentation.

							com.j256.springrequestdoclet.SpringRequestDoclet

							

								com.j256.spring-request-doclet

								spring-request-doclet

								?.?.?

							

							false

							spring-request-docs

						

					

				

			

		

	

Once you run site:site, the directory target/site/spring-request-docs will have been created.    You can

also run 'mvn site:site site:jar' to package up a target/*-site.jar with the site documentation.

### Optional Root Documentation

By default the doclet will generate request details which include a path summary, class summary, class

details, and method details files.  If you'd like, you can specify a small hierarchy of custom

documentation that can be used to provide more generic information as an introduction to the requests

handled as opposed to the details from the classes.

To add the custom documentation, you specificy the -r option with a relative directory path.

Something like:

	

		spring-request-doclet

		...

		

			

			-r ../../../src/main/doc/spring-request-doclet

			...

		

	

For example, if you have:

	src/main/doc/spring-request-doclet/index.html

	src/main/doc/spring-request-doclet/overview/index.html

	src/main/doc/spring-request-doclet/overview/details.html

then these files will be copied into:

	target/site/spring-request-docs/index.html

	target/site/spring-request-docs/overview/index.html

	target/site/spring-request-docs/overview/details.html

By default the path-summary file is written to index.html but if you specify a replacement index.html

then it will be written to paths.html and you should include a link to it in your replacement index.

The following files are auto-generated by the doclet and should not be overwritten:

	classes.html

	paths.html

	classes/

Any other paths and directories can be used.

# Maven Configuration

* Maven packages are published via [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.j256.spring-request-doclet/spring-request-doclet/badge.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/com.j256.spring-request-doclet/spring-request-doclet/)

``` xml

	com.j256.spring-request-doclet

	spring-request-doclet

	1.1

```

# ChangeLog Release Notes

See the [ChangeLog.txt file](src/main/javadoc/doc-files/changelog.txt).