gw.gosudoc.com.sun.tools.javadoc.main.JavadocTodo Maven / Gradle / Ivy

Go to download

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

Generates Javadoc-compatible documentation for Gosu projects

There is a newer version: 1.18.2

/*
 * This file is a shadowed version of the older javadoc codebase on which gosudoc is based; borrowed from jdk 9.
 */

package gw.gosudoc.com.sun.tools.javadoc.main;

import com.sun.tools.javac.comp.*;
import com.sun.tools.javac.util.*;
import com.sun.tools.javac.util.Context.Factory;

/**
 *  Javadoc's own todo queue doesn't queue its inputs, as javadoc
 *  doesn't perform attribution of method bodies or semantic checking.
 *
 *  This is NOT part of any supported API.
 *  If you write code that depends on this, you do so at your own risk.
 *  This code and its internal interfaces are subject to change or
 *  deletion without notice.
 *
 *  @author Neal Gafter
 */
@Deprecated
public class JavadocTodo extends Todo {
    public static void preRegister(Context context) {
        context.put(todoKey, (Factory)JavadocTodo::new);
    }

    protected JavadocTodo(Context context) {
        super(context);
    }

    @Override
    public void append(Env e) {
        // do nothing; Javadoc doesn't perform attribution.
    }

    @Override
    public boolean offer(Env e) {
        return false;
    }
}