de.smartics.properties.tutorial.property.metadata
Class PropertyMetaDataTutorial
java.lang.Object
de.smartics.properties.tutorial.property.metadata.PropertyMetaDataTutorial
-
@Document(title="Property Metadata",
sortKey="basics0040")
@DocCategory(value="basics")
public class PropertyMetaDataTutorial
-
extends
Object
This tutorial introduces to the document meta data that allows to integrate the documentation of properties into a project documentation.
Method Summary |
void |
defaultMetaData() If no further metadata is attached to a properties set, the following metadata is created per default. |
void |
documentationMetaData() PENDING: Show how to add documentation metadata. |
void |
setUp() |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PropertyMetaDataTutorial
public PropertyMetaDataTutorial()
setUp
public void setUp()
-
defaultMetaData
@DocChapter
public void defaultMetaData()
-
If no further metadata is attached to a properties set, the following metadata is created per default.
- Title of the document: defaults to the fully qualified name of the property
- The space within which the title is unique: defaults to the type that declares the property
- The unique name of the document: defaults to the fully qualified name of the property, too
-
documentationMetaData
@DocChapter
public void documentationMetaData()
-
PENDING: Show how to add documentation metadata.
-
Copyright © 2012-2013
Kronseder & Reiner GmbH - smartics. All Rights Reserved.