001/*
002 * JDrupes PlantUML Taglet
003 * Copyright (C) 2017  Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018package org.jdrupes.taglets.plantUml;
019
020import com.sun.javadoc.Doc;
021import com.sun.javadoc.Tag;
022import com.sun.tools.doclets.formats.html.markup.RawHtml;
023import com.sun.tools.doclets.internal.toolkit.Content;
024import com.sun.tools.doclets.internal.toolkit.taglets.Taglet;
025import com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter;
026
027/**
028 * A dummy taglet that provides no output.
029 * 
030 */
031public class EndUml implements Taglet {
032
033        /* (non-Javadoc)
034         * @see com.sun.tools.doclets.Taglet#getName()
035         */
036        @Override
037        public String getName() {
038                return "enduml";
039        }
040
041        /* (non-Javadoc)
042         * @see com.sun.tools.doclets.Taglet#inConstructor()
043         */
044        @Override
045        public boolean inConstructor() {
046                return false;
047        }
048
049        /* (non-Javadoc)
050         * @see com.sun.tools.doclets.Taglet#inField()
051         */
052        @Override
053        public boolean inField() {
054                return false;
055        }
056
057        /* (non-Javadoc)
058         * @see com.sun.tools.doclets.Taglet#inMethod()
059         */
060        @Override
061        public boolean inMethod() {
062                return false;
063        }
064
065        /* (non-Javadoc)
066         * @see com.sun.tools.doclets.Taglet#inOverview()
067         */
068        @Override
069        public boolean inOverview() {
070                return true;
071        }
072
073        /* (non-Javadoc)
074         * @see com.sun.tools.doclets.Taglet#inPackage()
075         */
076        @Override
077        public boolean inPackage() {
078                return true;
079        }
080
081        /* (non-Javadoc)
082         * @see com.sun.tools.doclets.Taglet#inType()
083         */
084        @Override
085        public boolean inType() {
086                return true;
087        }
088
089        /* (non-Javadoc)
090         * @see com.sun.tools.doclets.Taglet#isInlineTag()
091         */
092        @Override
093        public boolean isInlineTag() {
094                return false;
095        }
096
097        @Override
098        public Content getTagletOutput(Tag tag, TagletWriter writer) throws IllegalArgumentException {
099                return new RawHtml("");
100        }
101
102        @Override
103        public Content getTagletOutput(Doc holder, TagletWriter writer) throws IllegalArgumentException {
104                return new RawHtml("");
105        }
106
107}