New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #1183

Merged
merged 12 commits into from Feb 14, 2015

Conversation

Projects
None yet
2 participants
@MusicMonkey5555
Contributor

MusicMonkey5555 commented Feb 11, 2015

I added/fixed some documentation. If it was incorrect documentation it was changed, if there were inconsistencies in variable names I changed them and if something wasn't documented I added it.

MusicMonkey5555 added some commits Feb 2, 2015

Added better comments to console methods
Improved the comments on two console methods so when using them it is
clearer what to expect.
Documented console methods
Added more documentation to console methods, changed inconsistent or
confusing parameter names.
Added a bit more documentation
Added a little more documentation to some console methods.
More console method docs
More documentation for console methods in doxygen format.
Added console method docs
Added more console method documentation and made parameter names more
descriptive.
Some small console method docs
Added a little documentation to a console method.
add & delete object documentation
added add & delete object console method documentation.
Added console method docs and removed function
Added a ton of console method documenation and removed
getSelectionCentroidText when you can just use a Point3F as the return
type.
shellExecute return documentation
Added documentation to shellExecute about bool that is returned.
Corrected filesize units in return comment
I may be mistaken but at least in windows I think the return will be in
bytes no KB.
@@ -92,7 +92,6 @@ class WorldEditor : public EditTSCtrl
S32 getSelectionSize();
S32 getSelectObject(S32 index);
const Point3F& getSelectionCentroid();
const char* getSelectionCentroidText();

This comment has been minimized.

@crabmusket

crabmusket Feb 12, 2015

Contributor

What happened here?

@crabmusket

crabmusket Feb 12, 2015

Contributor

What happened here?

This comment has been minimized.

@MusicMonkey5555

MusicMonkey5555 Feb 12, 2015

Contributor

So if I recall correctly the only reason this was here is to output to a console method, after converting it over to use a return console type of Point3F it isn't really needed. Guess this isn't so much documentation, but in the act of converting over console functions to use the new way of defining them, it was a necessary change. Hopefully that all makes sense. Just look at line 3252 or 3261 in the .cpp file.

@MusicMonkey5555

MusicMonkey5555 Feb 12, 2015

Contributor

So if I recall correctly the only reason this was here is to output to a console method, after converting it over to use a return console type of Point3F it isn't really needed. Guess this isn't so much documentation, but in the act of converting over console functions to use the new way of defining them, it was a necessary change. Hopefully that all makes sense. Just look at line 3252 or 3261 in the .cpp file.

"@param scaleType Scale type to use."
"@param scale Scale to transform by."
"@param sRelative True to use a relative scale."
"@param sLocal True to use a local scale.")

This comment has been minimized.

@crabmusket

crabmusket Feb 12, 2015

Contributor

Oh gosh, thanks for adding something to this monster...

@crabmusket

crabmusket Feb 12, 2015

Contributor

Oh gosh, thanks for adding something to this monster...

@crabmusket

This comment has been minimized.

Show comment
Hide comment
@crabmusket

crabmusket Feb 12, 2015

Contributor

Great stuff :). Should be easy to merge. Except for the tabs all through it T_T.

Contributor

crabmusket commented Feb 12, 2015

Great stuff :). Should be easy to merge. Except for the tabs all through it T_T.

MusicMonkey5555 added some commits Feb 12, 2015

Fixed spelling errors
Fixed spelling errors.
Fixed spacing issues
Tabs to 3 spaces.
@crabmusket

This comment has been minimized.

Show comment
Hide comment
@crabmusket

crabmusket Feb 14, 2015

Contributor

The tabs issue is tricky since so many files use tabs already, inconsistently :P. Look, I'm going to go ahead and merge this, even if it increases the tab-noise a little. At some point in the future we'll make some sort of style pass over the engine.

Contributor

crabmusket commented Feb 14, 2015

The tabs issue is tricky since so many files use tabs already, inconsistently :P. Look, I'm going to go ahead and merge this, even if it increases the tab-noise a little. At some point in the future we'll make some sort of style pass over the engine.

crabmusket added a commit that referenced this pull request Feb 14, 2015

@crabmusket crabmusket merged commit 486a12c into GarageGames:development Feb 14, 2015

1 check passed

default Merged build finished.
Details

@crabmusket crabmusket added this to the 3.7 milestone Feb 14, 2015

@crabmusket

This comment has been minimized.

Show comment
Hide comment
@crabmusket

crabmusket Feb 14, 2015

Contributor

Weird that this passed CI. It appears to break my local compile thanks to scrollVisible now returning bool. Will fix it.

Contributor

crabmusket commented Feb 14, 2015

Weird that this passed CI. It appears to break my local compile thanks to scrollVisible now returning bool. Will fix it.

crabmusket added a commit to crabmusket/Torque3D that referenced this pull request Feb 21, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment