de.mvbonline.tools.restapidoc.doclet.model.ApiDescription 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 java.util.Collection;
import java.util.LinkedList;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

/**
 * Model for storing javadoc comments.
 *
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
public class ApiDescription implements Serializable {

    @XmlElement()
    private List classes;

    public void addClass(ClassDescription clazz) {
        if (this.classes == null) {
            this.classes = new LinkedList();
        }
        this.classes.add(clazz);
    }

    public void addClasses(Collection clazz) {
        if (this.classes == null) {
            this.classes = new LinkedList();
        }
        this.classes.addAll(clazz);
    }

    public List getClasses() {
        return classes;
    }

    public void setClasses(List classes) {
        this.classes = classes;
    }
}