[arquillian-issues] [JBoss JIRA] (ARQ-937) Add usage examples to API/SPI classes

[Aslak Knutsen (JIRA)]

Aslak Knutsen created ARQ-937:
---------------------------------

             Summary: Add usage examples to API/SPI classes
                 Key: ARQ-937
                 URL: https://issues.jboss.org/browse/ARQ-937
             Project: Arquillian
          Issue Type: Feature Request
      Security Level: Public (Everyone can see)
          Components: Extension - Warp
            Reporter: Aslak Knutsen
            Assignee: Lukáš Fryč
             Fix For: warp_1.0.0.next


We should start adding Usage Examples to API and SPIs with a Description of the Concept this represent.

The future usage is to build up a reference dictionary, see current version:
https://github.com/arquillian/arquillian-core/blob/master/container/test-api/src/main/java/org/jboss/arquillian/container/test/api/Deployment.java

Example:
http://staging-arquilliandev.rhcloud.com/code/reference/#org.jboss.arquillian.container.test.api.Deployment


Arquillian.org issue: https://github.com/arquillian/arquillian.github.com/issues/87

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira