Initial code drop of yang model driven configuration system
[controller.git] / opendaylight / config / config-api / src / main / java / org / opendaylight / controller / config / api / annotations / Description.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.config.api.annotations;
9
10 import java.lang.annotation.ElementType;
11 import java.lang.annotation.Retention;
12 import java.lang.annotation.RetentionPolicy;
13 import java.lang.annotation.Target;
14
15 /**
16  * Exports attribute and module class descriptions. Description annotation can
17  * be applied to module directly or to its super class or MXBean interface.
18  */
19 @Target({ ElementType.TYPE, ElementType.METHOD })
20 @Retention(RetentionPolicy.RUNTIME)
21 public @interface Description {
22     /**
23      * Returns a human-readable description of the annotated attribute.
24      * Descriptions should be clear and concise, describing what the attribute
25      * affects.
26      *
27      * @return attribute description
28      */
29     String value();
30 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.