de.smartics.properties.tutorial.property.metadata
Class PropertyMetaDataTutorial

Package class diagram package PropertyMetaDataTutorial
java.lang.Object
  extended by 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.


Constructor Summary
PropertyMetaDataTutorial()
           
 
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
 

Constructor Detail

PropertyMetaDataTutorial

public PropertyMetaDataTutorial()
Method Detail

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.
  1. Title of the document: defaults to the fully qualified name of the property
  2. The space within which the title is unique: defaults to the type that declares the property
  3. 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.