de.mvbonline.tools.restapidoc.doclet.model.ElementDescription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of restapi-doc Show documentation

Creates documentation for a spring mvc RESTful api. Output is reStructuredText for sphinx using sphinxcontrib.httpdomain

The newest version!

package de.mvbonline.tools.restapidoc.doclet.model;

import java.io.Serializable;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

/**
 * Base Model for javadoc comments.
 *
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType
public class ElementDescription implements Serializable {

    @XmlAttribute
    private String name;

    @XmlElement
    private String description;

    public ElementDescription() {
        super();
    }

    public ElementDescription(String name, String description) {
        super();
        this.name = name;
        this.description = description;
    }

    public String getDescription() {
        return description;
    }

    public String getName() {
        return name;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public void setName(String name) {
        this.name = name;
    }
}