001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package net.tridentsdk.docs;
019
020import java.lang.annotation.Documented;
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Inherited;
023import java.lang.annotation.Target;
024
025/**
026 * This annotation is for the use of documentation. This means that the access-level is not broad enough so that extra
027 * documentation is needed. This should be annotated on classes that are less than {@code protected}, and not
028 * documented
029 *
030 * <p>This annotation is inherited because only the classes that are subtypes of the non-documented classes have
031 * to be within the same package (under protected) OR private (under protected), so they are also not documented.</p>
032 *
033 * <p>This annotation doesn't do anything</p>
034 *
035 * @author The TridentSDK Team
036 * @since 0.3-alpha-DP
037 */
038@Documented
039@Target(ElementType.TYPE)
040@Inherited
041public @interface AccessNoDoc {
042}