Docs: update dispose return type

[servinlp]

Description

On multiple places change the documentation for the dispose() method to return null

[mrdoob]

I think it should be [method:undefined dispose].

[Mugen87]

Then it's best if the OP corrects the other methods, too. null is used for all void helper methods right now.

[mrdoob]

Oh... I guess we have many incorrect ones like that?

[servinlp]

Ye method:null is currently used on quite a few places. Should all void methods have method:undefined as there return type? Like for example OrthographicCamera.setViewOffset (the code)

[Mugen87]

Oh... I guess we have many incorrect ones like that?

Yes, the docs are currently not consistent regarding returns types. If a method has not return statement, you can find the following approaches in the docs:

• Using void:
  

  three.js/docs/api/en/loaders/Loader.html

  Line 65 in efd6466

  <h3>[method:void load]()</h3>

• Using null:
  

  three.js/docs/api/en/helpers/CameraHelper.html

  Line 76 in efd6466

  <h3>[method:null update]()</h3>

• Using undefined:
  

  three.js/docs/api/en/renderers/WebGLCubeRenderTarget.html

  Line 68 in efd6466

  <h3>[method:undefined clear]( [param:WebGLRenderer renderer], [param:Boolean color], [param:Boolean depth], [param:Boolean stencil] )</h3>

I think I vote for using void since this type is also used in TS.

[servinlp]

void sound logical from a TS point of view however from having a quick look around it seems that method:null is most used right now.

[Mugen87]

Before using null it really should be undefined.

[mrdoob]

These methods do not return null. Either void or undefined works for me.

[servinlp]

So void? I'm assuming we would want to do this them throughout the entire docs in the future aswell?

[Mugen87]

Then let's use undefined 👍.

@servinlp Are you willing to update the docs accordingly?

[servinlp]

I will update this PR first and then see if I can change the rest in a different PR.

Do we have a document or something were we define documentation guide lines?

[Mugen87]

Do we have a document or something were we define documentation guide lines?

No, if possible I would like to avoid that and just correct the existing doc pages. If everything is consistent, copy/paste errors like before can be avoided.

[Mugen87]

Do you mind updating the Chinese pages, too?

[servinlp]

It looks like the Chinese pages don't have the documentation for the dispose method yet

[mrdoob]

Thanks!