summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/evas_canvas3d_node.eo
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-13 12:25:49 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-13 12:30:03 +0200
commit8c09c1cae8b4368b88ec0b296f124d35e735dc7e (patch)
tree16548e1c5e3c8ac8b51398525da011ab555d4e29 /src/lib/evas/canvas/evas_canvas3d_node.eo
parent5e9b30153399014ff0aa52922f8460c7769eb741 (diff)
docs: Move property docs to property level instead of set/get
Eolian @properties should be documented at the property level, and documentation at the setter or getter level should be left to setter- or getter-specific comments. There is usually no need at all to have setter- or getter- specific comments. Also, a property is not a method so descriptions should match that. This patch removes lots of duplicated text, and will allow enabling by default the eolian check that ensures that properties have proper property-level docs. No functional changes.
Diffstat (limited to 'src/lib/evas/canvas/evas_canvas3d_node.eo')
-rw-r--r--src/lib/evas/canvas/evas_canvas3d_node.eo95
1 files changed, 34 insertions, 61 deletions
diff --git a/src/lib/evas/canvas/evas_canvas3d_node.eo b/src/lib/evas/canvas/evas_canvas3d_node.eo
index ec9891c..900bbd6 100644
--- a/src/lib/evas/canvas/evas_canvas3d_node.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_node.eo
@@ -235,17 +235,14 @@ class @beta Evas.Canvas3D.Node extends Evas.Canvas3D.Object
235 } 235 }
236 236
237 @property position_inherit { 237 @property position_inherit {
238 set { 238 [[The position inheritance flag of the given node.
239 [[Set the position inheritance flag of the given node.
240 239
241 When inheritance is enabled, a node's world space position is determined by 240 When inheritance is enabled, a node's world space position is determined by
242 adding the parent node's world position and the node's position. Otherwise 241 adding the parent node's world position and the node's position. Otherwise
243 the node's position will be the world space position.]] 242 the node's position will be the world space position.]]
243 set {
244 } 244 }
245 get { 245 get {
246 [[Get the position inheritance flag of the given node.
247
248 See also @Evas.Canvas3D.Node.position_inherit.set.]]
249 } 246 }
250 values { 247 values {
251 inherit: bool; [[Whether to inherit parent position.]] 248 inherit: bool; [[Whether to inherit parent position.]]
@@ -253,18 +250,15 @@ class @beta Evas.Canvas3D.Node extends Evas.Canvas3D.Object
253 } 250 }
254 251
255 @property orientation_inherit { 252 @property orientation_inherit {
256 set { 253 [[The orientation inheritance flag of the given node.
257 [[Set the orientation inheritance flag of the given node.
258 254
259 When inheritance is enabled, a node's world space orientation is determined 255 When inheritance is enabled, a node's world space orientation is determined
260 by multiplying the parent node's world orientation and the node's 256 by multiplying the parent node's world orientation and the node's
261 orientation. Otherwise the node's orientation will be the world space 257 orientation. Otherwise the node's orientation will be the world space
262 orientation.]] 258 orientation.]]
259 set {
263 } 260 }
264 get { 261 get {
265 [[Get the orientation inheritance flag of the given node.
266
267 See also @Evas.Canvas3D.Node.orientation_inherit.set.]]
268 } 262 }
269 values { 263 values {
270 inherit: bool; [[Whether to inherit parent orientation.]] 264 inherit: bool; [[Whether to inherit parent orientation.]]
@@ -272,17 +266,14 @@ class @beta Evas.Canvas3D.Node extends Evas.Canvas3D.Object
272 } 266 }
273 267
274 @property scale_inherit { 268 @property scale_inherit {
275 set { 269 [[The scale inheritance flag of the given node.
276 [[Set the scale inheritance flag of the given node.
277 270
278 When inheritance is enabled, a node's world space scale is determined by 271 When inheritance is enabled, a node's world space scale is determined by
279 multiplying the parent node's world scale and the node's scale. Otherwise 272 multiplying the parent node's world scale and the node's scale. Otherwise
280 the node's scale will be the world space scale.]] 273 the node's scale will be the world space scale.]]
274 set {
281 } 275 }
282 get { 276 get {
283 [[Get the scale inheritance flag of the given node.
284
285 See also @Evas.Canvas3D.Node.scale_inherit.set.]]
286 } 277 }
287 values { 278 values {
288 inherit: bool; [[Whether to inherit parent scale.]] 279 inherit: bool; [[Whether to inherit parent scale.]]
@@ -290,18 +281,15 @@ class @beta Evas.Canvas3D.Node extends Evas.Canvas3D.Object
290 } 281 }
291 282
292 @property camera { 283 @property camera {
293 set { 284 [[A camera attached to the given node.
294 [[Set a camera to the given node.
295 285
296 If the node is not of type EVAS_CANVAS3D_NODE_TYPE_CAMERA, error message will be 286 If the node is not of type EVAS_CANVAS3D_NODE_TYPE_CAMERA, error message will be
297 generated and nothing happens. 287 generated and nothing happens.
298 288
299 See also @Evas.Canvas3D.Node.member_add.]] 289 See also @Evas.Canvas3D.Node.member_add.]]
290 set {
300 } 291 }
301 get { 292 get {
302 [[Get the camera of the given node.
303
304 See also @Evas.Canvas3D.Node.camera.set.]]
305 } 293 }
306 values { 294 values {
307 // FIXME: Evas_Canvas3D_Camera is necessary, but that introduces a cycle 295 // FIXME: Evas_Canvas3D_Camera is necessary, but that introduces a cycle
@@ -310,18 +298,15 @@ class @beta Evas.Canvas3D.Node extends Evas.Canvas3D.Object
310 } 298 }
311 299
312 @property light { 300 @property light {
313 set { 301 [[A light attached to the given node.
314 [[Set the light of the given node.
315 302
316 If the node is not of type EVAS_CANVAS3D_NODE_TYPE_LIGHT, error message will be 303 If the node is not of type EVAS_CANVAS3D_NODE_TYPE_LIGHT, error message will be
317 generated and nothing happens. 304 generated and nothing happens.
318 305
319 See also @Evas.Canvas3D.Node.member_add.]] 306 See also @Evas.Canvas3D.Node.member_add.]]
307 set {
320 } 308 }
321 get { 309 get {
322 [[Get the light of the given node.
323
324 See also @Evas.Canvas3D.Node.light.set.]]
325 } 310 }
326 values { 311 values {
327 light: Evas.Canvas3D.Light; [[The light of the given node if any, or $null if there're none.]] 312 light: Evas.Canvas3D.Light; [[The light of the given node if any, or $null if there're none.]]
@@ -329,23 +314,17 @@ class @beta Evas.Canvas3D.Node extends Evas.Canvas3D.Object
329 } 314 }
330 315
331 @property mesh_frame { 316 @property mesh_frame {
332 set { 317 [[The animation frame number of the given node for the given mesh.
333 [[Set the animation frame number of the given node for the given mesh.
334 318
335 If the node is not of type EVAS_CANVAS3D_NODE_TYPE_MESH or the given mesh does not 319 If the node is not of type EVAS_CANVAS3D_NODE_TYPE_MESH or the given mesh does not
336 belong to the given mesh error mesh will be generated and nothing happens. 320 belong to the given mesh error mesh will be generated and nothing happens.
337 321
338 Default mesh frame is 0. 322 Default mesh frame is 0.
339 323
340 See also @Evas.Canvas3D.Node.mesh_add.]] 324 See also @Evas.Canvas3D.Node.mesh_add.]]
325 set {
341 } 326 }
342 get { 327 get {
343 [[Set the animation frame number of the given node for the given mesh.
344
345 If the node is not of type EVAS_CANVAS3D_NODE_TYPE_MESH or the given mesh does not
346 belong to the given mesh error mesh will be generated and nothing happens.
347
348 See also @Evas.Canvas3D.Node.mesh_add.]]
349 } 328 }
350 keys { 329 keys {
351 mesh: Evas.Canvas3D.Mesh; [[The given mesh.]] 330 mesh: Evas.Canvas3D.Mesh; [[The given mesh.]]
@@ -356,13 +335,10 @@ class @beta Evas.Canvas3D.Node extends Evas.Canvas3D.Object
356 } 335 }
357 336
358 @property billboard_target { 337 @property billboard_target {
338 [[Set behavior of node like billboard object.]]
359 set { 339 set {
360 [[Set behavior of node like billboard object.]]
361 } 340 }
362 get { 341 get {
363 [[Get the target node for billboard object.
364
365 See also @Evas.Canvas3D.Node.billboard_target.set.]]
366 } 342 }
367 values { 343 values {
368 target: Evas.Canvas3D.Node; [[The pointer to target node for billboard object, 344 target: Evas.Canvas3D.Node; [[The pointer to target node for billboard object,
@@ -370,13 +346,10 @@ class @beta Evas.Canvas3D.Node extends Evas.Canvas3D.Object
370 } 346 }
371 } 347 }
372 @property lod_enable { 348 @property lod_enable {
349 [[Enable behavior of node like LOD object.]]
373 set { 350 set {
374 [[Enable behavior of node like LOD object.]]
375 } 351 }
376 get { 352 get {
377 [[Get(check) status of node does node is LOD object.
378
379 See also @Evas.Canvas3D.Node.lod_enable.set.]]
380 } 353 }
381 values { 354 values {
382 enable: bool; [[status property (true/false)]] 355 enable: bool; [[status property (true/false)]]