binding/mdsal-binding-java-api-generator/src/test/resources/compilation/encoding-javadoc/encoding-javadoc.yang

   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 module encoding-javadoc {
   9     yang-version 1;
  10     namespace "urn:opendaylight:encoding-javadoc";
  11     prefix "enc";
  12
  13     description "testing module description <should_be_encoded>";
  14
  15     revision "2014-04-09" {
  16     }
  17
  18     extension test-extension {
  19         description "testing extension description <should_be_encoded>";
  20         argument "name";
  21     }
  22
  23     identity test-identity {
  24         description "testing identity description <should_be_ encoded>";
  25     }
  26
  27     typedef port-number {
  28          type uint16 {
  29             range "0..65535";
  30          }
  31
  32          description "testing typedef description <should_be_encoded>";
  33      }
  34
  35     rpc rock-the-house {
  36         input {
  37             leaf zip-code {
  38                 type string;
  39             }
  40         }
  41
  42         description "testing rpc description <should_be_encoded>";
  43     }
  44
  45     notification event {
  46         leaf event-class {
  47             type string;
  48         }
  49
  50         anyxml reporting-entity;
  51
  52         leaf severity {
  53             type string;
  54         }
  55
  56         description "testing notification description <should_be_encoded>";
  57     }
  58
  59     augment "/enc:cont1" {
  60         leaf augment-leaf {
  61             type string;
  62         }
  63
  64         description "testing augment description <should_be_encoded>";
  65     }
  66
  67     container cont1 {
  68         description "/e.g. 1/*/* testing container description <should_be_encoded>";
  69         reference "RFC 6020 - http://tools.ietf.org/html/rfc6020";
  70
  71         list list1 {
  72             description "/e.g. 1/*/* testing list description <should_be_encoded>";
  73             reference "RFC 6020 - http://tools.ietf.org/html/rfc6020";
  74
  75             key "topology-id";
  76             leaf topology-id {
  77                 description "/e.g. 1/*/* testing leaf description <should_be_encoded>";
  78                 reference "RFC 6020 - http://tools.ietf.org/html/rfc6020";
  79                 type int32;
  80             }
  81
  82             uses link1;
  83         }
  84     }
  85
  86     grouping link1 {
  87         list link1 {
  88             description "/e.g. 1/*/* testing list description <should_be_encoded>";
  89             reference "RFC 6020 - http://tools.ietf.org/html/rfc6020";
  90             key "link-id";
  91             uses link-attributes;
  92         }
  93
  94         description "testing grouping description <should_be_encoded>";
  95     }
  96
  97     grouping link-attributes {
  98         leaf link-id {
  99             description "/e.g. 1/*/* testing leaf description <should_be_encoded>";
 100             reference "RFC 6020 - http://tools.ietf.org/html/rfc6020";
 101             type int8;
 102         }
 103     }
 104
 105     leaf inclusion-rulez {
 106         description "/e.g. 1/*/* testing leaf description <should be encoded>";
 107         reference "RFC 6020 http://technet.com";
 108
 109         type string;
 110     }
 111
 112     leaf inclusion-rule {
 113         description "/e.g. 1/*/*";
 114         default include;
 115
 116         type enumeration {
 117             enum include {
 118                 description
 119                     "/e.g. 1/*/* testing enum description <should be encoded>";
 120             }
 121             enum exclude {
 122                 description
 123                     "/e.g. 1/*/*";
 124             }
 125         }
 126     }
 127
 128     leaf-list test-leaf-list {
 129         type string;
 130         description "testing leaf-list description <should be encoded>";
 131     }
 132
 133     choice test-choice {
 134         description "testing choice description <should be encoded>";
 135
 136         case test-case-1 {
 137             description "testing case description <should be encoded>";
 138
 139             leaf case-1-leaf {
 140                 type string;
 141                 description "testing leaf in case description <should be encoded>";
 142             }
 143         }
 144
 145         case test-case-2 {
 146             description "testing case description <should be encoded>";
 147
 148             leaf case-2-leaf {
 149                 type string;
 150                 description "testing leaf in case description <should be encoded>";
 151             }
 152         }
 153     }
 154 }