JavadocTodo.java revision 3233:b5d08bc0d224
152419Sjulian/* 252419Sjulian * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved. 352419Sjulian * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 452419Sjulian * 552419Sjulian * This code is free software; you can redistribute it and/or modify it 652419Sjulian * under the terms of the GNU General Public License version 2 only, as 752419Sjulian * published by the Free Software Foundation. Oracle designates this 852419Sjulian * particular file as subject to the "Classpath" exception as provided 952419Sjulian * by Oracle in the LICENSE file that accompanied this code. 1052419Sjulian * 1152419Sjulian * This code is distributed in the hope that it will be useful, but WITHOUT 1252419Sjulian * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1352419Sjulian * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1452419Sjulian * version 2 for more details (a copy is included in the LICENSE file that 1552419Sjulian * accompanied this code). 1652419Sjulian * 1752419Sjulian * You should have received a copy of the GNU General Public License version 1852419Sjulian * 2 along with this work; if not, write to the Free Software Foundation, 1952419Sjulian * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2052419Sjulian * 2152419Sjulian * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2252419Sjulian * or visit www.oracle.com if you need additional information or have any 2352419Sjulian * questions. 2452419Sjulian */ 2552419Sjulian 2652419Sjulianpackage jdk.javadoc.internal.tool; 2752419Sjulian 2852419Sjulianimport com.sun.tools.javac.comp.*; 2952419Sjulianimport com.sun.tools.javac.util.*; 3052419Sjulian 3152419Sjulian/** 3252419Sjulian * Javadoc's own todo queue doesn't queue its inputs, as javadoc 3352419Sjulian * doesn't perform attribution of method bodies or semantic checking. 3452419Sjulian * 3552419Sjulian * <p><b>This is NOT part of any supported API. 3652419Sjulian * If you write code that depends on this, you do so at your own risk. 3752419Sjulian * This code and its internal interfaces are subject to change or 3852419Sjulian * deletion without notice.</b> 39119020Scharnier * 40119020Scharnier * @author Neal Gafter 41119020Scharnier */ 4252419Sjulianpublic class JavadocTodo extends Todo { 4352419Sjulian public static void preRegister(Context context) { 4452419Sjulian context.put(todoKey, new Context.Factory<Todo>() { 4552419Sjulian public Todo make(Context c) { 4652419Sjulian return new JavadocTodo(c); 4752419Sjulian } 4852419Sjulian }); 4952419Sjulian } 50121464Sharti 5152419Sjulian protected JavadocTodo(Context context) { 5252419Sjulian super(context); 5352419Sjulian } 5452419Sjulian 5552419Sjulian @Override 5652450Sdillon public void append(Env<AttrContext> e) { 5752419Sjulian // do nothing; Javadoc doesn't perform attribution. 5852419Sjulian } 5952419Sjulian 6052419Sjulian @Override 6152419Sjulian public boolean offer(Env<AttrContext> e) { 6252419Sjulian return false; 6352419Sjulian } 6452419Sjulian} 65121464Sharti