My Go on the Cerberus X Documentation

Dubbsta

Active Member
Joined
Jul 13, 2017
Holzchopf i saw an example somewhere in the docs i think for url or http where it sent an email to mark could u tell me where it is
 

Holzchopf

Moderator
Joined
Jul 31, 2017
Location
Bern, Switzerland
It's in the example of mojo.app.OpenUrl

Edit

Shit, opening the actual example code just revealed a bug in Makedocs: The code is not de-escaped. I'll fix this asap (tomorrow)

Edit II

Also, why is martins e-mail address publicly in there? I'll change that to something generic. If anyone wants to send an actual e-mail, they can put their own address there.
 
Last edited:

Holzchopf

Moderator
Joined
Jul 31, 2017
Location
Bern, Switzerland
Turn's out it's not a bug in the escaping. The example code really does contain a "\" before the "<". I'll correct this. As well as the e-mail address.
 

Holzchopf

Moderator
Joined
Jul 31, 2017
Location
Bern, Switzerland
Markdown may also include html. Note that the special html characters <, > and & must therefore be 'escaped' using a backslash, the markdown escape character. For example, to insert a literal < into your markdown, you should use \<.
But in <pre> blocks (which make the code boxes in the help files), the Markdown formatter is bypassed, because 1.) you never want to format the text of code anyway and 2.) you would have to escape all the other formatting chars too, which could be quite a hassle.

<pre> blocks contents do not contain markdown, therefore no markdown escaping is necessary.

I'll put this somewhere in the Markdown syntax help page.
 

Paul59

Active Member
CX Code Contributor
Joined
Dec 13, 2018
Location
UK
Tiny error in App.OnClose() I think:

"This method is only used by the glfw, android and windows 8 targets."

Maybe that should be Windows Phone 8 as per other mentions (I know nothing about Windows Phone or windows after v7 so maybe it really does mean Windows 8!)
 

Paul59

Active Member
CX Code Contributor
Joined
Dec 13, 2018
Location
UK
Just spotted this in the docs for OnUpdate(), which doesn't seem to be correct - I get updates even if SetUpdateRate() hasn't been called:

Note that OnUpdate is only called if SetUpdateRate has been called to start the update timer. Otherwise, your application will receive OnRender calls only.
 

Paul59

Active Member
CX Code Contributor
Joined
Dec 13, 2018
Location
UK
Just noticed these typos ('statch' instead of 'stack') under the Stack class:

Find : Int ( value:T, start:Int=0 ) Finds the index of the first element in the statch equal to value.
FindLast : Int ( value:T ) Finds the index of the last element in the statch equal to value.
FindLast : Int ( value:T, start:Int ) Finds the index of the last element in the statch equal to value.
 

Phil7

Moderator
Joined
Jun 26, 2017
@Mike Could you fix those typos on github? I am still working my way through the workings of makedocs and I didn't get into working on the content so far.
 

Paul59

Active Member
CX Code Contributor
Joined
Dec 13, 2018
Location
UK
Also, this doesn't make sense:

CLASS Material

Materials contain shader parameters that map to shader uniforms variables when rendering
(it's also repeated under 'Detailed Discussion' further down the page)
 

Paul59

Active Member
CX Code Contributor
Joined
Dec 13, 2018
Location
UK
1) The Detailed part always includes the first line.
I know but I don't know if that happens automatically which is why I mentioned it.
2) What doesn't make sense?
This: "Materials contain shader parameters that map to shader uniforms variables when rendering " . I don't know anything about shaders (which is why I was reading the help file) but I do know that sentence doesn't make sense. I'm guessing 'uniforms' is the problem word!
 

Paul59

Active Member
CX Code Contributor
Joined
Dec 13, 2018
Location
UK
In help for CLASS DataBuffer, the first occurrence of 'databuffer' has an extra 'f'' :D

"Data may be written to a databufffer using one of the 'poke' methods, and read from a databuffer using one of the 'peek' methods."
 
Top Bottom