Docs fixes #390
Docs fixes #390
Conversation
Docs/src/manual/hlms.md
Outdated
| C++ can use `Hlms::setProperty( "key", value )` to set "key" to the given | ||
| value. This value can be read by `\@property`, `@foreach`, | ||
| C++ can use `Hlms::setProperty( "key", value )` to set value to the given | ||
| "key". This value can be read by `\@property`, `@foreach`, |
There was a problem hiding this comment.
Weirdly, both sentences are valid.
- set "key" to the given value
- set value to the given "key"
Both mean the same thing. But I think the rest of the docs use the former expression.
Docs/src/manual/hlms.md
Outdated
| | custom_ps_preExecution | Executed before Ogre's code from the Pixel Shader.| | ||
| | custom_ps_posMaterialLoad | Executed right after loading material data; and before anything else. May not get executed if there is no relevant material data (i.e. doesn't have normals or QTangents for lighting calculation)| | ||
| | custom_ps_posSampleNormal | .. | |
There was a problem hiding this comment.
We can use [TBD] instead of ...
The thing about some of this customization pieces is that they were added for a particular reason; so it's more a thing of "I need to add a piece of code that happens in this exact spot" rather than explaining what it exactly is supposed to do; look where it is in the code, and override it.
|
Wow, that makes me feel embarrassed and I hope my English teacher never sees this post <deletes all traces of your PR entirely> Ok jokes aside. Good job!
It looks like they became broken back from when we switched from the odt manual to Doxygen. I just fixed what you highlighted. |
|
Before accepting the PR I think my only grip is with this change:
|
|
Ah right, I just realized it's the same meaning. I restored it. |
I made many fixes in hlms doc.
Funny thing: the more I read the more I find them. Maybe it'd be easier to just paste this all to some spellchecking editor.
I added more
custom_*blocks that I found in .any files, they need description, instead of..placeholder.One more thing, don't know how to fix it, if you look at website
https://ogrecave.github.io/ogre-next/api/latest/hlms.html
there are few links that don't work (get linked) and odd text is there instead. Search for
|outlinee.g.:9.3.Hlms templates|outline "collected",9.4.1.5.,9.6.1.preparePassHash|outline,see 8.9.1.4.Loading a texture twiceetc.Well I still don't know answers to my questions like here:
https://forums.ogre3d.org/viewtopic.php?p=554575#p554575
https://forums.ogre3d.org/viewtopic.php?p=554600#p554600
I think it would be good to add some (even small) section(s) with such answers or links. I think these are rather common for advanced users.