org.kohsuke.github.MarkdownMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of github-api Show documentation

GitHub API for Java

There is a newer version: 2.0.0-alpha-2

package org.kohsuke.github;

import java.util.Locale;

// TODO: Auto-generated Javadoc
/**
 * Rendering mode of markdown.
 *
 * @author Kohsuke Kawaguchi
 * @see GitHub#renderMarkdown(String) GitHub#renderMarkdown(String)
 * @see GHRepository#renderMarkdown(String, MarkdownMode) GHRepository#renderMarkdown(String, MarkdownMode)
 */
public enum MarkdownMode {
    /**
     * Render a document as plain Markdown, just like README files are rendered.
     */
    MARKDOWN,
    /**
     * Render a document as user-content, e.g. like user comments or issues are rendered. In GFM mode, hard line breaks
     * are always taken into account, and issue and user mentions are linked accordingly.
     *
     * @see GHRepository#renderMarkdown(String, MarkdownMode)
     */
    GFM;

    /**
     * To string.
     *
     * @return the string
     */
    public String toString() {
        return name().toLowerCase(Locale.ENGLISH);
    }
}