de.mvbonline.tools.restapidoc.doclet.model.MethodDescription 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.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.XmlType;

/**
 * Model for javadoc comments on a method.
 *
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType
public class MethodDescription extends ElementDescription implements Serializable {

    private ElementDescription returnValue;

    @XmlElement
    private List parameters;

    public void addParameter(ElementDescription doc) {
        if (this.parameters == null) {
            this.parameters = new LinkedList();
        }
        this.parameters.add(doc);
    }

    public List getParameters() {
        return parameters;
    }

    public ElementDescription getReturnValue() {
        return returnValue;
    }

    public void setParameters(List parameters) {
        this.parameters = parameters;
    }

    public void setReturnValue(ElementDescription returnValue) {
        this.returnValue = returnValue;
    }
}