celisej567/LibBSP
1
0
Fork 0
mirror of https://github.com/celisej567/LibBSP.git synced 2026-09-17 20:08:55 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Moderate refactor.

Browse Source 
Removes "Source" from in front of source engine structures.
Spells out full names of structures in class names.
Adds punctuation to all documentation comments and fixes some mistakes.
Adds some missing documentation comments.
This commit is contained in:
Will
2016-01-26 22:37:52 -07:00
parent ed5abdcc92
commit 9bf45765a5
43 changed files with 1167 additions and 1038 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
LibBSP/Source/Structs/BSP/Edge.cs
View File

@@ -11,12 +11,12 @@ namespace LibBSP {
public int secondVertex { get; private set; }
/// <summary>
/// Creates a new <c>Edge</c> object from a <c>byte</c> array.
/// Creates a new <see cref="Edge"/> object from a <c>byte</c> array.
/// </summary>
/// <param name="data"><c>byte</c> array to parse</param>
/// <param name="type">The map type</param>
/// <exception cref="ArgumentNullException"><paramref name="data" /> was null</exception>
/// <exception cref="ArgumentException">This structure is not implemented for the given maptype</exception>
/// <param name="data"><c>byte</c> array to parse.</param>
/// <param name="type">The map type.</param>
/// <exception cref="ArgumentNullException"><paramref name="data"/> was <c>null</c>.</exception>
/// <exception cref="ArgumentException">This structure is not implemented for the given maptype.</exception>
public Edge(byte[] data, MapType type) : this() {
if (data == null) {
throw new ArgumentNullException();
@@ -53,13 +53,13 @@ namespace LibBSP {
}
/// <summary>
/// Factory method to parse a <c>byte</c> array into a <c>List</c> of <c>Edge</c> objects.
/// Factory method to parse a <c>byte</c> array into a <c>List</c> of <see cref="Edge"/> objects.
/// </summary>
/// <param name="data">The data to parse</param>
/// <param name="type">The map type</param>
/// <returns>A <c>List</c> of <c>Edge</c> objects</returns>
/// <exception cref="ArgumentNullException"><paramref name="data" /> was null</exception>
/// <exception cref="ArgumentException">This structure is not implemented for the given maptype</exception>
/// <param name="data">The data to parse.</param>
/// <param name="type">The map type.</param>
/// <returns>A <c>List</c> of <see cref="Edge"/> objects.</returns>
/// <exception cref="ArgumentNullException"><paramref name="data"/> was null.</exception>
/// <exception cref="ArgumentException">This structure is not implemented for the given maptype.</exception>
public static List<Edge> LumpFactory(byte[] data, MapType type) {
if (data == null) {
throw new ArgumentNullException();
@@ -104,8 +104,8 @@ namespace LibBSP {
/// <summary>
/// Gets the index for this lump in the BSP file for a specific map format.
/// </summary>
/// <param name="type">The map type</param>
/// <returns>Index for this lump, or -1 if the format doesn't have this lump</returns>
/// <param name="type">The map type.</param>
/// <returns>Index for this lump, or -1 if the format doesn't have this lump.</returns>
public static int GetIndexForLump(MapType type) {
switch (type) {
case MapType.Quake2: