[
http://opencast.jira.com/browse/MH-6885?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=24654#comment-24654
]
Kenneth Lui commented on MH-6885:
---------------------------------
The description of how RESTful endpoint documentation is currently done can be
found in the following comment.
http://opencast.jira.com/browse/MH-6375?focusedCommentId=23380&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-23380
Regarding the "data structure" and "templating" system, there are currently
"DocRestData" (in org.opencastproject.util.doc) and "DocUtil" (in
"org.opencastproject.util") in the old documentation mechanism. So if we are
satisfied with the current documentation ui, we can keep the template and fill
in the DocRestData object in the DocumentationHandler with our new info from
annotations.
Or, if we want to stay "decentralized", we can populate the "DocRestData"
object in the "generateDocs" method of each service.
For Josh's DocumentationHandler code, I tried running it but it didn't show up
in some_endpoint_name/docs.html. I am not quite familiar with CXF. Do I have to
register the DocumentationHandler somewhere in order to use it?
> Outline the steps to replace the old doc engine
> -----------------------------------------------
>
> Key: MH-6885
> URL: http://opencast.jira.com/browse/MH-6885
> Project: Matterhorn Project
> Issue Type: Sub-Task
> Components: Architecture & Services
> Affects Versions: 1.2
> Reporter: Christopher Brooks
> Assignee: Kenneth Lui
> Fix For: 1.2
>
> Attachments: restdocs.diff
>
>
> Now that we have a base template setup, what do we need to do to replace the
> current docs system with this? How are docs html being generated, and what
> files from there do we need to bring into matterhorn kernel?
--
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
_______________________________________________
Matterhorn mailing list
[email protected]
http://lists.opencastproject.org/mailman/listinfo/matterhorn
To unsubscribe please email
[email protected]
_______________________________________________
