1 /* 2 * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package de.smartics.properties.tutorial.dclxml; 17 18 import de.smartics.projectdoc.annotations.DocCategory; 19 import de.smartics.projectdoc.annotations.Document; 20 import de.smartics.projectdoc.annotations.topic.DocChapter; 21 22 /** 23 * This tutorial provides information about the 24 * <code>META-INF/declaration.xml</code> file that describes the property 25 * declarations. 26 */ 27 @Document(title = "Declaration-XML Tutorial!", sortKey = "details0010") 28 @DocCategory({ "details" }) 29 // @DocTopic(path="details", step="20") 30 public class DeclarationXmlTutorial 31 { 32 /** 33 * <p> 34 * The <code>declaration.xml</code> provides meta data about the property sets 35 * found in an archive. It is located inside 36 * <code>/META-INF/smartics-properties</code>. Although this file is not 37 * strictly required, it provides additional information that helps to 38 * strengthen the user experience. For instance it contains the URL to the 39 * home page of the library that declares the properties. On any problem 40 * with these properties, the system can construct an URL to a page that 41 * provides additional information. 42 * </p> 43 * <p> 44 * The declaration file is generated by the use of the 45 * <a href="http://www.smartics.eu/smartics-properties-maven-plugin/">smartics-properties-maven-plugin</a>. 46 * For further information please consult the plugin's home page. Please note 47 * that the documentation information derived from the Javadoc comments is 48 * only available at runtime, if the documentation XML files are generated by 49 * this Maven plugin. 50 * </p> 51 */ 52 @DocChapter(title="Use of the Declaration-XML") 53 void useOfTheDeclarationXml() 54 { 55 } 56 57 /** 58 * <p> 59 * The structure of the <code>declaration.xml</code> is defined by the 60 * Properties Declaration XSD 61 * (<code>http://smartics.de/properties/declaration/1</code>). 62 * </p> 63 */ 64 @DocChapter(title="Structure of the Declaration-XML") 65 void structureOfTheDeclarationXml() 66 { 67 } 68 }