Skip to content

Commit dd1e835

Browse files
committed
UniversalMenu.Compat.CS2MenuManager: Added a note regarding the public API
1 parent ad17c26 commit dd1e835

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/UniversalMenu.Compat.CS2MenuManager/NotSupported.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
// This file represents the unsupported or unimplemented shared public API of CS2MenuManager.dll
2+
// that plugins link to.
3+
//
4+
// As you may be able to tell, the authors of CS2MenuManager did not separate the public API
5+
// consumers (plugins) use and the internal API used by the CS2MenuManager project itself,
6+
// causing the surface area to become quite large. Most of it does not need to be implemented,
7+
// only the parts that plugins directly use.
8+
//
9+
// Methods that throw a NotImplementedException have yet to be implemented or triaged.
10+
// Methods that throw NotSupportedException will never be implemented by this project and
11+
// are provided only for binary compatibility.
12+
113
using System;
214
using System.Collections.Generic;
315
using System.Drawing;

0 commit comments

Comments
 (0)