Add docs

planetarium · Apr 5, 2024 · 6d7a869 · 6d7a869
1 parent dc7aeeb
commit 6d7a869
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Lib9c/Model/State/AllRuneState.cs b/Lib9c/Model/State/AllRuneState.cs
@@ -5,6 +5,11 @@
 
 namespace Nekoyume.Model.State
 {
+    /// <summary>
+    /// This is new version of rune state. This state stores all rune states of an avatar.
+    /// AllRuneState has all RuneStates as dictionary and has methods to get/set/update each RuneState.
+    /// Use this with <see cref="Nekoyume.Module.RuneStateModule"/>.
+    /// </summary>
     public class AllRuneState : IState
     {
         private Dictionary<int, RuneState> Runes { get; }

diff --git a/Lib9c/Module/RuneStateModule.cs b/Lib9c/Module/RuneStateModule.cs
@@ -7,6 +7,9 @@
 
 namespace Nekoyume.Module
 {
+    /// <summary>
+    /// RuneStateModule is the module to use RuneState/AllRuneState with account.
+    /// </summary>
     public static class RuneStateModule
     {
         public static AllRuneState GetRuneState(this IWorldState worldState,