io.virtdata.processors.DocCtorData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-realer Show documentation

With inspiration from other libraries

There is a newer version: 2.12.15

package io.virtdata.processors;

import java.util.List;
import java.util.Map;

public interface DocCtorData {

    /**
     * @return the {@link Class#getSimpleName()} of the documented ctor.
     */
    String getClassName();

    /**
     * @return javadoc for the documented ctor, or null if it isn't provided
     */
    String getCtorJavaDoc();

    /**
     * @return an ordered map of the arguments of the documented constructor in name,type form.
     */
    Map getArgs();

    /**
     * @return a list of examples, where each is list of (example syntax, comment..)
     */
    List> getExamples();
}