Doodle3D-Slicer/three.js-master/docs/api/CONTRIBUTING.md
2015-06-12 15:58:26 +02:00

7 lines
685 B
Markdown
Executable File

Contributing to the documentation
=================================
- To link to the page for `ClassName`, use `[page:ClassName link title]` (or just `[page:ClassName]`). Use `[page:ClassName.memberName]` to link to a class member (a property or method) called `memberName` on the page for `ClassName`. You can write `[page:.memberName]` to link to a property or method called `memberName` on the same page.
- Use `[example:exampleName title]` (ot just `[example:exampleName]`) to link to the example `threejs.org/examples/#exampleName`.
- Document a property by writing `<h3>[property:TypeName propertyName]</h3>`.
- Document a method using `<h3>[method:ReturnType methodName]</h3>`.