Guidelines - Saurye/LeapMotionDoc GitHub Wiki

To keep the project's documentation unified, here are some guidelines:

1. The documentation must be copied to the letter from the Leap Motion API documentation site.

2. If the Leap Motion API documentation is missing, you may add your own documentation.
3. Fields should be placed at the top of the class.
4. Constructor methods should be placed after the fields.
5. The recurring methods `getCPtr`, `finalize` and `delete` are meant for internal use, and therefor not documented. They should be moved to the end of the class.
6. The constructor method `public (long paramLong, boolean paramBoolean)` is meant for internal use, and therefor not documented. It should be placed at after the other constructor methods.
7. Inner classes should be at the end of the enclosing class, after the aforementioned recurring methods.
8. To add a new line you should use `
`, and `

` for 2 lines.
9. The `@link` annotation must be used when referring to an other class, method or field in a comment.
However, when referring to a class, method or field inside it's own documentation, use the `@code` annotation.
10. Add the `@since` annotation only in the documentation of classes and inner classes.
11. You should change the method's parameter names to the names specified in the Leap Motion API documentation.
(The current names are automatic names generated by the Java Decompiler).
12. If there's an image in the Leap Motion API documentation site, download it to the "images" folder, and add a link to it like this: ``. (See example in the `CircleGesture` class documentation)
13. If there's a table in the Leap Motion API documentation site, copy it's source to the javadoc, and strip it from style and formatting. (See example in the `CircleGesture` class documentation) 14. If there are code lines in the Leap Motion API documentation site, copy it to the javadoc, and surround it with:
`

`

`code`

`

`