org.apache.clerezza.platform.documentation.viewer

Class DocumentationViewer

java.lang.Object

org.apache.clerezza.platform.documentation.viewer.DocumentationViewer

public class DocumentationViewer
extends Object

The documentation viewer provides a webpage that shows the available documentation.

Author:

mir

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DocumentationViewer.DocumentationItem

Constructor Summary

Constructors

Constructor and Description
DocumentationViewer()

Method Summary

Methods

Modifier and Type	Method and Description
GraphNode	documentationPage(javax.ws.rs.core.UriInfo uriInfo) Redirects to the overview page
protected List<DocumentationViewer.DocumentationItem>	sortDocItems(Collection<DocumentationViewer.DocumentationItem> docItems)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationViewer

public DocumentationViewer()

Method Detail

documentationPage

public GraphNode documentationPage(@Context
                          javax.ws.rs.core.UriInfo uriInfo)

Redirects to the overview page

Returns:

Response

sortDocItems

protected List<DocumentationViewer.DocumentationItem> sortDocItems(Collection<DocumentationViewer.DocumentationItem> docItems)