Jump to content
  • entries
    940
  • comments
    5,894
  • views
    863,962

Please review the new documentation


Josh

3,278 views

 Share

I'm asking the community to look over the new documentation system and find any mistakes before I sign off on the project. The tutorials are not completed. The API Reference should be completed, although the main API Reference page is not showing anything right now.

https://www.leadwerks.com/learn

 

Here are my notes to the developer who is working on the docs:

Thank you for the update. I have fixed the table of contents page so that clicking on a link in the tree view will navifate to the correct page. This should make it much easier to test.

 

The following corrections are needed:

 

A new <subclasses> tag has been added, to show a list of all derived subclasses on a class page:

https://www.leadwerks.com/learn?page=API-Reference_Object_Entity

 

This is what it looks like for the Entity class page:

<subclasses>

<subclass>Camera</subclass>

<subclass>Bone</subclass>

<subclass>Model</subclass>

<subclass>Terrain</subclass>

<subclass>Brush</subclass>

<subclass>Light</subclass>

<subclass>Pivot</subclass>

</subclasses>

 

The App class can be removed from the TOC. Rewriting the example functions eliminates our use of this.

 

The Object class page is missing.

 

In the table of contents, all camera function links after GetClearColor() are wrong.

 

There is no Emitter::ClearPostEffects() function. Please remove this from the TOC.

 

I am asking my community to find any other problems. Overall, it's looking great.

 

Please review the material and make sure everything meets your satisfaction, and leave your comment below if needed. I figure many sets of eyes will be more efficient than just me looking through it. This is your documentation, and I want to make sure it's the best for you. Thanks for your help!

  • Upvote 5
 Share

11 Comments


Recommended Comments

FileSystem::StripDir shows "Failed to load page data. "

Camera::SetFOV to Camera::UnProject is still wrong as well as Tumira already said.

Link to comment

I gave the link for this blog post to the developer and he will be reviewing your comments and making fixes. Thanks for your help.

Link to comment

Analytics - Disable "Failed to load page"

Material- GetShaderMode "Failed to load page"

Texture - GetFormat "Failed to load page"

Context - GetWindow shows GetWidth

Context - Plot shows GetWidth

Context - Sync shows SetTranslation

Link to comment

Entity - Emitter - ClearPostEffects "Failed to load page"

Entity - Model - Sprite "Failed to load page"

Entity - Model - Sprite - Lens Flare "Failed to load page"

Entity - SetMatrix "Failed to load page"

Entity - GetPhysicsMode seems incomplete has syntax and nothing else.

FileSystem - StripAll "Failed to load page"

FileSystem - StripDir "Failed to load page"

Joint - DisableLimits seems incomplete has syntax only and starts with "this function enables joint limits!

Joint - DisableMotor seems incomplete syntax only

Joint - EnableLimits seems incomplete syntax only

Link to comment

Maths - Plane in contents section lists as inverse, transpose,inverse, transpose. Should read DistanceToPoint, GetNormal, IntersectsLine, Transpose.

First inverse does link to DistanceToPoint

First transpose does link to GetNormal

Second inverse links to IntersectsLine

Second transpose also links to IntersectsLine

 

Maths - Vec4 contents should read xy and xyz but shows Cross and DistanceToPoint links go to the right information thou.

 

Maths - Curve "Failed to load page"

Maths - Min "Failed to load page"

Source - Lock "Failed to load page"

Surface - GetTriangleVertex "Failed to load page"

Steamworks - Initialize "Failed to load page"

System - GetPlatformName "Failed to load page"

Vehicle - GetCurrent "Failed to load page"

 

Ok I think thats it.

 

Men in white coats are coming to give me my medicine now:)

Link to comment

A lot of the pages are missing CPP/LUA examples.

 

API-Reference_Object_Asset_Material_SetPickMode

API-Reference_Object_Asset_Shader_GetFloat

API-Reference_Object_Color

API-Reference_Object_Entity_Emitter

 

Just to name a few.

Link to comment

entity:GetScript())

 

and

 

entity:SetScript("path/filename")

 

are missing from the reference.

Link to comment
Guest
Add a comment...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...