1 /*
2  * Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package com.sun.tools.javadoc.main;
27 
28 import com.sun.tools.javac.comp.*;
29 import com.sun.tools.javac.util.*;
30 import com.sun.tools.javac.util.Context.Factory;
31 
32 /**
33  *  Javadoc's own todo queue doesn't queue its inputs, as javadoc
34  *  doesn't perform attribution of method bodies or semantic checking.
35  *
36  *  <p><b>This is NOT part of any supported API.
37  *  If you write code that depends on this, you do so at your own risk.
38  *  This code and its internal interfaces are subject to change or
39  *  deletion without notice.</b>
40  *
41  *  @author Neal Gafter
42  */
43 @Deprecated(since="9", forRemoval=true)
44 @SuppressWarnings("removal")
45 public class JavadocTodo extends Todo {
preRegister(Context context)46     public static void preRegister(Context context) {
47         context.put(todoKey, (Factory<Todo>)JavadocTodo::new);
48     }
49 
JavadocTodo(Context context)50     protected JavadocTodo(Context context) {
51         super(context);
52     }
53 
54     @Override
append(Env<AttrContext> e)55     public void append(Env<AttrContext> e) {
56         // do nothing; Javadoc doesn't perform attribution.
57     }
58 
59     @Override
offer(Env<AttrContext> e)60     public boolean offer(Env<AttrContext> e) {
61         return false;
62     }
63 }
64