Issue Type: Improvement Improvement
Assignee: Unassigned
Components: build, documentation
Created: 09/Jul/13 9:18 AM
Description:

We could extract the example code as compiling code and then cut&paste it into the documentation. Having the actual code snippets compile will ensure they are correct and we can also apply our coding standard on these code examples.

Of course the disadvantage is that we need to manually keep code and docs in sync.

See also the Validator documentation module where we applied this approach.

Project: Hibernate Search
Priority: Major Major
Reporter: Hardy Ferentschik
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira