WinException.ToDo: better documentation

ForNeVeR · Nov 23, 2023 · 5db8e6e · 5db8e6e
1 parent 79e2967
commit 5db8e6e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/Cesium.Core/Cesium.Core.csproj b/Cesium.Core/Cesium.Core.csproj
@@ -6,4 +6,8 @@
         <Nullable>enable</Nullable>
     </PropertyGroup>
 
+    <ItemGroup>
+      <PackageReference Include="JetBrains.Annotations" Version="2023.3.0" />
+    </ItemGroup>
+
 </Project>
diff --git a/Cesium.Core/Exceptions/WipException.cs b/Cesium.Core/Exceptions/WipException.cs
@@ -1,8 +1,15 @@
+using JetBrains.Annotations;
+
 namespace Cesium.Core;
 
 public sealed class WipException : CesiumException
 {
     /// <summary>A marker value for an issue number not yet assigned.</summary>
+    /// <remarks>
+    /// Should only be used in PRs while developing new features. Before merging to the main branch, all instances of
+    /// this constant should be replaced with newly assigned issue numbers.
+    /// </remarks>
+    [PublicAPI]
     public const int ToDo = -1;
 
     public WipException(int issueNo, string additionalMessage)