search

space928 / Omsi-Extensions

Omsi hooking and modding sdk
GNU Lesser General Public License v3.0
16 stars 3 forks source link

+ Added some documentation to all public classes #42

Closed amathieson closed 2 years ago

amathieson commented 2 years ago

no

I'm sorry for all this docs

space928 commented 2 years ago

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 OmsiTTLogDetailed you use a single documentation comment for all fields, but in the docs the fields are reordered alphabetically, making it useless:

///<summary>
/// Busstop, estimated arrival and departure, actual arrival and departure, arrived on time, departed on time
///</summary>
public struct OmsiTTLogDetailed

Oh yeah, and there are still a few cases of tabs being used instead of spaces in OmsiStructs