+ Added some documentation to all public classes #42
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I'm sorry for all this docs |
space928
requested changes
May 10, 2022
OmsiHook/OmsiSplineSegment.cs
Outdated
| @@ -1,5 +1,8 @@ | |||
| namespace OmsiHook | |||
| { | |||
| /// <summary> | |||
| /// Segment of spline in a tile - splines are a type of mesh that has geometry, in comparisent to <seealso cref="OmsiPathSegment"/> which defines a track that a vehicle or human can follow, a spline or object can have several paths. | |||
OmsiHook/OmsiChronoChange.cs
Outdated
| @@ -6,6 +6,9 @@ | |||
|
|
|||
| namespace OmsiHook | |||
| { | |||
| /// <summary> | |||
| /// Base class for Chrono Changes, chrono changes / events, these are planned events that a map maker can add to make a map feel more dynamic over time. | |||
OmsiHook/OmsiChronoChangeLabels.cs
Outdated
| @@ -6,6 +6,9 @@ | |||
|
|
|||
| namespace OmsiHook | |||
| { | |||
| /// <summary> | |||
| /// List of stringvars relating to a chronochange | |||
There was a problem hiding this comment.
And fix capitalisation of ChronoChange
OmsiHook/OmsiComplMapObj.cs
Outdated
| @@ -1,5 +1,8 @@ | |||
| namespace OmsiHook | |||
| { | |||
| /// <summary> | |||
| /// Base class for complex map objects - used in vehicles and humans | |||
OmsiHook/OmsiGlobals.cs
Outdated
| @@ -65,6 +71,9 @@ public class OmsiGlobals : OmsiObject | |||
| /// Current real weather config | |||
| /// </summary> | |||
| public OmsiActuWeather ActuWeather => new(Memory, Memory.ReadMemory<int>(0x00861278)); | |||
| /// <summary> | |||
| /// List of Humans present on the scene | |||
There was a problem hiding this comment.
List of Humans present in the scene
OmsiHook/OmsiHumanBeingInst.cs
Outdated
| @@ -6,6 +6,9 @@ | |||
|
|
|||
| namespace OmsiHook | |||
| { | |||
| /// <summary> | |||
| /// Instance of a <seealso cref="OmsiHumanBeing">Human Being</seealso>, instance version store the data that is current (runtime data), wheras the regular <seealso cref="OmsiHumanBeing"/> stores the data that has been pulled from disk | |||
There was a problem hiding this comment.
Also, grammar and run-on sentence.
OmsiHook/OmsiPathSegment.cs
Outdated
| @@ -6,6 +6,9 @@ | |||
|
|
|||
| namespace OmsiHook | |||
| { | |||
| /// <summary> | |||
| /// Segment between path points | |||
There was a problem hiding this comment.
Add the cref and explanation from OmsiSplineSegment
OmsiHook/OmsiPhysObjInst.cs
Outdated
| @@ -1,5 +1,8 @@ | |||
| namespace OmsiHook | |||
| { | |||
| /// <summary> | |||
| /// Instance of <seealso cref="OmsiPhysObj"/>, all the runtime realtime data | |||
|
Also there were a few structs have translations added as comments after the field, which should be turned into proper documentation comments: public int TagErledigt; // day done? (Day of week maybe? - OmsiTTTourValid?)
## Becomes:
/// <summary>
/// Day done (Day of week maybe? - OmsiTTTourValid?).
/// <summary/>
public int TagErledigt;Also for ///<summary>
/// Busstop, estimated arrival and departure, actual arrival and departure, arrived on time, departed on time
///</summary>
public struct OmsiTTLogDetailedOh yeah, and there are still a few cases of tabs being used instead of spaces in |
space928
approved these changes
May 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.