Skip to content

Keep documentations up to date #7

@onihilist

Description

@onihilist

Just keep the "documentation" up to date with summary like this :

    /// <summary>
    /// Enum representing the available default themes.
    /// </summary>
    public enum DefaultThemesEnum{...}

    /// <summary>
    /// Tries to get a default theme from a name.
    /// </summary>
    /// <param name="name">The theme name (case-insensitive).</param>
    /// <param name="theme">The resulting theme if found.</param>
    /// <returns>True if the theme was found, false otherwise.</returns>
    public static bool TryGetTheme(string name, out DefaultThemesEnum theme){...}
   

List of all folders, sub-folder, files to update :

✅ = Documentation up to date
❌ = Not Updated

  • ✅ -> Animation/GlitchOutput.cs
  • ✅ -> Shell/Commands/CommandLoader.cs
  • ✅ -> Shell/Commands/CommandParser.cs
  • ✅ -> Shell/Commands/CommandRegistry.cs
  • ✅ -> Shell/Commands/ICustomCommand.cs
  • ✅ -> Shell/Commands/IMetadataCommand.cs
  • ✅ -> Shell/History/HistoryManager.cs
  • ❌ -> Shell/Keyboard/KeyboardHandler.cs
  • ✅ -> Shell/Plugin/PluginLoader.cs
  • ❌ -> Shell/ShellContext.cs
  • ✅ -> Themes/ThemesEnum.cs
  • ❌ -> Themes/ThemesEnum.cs

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions