Package com.github.alex1304.ultimategdbot.api.command

Class CommandDocumentation

java.lang.Object
com.github.alex1304.ultimategdbot.api.command.CommandDocumentation
public class CommandDocumentation
extends java.lang.Object
Holds the documentation for a specific command.

  • Constructor Summary

    Constructors 
    Constructor Description
    CommandDocumentation​(java.lang.String shortDescription, java.util.Map<java.lang.String,​CommandDocumentationEntry> docEntries, boolean isHidden)  

  • Method Summary

    Modifier and Type Method Description
    java.util.Map<java.lang.String,​CommandDocumentationEntry> getEntries()
    Gets all entries corresponding to subsections of the command documentation.
    java.lang.String getShortDescription()
    Gets the short description of the command.
    boolean isHidden()
    Gets whether the command should be hidden from the documentation front page.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getShortDescription

      public java.lang.String getShortDescription()
      Gets the short description of the command.
      Returns:
      the short description

    • getEntries

      public java.util.Map<java.lang.String,​CommandDocumentationEntry> getEntries()
      Gets all entries corresponding to subsections of the command documentation.
      Returns:
      the documentation entries

    • isHidden

      public boolean isHidden()
      Gets whether the command should be hidden from the documentation front page.
      Returns:
      true if hidden, false otherwise