Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Proofread and improve the whole class reference

Browse source 
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
This commit is contained in:
Hugo Locurcio 2019-06-22 01:04:47 +02:00
parent 538c8eec15
commit f7f6115f76
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
330 changed files with 2585 additions and 2474 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/classes/CameraTexture.xml
View file

@ -1,7 +1,8 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CameraTexture" inherits="Texture" category="Core" version="3.2">
<brief_description>
This texture gives access to the camera texture provided by a [CameraFeed]. Note that many cameras supply YCbCr images which need to be converted in a shader.
This texture gives access to the camera texture provided by a [CameraFeed].
[b]Note:[/b] Many cameras supply YCbCr images which need to be converted in a shader.
</brief_description>
<description>
</description>
@ -11,7 +12,7 @@
</methods>
<members>
<member name="camera_feed_id" type="int" setter="set_camera_feed_id" getter="get_camera_feed_id">
Id of the [CameraFeed] for which we want to display the image.
The ID of the [CameraFeed] for which we want to display the image.
</member>
<member name="camera_is_active" type="bool" setter="set_camera_active" getter="get_camera_active">
Convenience property that gives access to the active property of the [CameraFeed].