Add some doc-comments

bdunderscore · Sep 10, 2023 · ec31c94 · ec31c94
1 parent 0c258eb
commit ec31c94
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/Editor/Samples/SetViewpointPlugin.cs b/Editor/Samples/SetViewpointPlugin.cs
@@ -10,7 +10,17 @@ namespace nadena.dev.ndmf.sample
 {
     public class SetViewpointPlugin : Plugin<SetViewpointPlugin>
     {
+        /// <summary>
+        /// This name is used to identify the plugin internally, and can be used to declare BeforePlugin/AfterPlugin
+        /// dependencies. If not set, the full type name will be used.
+        /// </summary>
         public override string QualifiedName => "nadena.dev.av3-build-framework.sample.set-viewpoint";
+
+        /// <summary>
+        /// The plugin name shown in debug UIs. If not set, the qualified name will be shown.
+        /// </summary>
+        public override string DisplayName => "Set viewpoint using object";
+
         protected override void Configure()
         {
             InPhase(BuildPhase.Transforming).Run("Set viewpoint", ctx =>