1 /*
   2  * Copyright (c) 2003, 2012, 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;
  27 
  28 import com.sun.tools.javac.comp.*;
  29 import com.sun.tools.javac.util.*;
  30 
  31 /**
  32  *  Javadoc's own todo queue doesn't queue its inputs, as javadoc
  33  *  doesn't perform attribution of method bodies or semantic checking.
  34  *
  35  *  <p><b>This is NOT part of any supported API.
  36  *  If you write code that depends on this, you do so at your own risk.
  37  *  This code and its internal interfaces are subject to change or
  38  *  deletion without notice.</b>
  39  *
  40  *  @author Neal Gafter
  41  */
  42 public class JavadocTodo extends Todo {
  43     public static void preRegister(Context context) {
  44         context.put(todoKey, new Context.Factory<Todo>() {
  45                public Todo make(Context c) {
  46                    return new JavadocTodo(c);
  47                }
  48         });
  49     }
  50 
  51     protected JavadocTodo(Context context) {
  52         super(context);
  53     }
  54 
  55     @Override
  56     public void append(Env<AttrContext> e) {
  57         // do nothing; Javadoc doesn't perform attribution.
  58     }
  59 
  60     @Override
  61     public boolean offer(Env<AttrContext> e) {
  62         return false;
  63     }
  64 }